Doc updates for SDK 3.10 (#407)

* Doc updates for SDK 3.10
* Incorporated review feedback
* Updated the release notes

Author: mhelf-dolby

CHANGELOG.md

@@ -1,3 +1,21 @@
+## 3.10.0-beta.1
+
+### Features
+
+- Introduced the ability to change the [capture mode](https://api-references.dolby.io/comms-sdk-flutter/dolbyio_comms_sdk_flutter/LocalAudio/setCaptureMode.html) in non-Dolby Voice conferences and use either the [Standard](https://api-references.dolby.io/comms-sdk-flutter/dolbyio_comms_sdk_flutter/AudioCaptureMode.html#standard) or [Unprocessed](https://api-references.dolby.io/comms-sdk-flutter/dolbyio_comms_sdk_flutter/AudioCaptureMode.html#unprocessed) mode.
+
+- Introduced a new [voiceFont](https://api-references.dolby.io/comms-sdk-flutter/dolbyio_comms_sdk_flutter/AudioCaptureOptions/voicefont.html) property to [AudioCaptureOptions](https://api-references.dolby.io/comms-sdk-flutter/dolbyio_comms_sdk_flutter/AudioCaptureOptions-class.html) that is supported in the [Standard](https://api-references.dolby.io/comms-sdk-flutter/dolbyio_comms_sdk_flutter/AudioCaptureMode.html#standard) audio capture mode. [Voice fonts](https://api-references.dolby.io/comms-sdk-flutter/dolbyio_comms_sdk_flutter/AudioCaptureOptions/voicefont.html) allow participants to modify their voices in real time to improve social interaction in entertainment scenarios. For more information about this feature, see the [Using Voice Fonts](https://docs.dolby.io/interactivity/docs/guides-using-voice-fonts) guide.
+
+- Introduced a new [preview](https://api-references.dolby.io/comms-sdk-flutter/dolbyio_comms_sdk_flutter/LocalAudio/preview.html) service that allows the local participant to test different capture modes and voice fonts before a conference. The service records the participant's audio and plays it back. Before playing the recorded audio, set the [captureMode](https://api-references.dolby.io/comms-sdk-flutter/dolbyio_comms_sdk_flutter/LocalAudio/setCaptureMode.html) to a preferred setting that you wish to try.
+
+- Introduced a new [updateParticipantInfo](https://api-references.dolby.io/comms-sdk-flutter/dolbyio_comms_sdk_flutter/SessionService/updateParticipantInfo.html) method that lets participants modify their names and avatars while they are in a conference.
+
+- The SDK now supports receiving two shared screens in one conference.
+
+### Changes
+
+Changed the default value of the audio capture mode in non-Dolby Voice conferences to [Standard](https://api-references.dolby.io/comms-sdk-flutter/dolbyio_comms_sdk_flutter/AudioCaptureMode.html#standard) with [high](https://api-references.dolby.io/comms-sdk-flutter/dolbyio_comms_sdk_flutter/NoiseReduction.html#high) noise reduction. This setting optimizes captured audio for speech by aggressively removing non-speech content. If you want to transmit non-stationary background sounds to a conference and create a more natural audio experience, you can set noise reduction to [low](https://api-references.dolby.io/comms-sdk-flutter/dolbyio_comms_sdk_flutter/NoiseReduction.html#low), which offers a similar experience as the default setting in previous releases. If you wish to transmit non-voice audio to a conference as well and use input device setting without any processing, use the [Unprocessed](https://api-references.dolby.io/comms-sdk-flutter/dolbyio_comms_sdk_flutter/AudioCaptureMode.html#unprocessed) mode.
+
 ## 3.8.3
 
 ### Bug Fixes

lib/src/sdk_api/audio/audio_preview.dart

@@ -4,9 +4,7 @@ import 'package:dolbyio_comms_sdk_flutter/src/mapper/mapper.dart';
 import '../../dolbyio_comms_sdk_flutter_platform_interface.dart';
 import '../../dolbyio_comms_sdk_native_events.dart';
 
-/// The AudioPreview allows to test audio settings (voice font, noise reduction, capture mode) before join to conference.
-///
-/// This feature is available in SDK 3.10 and later.
+/// The AudioPreview model allows the local participant to test different capture modes and voice fonts before a conference. The model is supported only in SDK 3.10 and later.
 class AudioPreview {
   /// @internal
   final _methodChannel = DolbyioCommsSdkFlutterPlatform.createMethodChannel(
@@ -19,22 +17,19 @@ class AudioPreview {
           .receiveBroadcastStream();
 
   /// Gets the recording status.
-  /// Returns RecorderStatus enum
   Future<RecorderStatus> status() async {
     var status = await _methodChannel.invokeMethod("status");
     return Future(() => RecorderStatus.decode(status));
   }
 
   /// Gets an audio capture mode for the audio preview.
-  /// @returns AudioCaptureModeOptions
   Future<AudioCaptureOptions> getCaptureMode() async {
     var result = await _methodChannel.invokeMethod("getCaptureMode");
     return AudioCaptureOptionsMapper.fromMap(result);
   }
 
   /// Sets an audio capture mode for the audio preview.
   /// [captureMode] - a capture mode to test
-  /// Returns void
   Future<void> setCaptureMode(AudioCaptureOptions captureMode) async {
     return await _methodChannel.invokeMethod(
         "setCaptureMode", captureMode.toJson());
@@ -46,21 +41,18 @@ class AudioPreview {
     return await _methodChannel.invokeMethod("play", {"loop": loop});
   }
 
-  /// Plays back the recorded audio sample. To test how your audio sounds while using different capture modes and voice fonts,
-  /// set the captureMode to a preferred setting before using the method.
+  /// Starts recording an audio sample if no recording is in progress.
   /// [duration] - The preferred recording duration, in seconds.
   Future<void> record(int duration) async {
     return await _methodChannel.invokeMethod("record", {"duration": duration});
   }
 
   /// Cancels recording or playing an audio sample.
-  /// @returns true for success, false when failed
   Future<bool> cancel() async {
     return await _methodChannel.invokeMethod("cancel");
   }
 
   /// Release the internal memory and restart the audio session configuration.
-  /// Returns void
   Future<void> release() async {
     return await _methodChannel.invokeMethod("release");
   }

lib/src/sdk_api/audio/local_audio.dart

@@ -14,7 +14,7 @@ class LocalAudio {
     "local_audio",
   );
 
-  /// Audio preview module to test participant audio settings.
+  /// Allows the local participant to test different capture modes and voice fonts before a conference. The method sets a preview recorder that records the participant's audio and plays it back. Before playing the recorded audio, set the [captureMode](#setCaptureMode) to a preferred setting that you wish to try. The method is supported only in SDK 3.10 and later.
   final preview = AudioPreview();
 
   /// Sets the local participant's audio capture mode in Dolby Voice conferences.

lib/src/sdk_api/models/audio.dart

@@ -1,16 +1,16 @@
-/// The AudioCaptureModeOptions model allows selecting the preferred audio capture mode and the preferred noise reduction level.
+/// The AudioCaptureModeOptions model allows selecting the preferred audio capture mode and additional options for the preferred mode.
 ///
 /// This model is available in SDK 3.7 and later.
 ///
 /// {@category Models}
 class AudioCaptureOptions {
-  /// The preferred audio mode that allows enabling and disabling audio processing.
+  /// The preferred audio mode for capturing the local participant's audio.
   AudioCaptureMode mode;
 
-  /// The preferred level of noise reduction.
+  /// The preferred level of noise reduction. This property is supported only in the Standard mode.
   NoiseReduction? noiseReduction;
 
-  /// The preferred voice modification effect that you can use to change the local participant's voice in real time.
+  /// The preferred voice modification effect that you can use to change the local participant's voice in real time. This property is supported only in the Standard mode in SDK 3.10 and later.
   VoiceFont voiceFont;
 
   AudioCaptureOptions(this.mode, this.noiseReduction,
@@ -29,7 +29,7 @@ class AudioCaptureOptions {
 ///
 /// {@category Models}
 enum AudioCaptureMode {
-  /// Optimizes captured audio for speech by aggressively removing non-speech content, such as background noise. This mode additionally enhances speech perceptibility to create a conversation-focused conference environment.
+  /// The default mode aimed at enhancing speech to create a conversation-focused conference environment. This mode optimizes captured audio for speech by aggressively removing non-speech content, such as background noise.
   standard('standard'),
 
   /// Disables audio processing to allow transmitting non-voice audio to a conference.
@@ -58,7 +58,7 @@ enum AudioCaptureMode {
 ///
 /// {@category Models}
 enum NoiseReduction {
-  /// Removes all background sounds to improve voice quality. Use this mode if you want to send only voice to a conference.
+  /// The default level that removes all background sounds to improve voice quality. Use this mode if you want to send only voice to a conference.
   high('high'),
 
   /// Removes stationary background sounds, such as the sound of a computer fan, air conditioning, or microphone hum, from audio transmitted to a conference. In this mode, non-stationary sounds are transmitted to give participants full context of other participants' environments and create a more realistic audio experience. If you want to send only voice to a conference, use the [High](#high) level.

lib/src/sdk_api/session_service.dart

@@ -23,7 +23,7 @@ class SessionService {
     return Future.value();
   }
 
-  /// Update actual participant name and avatarUrl
+  /// Updates the local participant's name and avatar URL. This method is supported in SDK 3.10 and later.
   Future<void> updateParticipantInfo(String name, String avatarUrl) async {
     var params = {"name": name, "avatarUrl": avatarUrl};
     await _methodChannel.invokeMethod<void>('updateParticipantInfo', params);