Rename cancel to stop in audio preview (#413)

Also rename the RecorderStatus to AudioCaptureOptions.

Branch commits:
* Changes for 3.10.1 and changed return type.
* Update Podfile.lock
* Update ios moks version
* Simplify pod repo update command
* Fix a rename issue in tests

---------

Co-authored-by: Gabriel Radu <gabriel.radu@dolby.com>

Author: mpozy

.github/workflows/ci.yml

@@ -111,6 +111,8 @@ jobs:
     - name: Fetch dependencies
       run: |
         flutter pub get
+    - name: Update Cocoapods repo
+      run: pod repo update
     - name: Run unmocked integration tests
       env: 
         APP_KEY: ${{ secrets.DOLBYIO_APP_KEY }}

android/build.gradle

@@ -3,7 +3,7 @@ version '1.0-SNAPSHOT'
 
 buildscript {
     ext.kotlin_version = '1.7.10'
-    ext.voxeet_sdk_version = "3.10.0"
+    ext.voxeet_sdk_version = "[3.10.1,3.11)"
     ext.dagger_version = "2.40.5"
     repositories {
         google()

android/src/main/kotlin/io/dolby/comms/sdk/flutter/events/AudioPreviewEventEmitter.kt

@@ -1,23 +1,23 @@
 package io.dolby.comms.sdk.flutter.events
 
 import com.voxeet.VoxeetSDK
-import com.voxeet.android.media.capture.audio.preview.RecorderStatus
+import com.voxeet.android.media.capture.audio.preview.AudioPreviewStatus
 
 class AudioPreviewEventEmitter(eventChannelHandler: EventChannelHandler) : NativeEventEmitter(eventChannelHandler) {
 
     /**
      * Emitted when the application user received an audio preview status changed.
      */
-    private val previewCallback: (RecorderStatus) -> Unit = { status ->
+    private val previewCallback: (AudioPreviewStatus) -> Unit = { status ->
         emit(OnStatusChanged, status.name)
     }
 
     override fun registerEventEmitter() {
-        VoxeetSDK.audio().local.preview().callback = previewCallback
+        VoxeetSDK.audio().local.preview().onStatusChanged = previewCallback
     }
 
     override fun unregisterEventEmitter() {
-        VoxeetSDK.audio().local.preview().callback = null
+        VoxeetSDK.audio().local.preview().onStatusChanged = null
     }
 
     companion object {

android/src/main/kotlin/io/dolby/comms/sdk/flutter/module/audio/AudioPreviewNativeModule.kt

@@ -32,7 +32,7 @@ class AudioPreviewNativeModule(private val scope: CoroutineScope) : NativeModule
             ::setCaptureMode.name -> setCaptureMode(call, result)
             ::record.name -> record(call, result)
             ::play.name -> play(call, result)
-            ::cancel.name -> cancel(result)
+            ::stop.name -> stop(result)
             ::release.name -> release(result)
         }
     }
@@ -83,10 +83,10 @@ class AudioPreviewNativeModule(private val scope: CoroutineScope) : NativeModule
         }
     )
 
-    private fun cancel(result: MethodChannel.Result) = scope.launch(
+    private fun stop(result: MethodChannel.Result) = scope.launch(
         onError = result::onError,
         onSuccess = {
-            result.success(VoxeetSDK.audio().local.preview().cancel())
+            result.success(VoxeetSDK.audio().local.preview().stop())
         }
     )
 

ios/Classes/Bindings/AudioPreviewServiceBinding.swift

@@ -9,7 +9,7 @@ class AudioPreviewServiceBinding: Binding {
             do {
                 try self?.nativeEventEmitter.sendEvent(
                     event: EventKeys.statusChanged,
-                    body: DTO.RecorderStatus(recorderStatus: status)
+                    body: DTO.AudioPreviewStatus(audioPreviewStatus: status)
                 )
             } catch {
                 fatalError(error.localizedDescription)
@@ -26,7 +26,7 @@ class AudioPreviewServiceBinding: Binding {
         completionHandler: FlutterMethodCallCompletionHandler
     ) {
         let status = audioPreview().status
-        completionHandler.success(encodable: DTO.RecorderStatus(recorderStatus: status))
+        completionHandler.success(encodable: DTO.AudioPreviewStatus(audioPreviewStatus: status))
     }
 
     /// Retrieves the comfort noise level setting for output devices in Dolby Voice conferences.
@@ -101,15 +101,15 @@ class AudioPreviewServiceBinding: Binding {
         }
     }
 
-    /// If playing or recording is underway calling this method will cancel the ongoing activity.
+    /// If playing or recording is underway calling this method will stop the ongoing activity.
     /// - Parameters:
     ///   - flutterArguments: Method arguments passed from Flutter.
     ///   - completionHandler: Call methods on this instance when execution has finished.
-    public func cancel(
+    public func stop(
         flutterArguments: FlutterMethodCallArguments,
         completionHandler: FlutterMethodCallCompletionHandler
     ) {
-        audioPreview().cancel()
+        audioPreview().stop()
         completionHandler.success(flutterConvertible: true)
     }
 
@@ -144,8 +144,8 @@ extension AudioPreviewServiceBinding: FlutterBinding {
             play(flutterArguments: flutterArguments, completionHandler: completionHandler)
         case "record":
             record(flutterArguments: flutterArguments, completionHandler: completionHandler)
-        case "cancel":
-            cancel(flutterArguments: flutterArguments, completionHandler: completionHandler)
+        case "stop":
+            stop(flutterArguments: flutterArguments, completionHandler: completionHandler)
         case "release":
             release(flutterArguments: flutterArguments, completionHandler: completionHandler)
         default:

ios/Classes/Bindings/Models/AudioDTO.swift

@@ -4,7 +4,7 @@ import WebRTC
 
 typealias VTAudioCaptureMode = AudioCaptureMode
 typealias VTVoiceFont = VoiceFont
-typealias VTRecorderStatus = RecorderStatus
+typealias VTAudioPreviewStatus = AudioPreviewStatus
 
 extension DTO {
 
@@ -157,29 +157,29 @@ extension DTO {
         }
     }
 
-    struct RecorderStatus: Codable {
+    struct AudioPreviewStatus: Codable {
 
-        let recorderStatus: VTRecorderStatus
+        let audioPreviewStatus: VTAudioPreviewStatus
 
-        init(recorderStatus: VTRecorderStatus) {
-            self.recorderStatus = recorderStatus
+        init(audioPreviewStatus: VTAudioPreviewStatus) {
+            self.audioPreviewStatus = audioPreviewStatus
         }
 
         init(from decoder: Decoder) throws {
             let container = try decoder.singleValueContainer()
             switch try container.decode(String.self) {
-            case "NoRecordingAvailable": recorderStatus = .noRecordingAvailable
-            case "RecordingAvailable": recorderStatus = .recordingAvailable
-            case "Recording": recorderStatus = .recording
-            case "Playing": recorderStatus = .playing
-            case "Released": recorderStatus = .released
+            case "NoRecordingAvailable": audioPreviewStatus = .noRecordingAvailable
+            case "RecordingAvailable": audioPreviewStatus = .recordingAvailable
+            case "Recording": audioPreviewStatus = .recording
+            case "Playing": audioPreviewStatus = .playing
+            case "Released": audioPreviewStatus = .released
             default: throw EncoderError.decoderFailed()
             }
         }
 
         func encode(to encoder: Encoder) throws {
             var container = encoder.singleValueContainer()
-            switch recorderStatus {
+            switch audioPreviewStatus {
             case .noRecordingAvailable: try container.encode("NoRecordingAvailable")
             case .recordingAvailable: try container.encode("RecordingAvailable")
             case .recording: try container.encode("Recording")

ios/dolbyio_comms_sdk_flutter.podspec

@@ -19,7 +19,7 @@ DESC
   s.source           = { :path => '.' }
   s.source_files = 'Classes/**/*'
   s.dependency 'Flutter'
-  s.dependency 'VoxeetSDK', '~> 3.10.0'
+  s.dependency 'VoxeetSDK', '~> 3.10.1'
   s.platforms = {
     :ios => "12.0"
   }

lib/dolbyio_comms_sdk_flutter.dart

@@ -86,4 +86,4 @@ export 'src/sdk_api/models/audio.dart'
         AudioCaptureMode,
         NoiseReduction,
         VoiceFont,
-        RecorderStatus;
+        AudioPreviewStatus;

lib/src/sdk_api/audio/audio_preview.dart

@@ -17,9 +17,9 @@ class AudioPreview {
           .receiveBroadcastStream();
 
   /// Gets the recording status.
-  Future<RecorderStatus> status() async {
+  Future<AudioPreviewStatus> status() async {
     var status = await _methodChannel.invokeMethod("status");
-    return Future(() => RecorderStatus.decode(status));
+    return Future(() => AudioPreviewStatus.decode(status));
   }
 
   /// Gets an audio capture mode for the audio preview.
@@ -47,9 +47,9 @@ class AudioPreview {
     return await _methodChannel.invokeMethod("record", {"duration": duration});
   }
 
-  /// Cancels recording or playing an audio sample.
-  Future<bool> cancel() async {
-    return await _methodChannel.invokeMethod("cancel");
+  /// Stops recording or playing an audio sample.
+  Future<void> stop() async {
+    return await _methodChannel.invokeMethod("stop");
   }
 
   /// Release the internal memory and restart the audio session configuration.
@@ -58,13 +58,13 @@ class AudioPreview {
   }
 
   /// Returns a [Stream] of the [AudioPreviewEventNames.onStatusChanged] events. By subscribing to the returned stream you will be notified about new conference invitations.
-  Stream<Event<AudioPreviewEventNames, RecorderStatus>> onStatusChanged() {
+  Stream<Event<AudioPreviewEventNames, AudioPreviewStatus>> onStatusChanged() {
     return _eventStream
         .addListener([AudioPreviewEventNames.onStatusChanged.value]).map((map) {
       final event = map as Map<Object?, Object?>;
       final key = AudioPreviewEventNames.valueOf(event["key"] as String);
       final data = event["body"] as String;
-      return Event(key, RecorderStatus.decode(data));
+      return Event(key, AudioPreviewStatus.decode(data));
     });
   }
 }

lib/src/sdk_api/models/audio.dart

@@ -193,10 +193,10 @@ enum VoiceFont {
   }
 }
 
-/// The RecorderStatus model gathers all possible statuses of audio samples recording for audio preview.
+/// The AudioPreviewStatus model gathers all possible statuses of audio samples recording for audio preview.
 ///
 /// This model is available in SDK 3.10 and later.
-enum RecorderStatus {
+enum AudioPreviewStatus {
   /// There is no recording available.
   noRecordingAvailable("NoRecordingAvailable"),
 
@@ -214,14 +214,14 @@ enum RecorderStatus {
 
   final String _value;
 
-  const RecorderStatus(this._value);
+  const AudioPreviewStatus(this._value);
 
   String encode() {
     return _value;
   }
 
-  static RecorderStatus decode(String? value) {
-    return RecorderStatus.values.firstWhere(
+  static AudioPreviewStatus decode(String? value) {
+    return AudioPreviewStatus.values.firstWhere(
       (element) => element._value == value,
       orElse: () => throw Exception("Invalid enum name"),
     );