updates readme and example to add audio exception codes

flutter · May 16, 2022 · a4f07fc · a4f07fc
1 parent b6c2c53
commit a4f07fc
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 16 deletions.
diff --git a/packages/camera/camera/README.md b/packages/camera/camera/README.md
@@ -88,10 +88,16 @@ Here is a list of all permission error codes that can be thrown:
 
 - `CameraAccessDenied`: Thrown when user denies the camera access permission.
 
-- `CameraAccessDeniedWithoutPrompt`: iOS only for now. Thrown when user has previously denied the permission. iOS does not allow prompting alert dialog a second time. Users will have to go to Settings > Privacy in order to enable camera access.
+- `CameraAccessDeniedWithoutPrompt`: iOS only for now. Thrown when user has previously denied the permission. iOS does not allow prompting alert dialog a second time. Users will have to go to Settings > Privacy > Camera in order to enable camera access.
 
 - `CameraAccessRestricted`: iOS only for now. Thrown when camera access is restricted and users cannot grant permission (parental control).
 
+- `AudioAccessDenied`: Thrown when user denies the audio access permission.
+
+- `AudioAccessDeniedWithoutPrompt`: iOS only for now. Thrown when user has previously denied the permission. iOS does not allow prompting alert dialog a second time. Users will have to go to Settings > Privacy > Microphone in order to enable audio access.
+
+- `AudioAccessRestricted`: iOS only for now. Thrown when audio access is restricted and users cannot grant permission (parental control).
+
 - `cameraPermission`: Android and Web only. A legacy error code for all kinds of camera permission errors.
 
 ### Example

diff --git a/packages/camera/camera/example/ios/RunnerTests/CameraCaptureSessionQueueRaceConditionTests.m b/packages/camera/camera/example/ios/RunnerTests/CameraCaptureSessionQueueRaceConditionTests.m
@@ -29,12 +29,11 @@ - (void)testFixForCaptureSessionQueueNullPointerCrashDueToRaceCondition {
                     result:^(id _Nullable result) {
                       [disposeExpectation fulfill];
                     }];
-  [camera createCameraOnCaptureSessionQueueWithCreateMethodCall:createCall
-                                                         result:[[FLTThreadSafeFlutterResult alloc]
-                                                                    initWithResult:^(
-                                                                        id _Nullable result) {
-                                                                      [createExpectation fulfill];
-                                                                    }]];
+  [camera createCameraOnSessionQueueWithCreateMethodCall:createCall
+                                                  result:[[FLTThreadSafeFlutterResult alloc]
+                                                             initWithResult:^(id _Nullable result) {
+                                                               [createExpectation fulfill];
+                                                             }]];
   [self waitForExpectationsWithTimeout:1 handler:nil];
   // `captureSessionQueue` must not be nil after `create` call. Otherwise a nil
   // `captureSessionQueue` passed into `AVCaptureVideoDataOutput::setSampleBufferDelegate:queue:`

diff --git a/packages/camera/camera/example/ios/RunnerTests/CameraMethodChannelTests.m b/packages/camera/camera/example/ios/RunnerTests/CameraMethodChannelTests.m
@@ -36,7 +36,7 @@ - (void)testCreate_ShouldCallResultOnMainThread {
       methodCallWithMethodName:@"create"
                      arguments:@{@"resolutionPreset" : @"medium", @"enableAudio" : @(1)}];
 
-  [camera createCameraOnCaptureSessionQueueWithCreateMethodCall:call result:resultObject];
+  [camera createCameraOnSessionQueueWithCreateMethodCall:call result:resultObject];
   [self waitForExpectationsWithTimeout:1 handler:nil];
 
   // Verify the result

diff --git a/packages/camera/camera/example/lib/main.dart b/packages/camera/camera/example/lib/main.dart
@@ -697,6 +697,17 @@ class _CameraExampleHomeState extends State<CameraExampleHome>
           // iOS only
           showInSnackBar('Camera access is restricted.');
           break;
+        case 'AudioAccessDenied':
+          showInSnackBar('You have denied audio access.');
+          break;
+        case 'AudioAccessDeniedWithoutPrompt':
+          // iOS only
+          showInSnackBar('Please go to Settings app to enable audio access.');
+          break;
+        case 'AudioAccessRestricted':
+          // iOS only
+          showInSnackBar('Audio access is restricted.');
+          break;
         case 'cameraPermission':
           // Android & web only
           showInSnackBar('Unknown permission error.');

diff --git a/packages/camera/camera/ios/Classes/CameraPermissionUtils.h b/packages/camera/camera/ios/Classes/CameraPermissionUtils.h
@@ -13,7 +13,6 @@ typedef void (^FLTCameraPermissionRequestCompletionHandler)(FlutterError *);
 /// screen. Otherwise AVFoundation simply returns the user's previous choice, and in this case the
 /// user will have to update the choice in Settings app.
 ///
-///
 /// @param forAudio Requests for `AVMediaTypeAudio` permission if `forAudio` is true, and
 /// `AVMediaTypeVideo` permission otherwise.
 /// @param handler if access permission is (or was previously) granted, completion handler will be

diff --git a/packages/camera/camera/ios/Classes/CameraPlugin.m b/packages/camera/camera/ios/Classes/CameraPlugin.m
@@ -137,7 +137,7 @@ - (void)handleMethodCallAsync:(FlutterMethodCall *)call
       if (error) {
         [result sendFlutterError:error];
       } else {
-        [self createCameraOnCaptureSessionQueueWithCreateMethodCall:call result:result];
+        [self createCameraOnSessionQueueWithCreateMethodCall:call result:result];
       }
     });
   } else if ([@"startImageStream" isEqualToString:call.method]) {
@@ -194,11 +194,13 @@ - (void)handleMethodCallAsync:(FlutterMethodCall *)call
       [_camera close];
       [result sendSuccess];
     } else if ([@"prepareForVideoRecording" isEqualToString:call.method]) {
+      // Setup audio capture session only if granted audio access.
       FLTRequestCameraPermission(/*forAudio*/ true, ^(FlutterError *error) {
-        // Setup audio capture session only if granted audio access
         if (error) {
           [result sendFlutterError:error];
         } else {
+          // Permission completion handler may be called on arbitrary queue.
+          // Dispatch to `captureSessionQueue` to setup audio capture session.
           dispatch_async(self.captureSessionQueue, ^{
             [self.camera setUpCaptureSessionForAudio];
             [result sendSuccess];
@@ -267,8 +269,8 @@ - (void)handleMethodCallAsync:(FlutterMethodCall *)call
   }
 }
 
-- (void)createCameraOnCaptureSessionQueueWithCreateMethodCall:(FlutterMethodCall *)createMethodCall
-                                                       result:(FLTThreadSafeFlutterResult *)result {
+- (void)createCameraOnSessionQueueWithCreateMethodCall:(FlutterMethodCall *)createMethodCall
+                                                result:(FLTThreadSafeFlutterResult *)result {
   dispatch_async(self.captureSessionQueue, ^{
     NSString *cameraName = createMethodCall.arguments[@"cameraName"];
     NSString *resolutionPreset = createMethodCall.arguments[@"resolutionPreset"];

diff --git a/packages/camera/camera/ios/Classes/CameraPlugin_Test.h b/packages/camera/camera/ios/Classes/CameraPlugin_Test.h
@@ -38,10 +38,10 @@
 /// that triggered the orientation change.
 - (void)orientationChanged:(NSNotification *)notification;
 
-/// Creates FLTCam on capture session queue and reports the creation result.
+/// Creates FLTCam on session queue and reports the creation result.
 /// @param createMethodCall the create method call
 /// @param result a thread safe flutter result wrapper object to report creation result.
-- (void)createCameraOnCaptureSessionQueueWithCreateMethodCall:(FlutterMethodCall *)createMethodCall
-                                                       result:(FLTThreadSafeFlutterResult *)result;
+- (void)createCameraOnSessionQueueWithCreateMethodCall:(FlutterMethodCall *)createMethodCall
+                                                result:(FLTThreadSafeFlutterResult *)result;
 
 @end