From cbcff79c40b08492ae8a01d69c2046634f3a3395 Mon Sep 17 00:00:00 2001 From: Monika <66684637+mhelf-dolby@users.noreply.github.com> Date: Tue, 12 Sep 2023 13:52:19 +0200 Subject: [PATCH] Documentation updates (#295) --- docs/classes/internal.CommandService.md | 2 +- docs/classes/internal.ConferenceService.md | 140 +----------------- .../internal.FilePresentationService.md | 2 + docs/classes/internal.LocalAudio.md | 8 +- docs/classes/internal.LocalVideo.md | 5 +- docs/classes/internal.MediaDeviceService.md | 36 ----- docs/classes/internal.RemoteAudio.md | 8 +- docs/classes/internal.RemoteVideo.md | 4 +- .../internal.VideoPresentationService.md | 2 + .../internal.ConferenceJoinOptions.md | 4 +- .../internal.ConferenceListenOptions.md | 2 +- docs/interfaces/internal.Participant.md | 6 +- .../internal.VideoForwardingOptions.md | 2 +- src/services/audio/LocalAudio.ts | 8 +- src/services/audio/RemoteAudio.ts | 8 +- src/services/command/CommandService.ts | 2 +- src/services/conference/ConferenceService.ts | 17 ++- src/services/conference/models.ts | 14 +- .../FilePresentationService.ts | 2 + .../mediaDevice/MediaDeviceService.ts | 2 + src/services/video/LocalVideo.ts | 5 +- src/services/video/RemoteVideo.ts | 4 +- .../VideoPresentationService.ts | 2 + 23 files changed, 69 insertions(+), 216 deletions(-) diff --git a/docs/classes/internal.CommandService.md b/docs/classes/internal.CommandService.md index e1f4e252..f494f7c7 100644 --- a/docs/classes/internal.CommandService.md +++ b/docs/classes/internal.CommandService.md @@ -27,7 +27,7 @@ The CommandService allows the application to send and receive text messages and ▸ **send**(`message`): `Promise`<`void`\> -Sends a message to all conference participants. +Sends a message to all conference participants. This method is not available for [mixed](doc:rn-client-sdk-enums-listentype#mixed) listeners. #### Parameters diff --git a/docs/classes/internal.ConferenceService.md b/docs/classes/internal.ConferenceService.md index 0524c620..37d99657 100644 --- a/docs/classes/internal.ConferenceService.md +++ b/docs/classes/internal.ConferenceService.md @@ -29,18 +29,12 @@ The ConferenceService allows an application to manage the conference life-cycle - [leave](internal.ConferenceService.md#leave) - [mute](internal.ConferenceService.md#mute) - [replay](internal.ConferenceService.md#replay) -- [setAudioProcessing](internal.ConferenceService.md#setaudioprocessing) -- [setMaxVideoForwarding](internal.ConferenceService.md#setmaxvideoforwarding) - [videoForwarding](internal.ConferenceService.md#videoforwarding) -- [startAudio](internal.ConferenceService.md#startaudio) - [startScreenShare](internal.ConferenceService.md#startscreenshare) -- [startVideo](internal.ConferenceService.md#startvideo) -- [stopAudio](internal.ConferenceService.md#stopaudio) - [stopScreenShare](internal.ConferenceService.md#stopscreenshare) - [setSpatialDirection](internal.ConferenceService.md#setspatialdirection) - [setSpatialEnvironment](internal.ConferenceService.md#setspatialenvironment) - [setSpatialPosition](internal.ConferenceService.md#setspatialposition) -- [stopVideo](internal.ConferenceService.md#stopvideo) - [updatePermissions](internal.ConferenceService.md#updatepermissions) - [onStatusChange](internal.ConferenceService.md#onstatuschange) - [onPermissionsChange](internal.ConferenceService.md#onpermissionschange) @@ -271,7 +265,7 @@ ___ ▸ **kick**(`participant`): `Promise`<`void`\> -Kicks a participant out of the current conference. This actions requires you to be conference owner or to have the adequate permissions to kick a participant. +Kicks a participant out of the current conference. This actions requires you to be conference owner or to have the adequate permissions to kick a participant. This method is not available for [mixed](doc:rn-client-sdk-enums-listentype#mixed) listeners. #### Parameters @@ -347,47 +341,6 @@ Replays a previously recorded conference. For more information, see the [Recordi ___ -### setAudioProcessing - -▸ **setAudioProcessing**(`options?`): `Promise`<`void`\> - -**Note**: This method is deprecated in SDK 3.7 and replaced with the [setCaptureMode](doc:rn-client-sdk-references-localaudio#setcapturemode) method. - -Enables and disables audio processing for a conference participant. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options` | [`AudioProcessingOptions`](../interfaces/internal.AudioProcessingOptions.md) | The AudioProcessingOptions model includes the AudioProcessingSenderOptions model responsible for enabling and disabling audio processing. | - -#### Returns - -`Promise`<`void`\> - -___ - -### setMaxVideoForwarding - -▸ **setMaxVideoForwarding**(`max?`, `prioritizedParticipants?`): `Promise`<`any`\> - -Sets the maximum number of video streams that may be transmitted to the local participant. - -This method is deprecated in SDK 3.6. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `max` | `number` | `4` | The maximum number of video streams that may be transmitted to the local participant. The valid parameter values are between 0 and 4. By default, the parameter is set to 4. | -| `prioritizedParticipants` | [`Participant`](../interfaces/internal.Participant.md)[] | `[]` | The list of the prioritized participants. This parameter allows using a pin option to prioritize specific participant's video streams and display their videos even when these participants do not talk. | - -#### Returns - -`Promise`<`any`\> - -___ - ### videoForwarding ▸ **videoForwarding**(`options`): `Promise`<`any`\> @@ -398,7 +351,7 @@ Sets the video forwarding functionality for the local participant. The method al - Prioritizing specific participants' video streams that need to be transmitted to the local participant - Changing the [video forwarding strategy](doc:rn-client-sdk-enums-videoforwardingstrategy) that defines how the SDK should select conference participants whose videos will be received by the local participant -This method is available only in SDK 3.6 and later. +This method is available only in SDK 3.6 and later and is not available for [mixed](doc:rn-client-sdk-enums-listentype#mixed) listeners. #### Parameters @@ -412,33 +365,12 @@ This method is available only in SDK 3.6 and later. ___ -### startAudio - -▸ **startAudio**(`participant`): `Promise`<`void`\> - -**Note**: This method is deprecated in SDK 3.7 and replaced with the **start** methods that are available in the [LocalAudio](doc:rn-client-sdk-references-localaudio) and [RemoteAudio](doc:rn-client-sdk-references-remoteaudio) models. - -Starts audio transmission between the local client and a conference. The startAudio method impacts only the audio streams that the local participant sends and receives; the method does not impact the audio transmission between remote participants and a conference and does not allow the local participant to force sending remote participants’ streams to the conference or to the local participant. Depending on the specified participant in the `participant` parameter, the startAudio method starts the proper audio transmission: -- When the specified participant is the local participant, startAudio ensures sending local participant’s audio from the local client to the conference. -- When the specified participant is a remote participant, startAudio ensures sending remote participant’s audio from the conference to the local client. This allows the local participant to unmute remote participants who are locally muted through the [stopAudio](#stopaudio) method. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `participant` | [`Participant`](../interfaces/internal.Participant.md) | The selected participant. If you wish to transmit the local participant's audio stream to the conference, provide the local participant's object. If you wish to receive the specific remote participants' audio streams, provide these remote participants' objects. | - -#### Returns - -`Promise`<`void`\> - -___ - ### startScreenShare ▸ **startScreenShare**(): `Promise`<`void`\> -Starts a screen sharing session. +Starts a screen sharing session. The method is available only to participants who joined a conference using the [join](doc:rn-client-sdk-conferenceservice#join) method; it is not available for listeners. + The ScreenShare with iOS document (https://docs.dolby.io/communications-apis/docs/screenshare-with-ios) describes how to set up screen-share outside the application. Instead of setting the following properties: - CommsSDK.shared.appGroup = "YOUR_APP_GROUP" @@ -447,47 +379,7 @@ Instead of setting the following properties: - Add a new `DolbyioSdkAppGroupKey` as a string type and enter the group name ("YOUR_APP_GROUP"). - Add a new `DolbyioSdkPreferredExtensionKey` as a string type and enter the broadcast extension bundle ID ("YOUR_BROADCAST_EXTENSION_BUNDLE_ID"). -#### Returns - -`Promise`<`void`\> - -___ - -### startVideo - -▸ **startVideo**(`participant`): `Promise`<`void`\> - -**Note**: This method is deprecated in SDK 3.7 and replaced with the **start** methods that are available in the [LocalVideo](doc:rn-client-sdk-references-localvideo) and [RemoteVideo](doc:rn-client-sdk-references-remotevideo) models. - -Notifies the server to either start sending the local participant's video stream to the conference or start sending a remote participant's video stream to the local participant. The startVideo method does not control the remote participant's video stream; if a remote participant does not transmit any video stream, the local participant cannot change it using the startVideo method. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `participant` | [`Participant`](../interfaces/internal.Participant.md) | The participant who will receive the video stream, either remote or local. | - -#### Returns - -`Promise`<`void`\> - -___ - -### stopAudio - -▸ **stopAudio**(`participant`): `Promise`<`void`\> - -**Note**: This method is deprecated in SDK 3.7 and replaced with the **stop** methods that are available in the [LocalAudio](doc:rn-client-sdk-references-localaudio) and [RemoteAudio](doc:rn-client-sdk-references-remoteaudio) models. - -Stops audio transmission between the local client and a conference. The stopAudio method impacts only the audio streams that the local participant sends and receives; the method does not impact the audio transmission between remote participants and a conference and does not allow the local participant to stop sending remote participants’ streams to the conference. Depending on the specified participant in the `participant` parameter, the stopAudio method stops the proper audio transmission: -- When the specified participant is the local participant, stopAudio stops sending local participant’s audio from the local client to the conference. -- When the specified participant is a remote participant, stopAudio stops sending remote participant’s audio from the conference to the local client. This allows the local participant to locally mute remote participants. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `participant` | [`Participant`](../interfaces/internal.Participant.md) | The selected participant. If you wish to not transmit the local participant's audio stream to the conference, provide the local participant's object. If you wish to not receive the specific remote participants' audio streams, provide these remote participants' objects. | +The SDK 3.10 and earlier support sharing only one screen per conference. The SDK 3.11 and later allow sharing two screens in one conference, so two participants can share their screens at the same time. #### Returns @@ -499,7 +391,7 @@ ___ ▸ **stopScreenShare**(): `Promise`<`void`\> -Stops a screen sharing session. +Stops a screen sharing session. The method is available only to participants who joined a conference using the [join](doc:rn-client-sdk-conferenceservice#join) method; it is not available for listeners. #### Returns @@ -633,26 +525,6 @@ For example, if a local participant Eric, who does not have a set direction, cal ___ -### stopVideo - -▸ **stopVideo**(`participant`): `Promise`<`void`\> - -**Note**: This method is deprecated in SDK 3.7 and replaced with the **stop** methods that are available in the [LocalVideo](doc:rn-client-sdk-references-localvideo) and [RemoteVideo](doc:rn-client-sdk-references-remotevideo) models. - -Notifies the server to either stop sending the local participant's video stream to the conference or stop sending a remote participant's video stream to the local participant. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `participant` | [`Participant`](../interfaces/internal.Participant.md) | The participant who wants to stop receiving a video stream. | - -#### Returns - -`Promise`<`void`\> - -___ - ### updatePermissions ▸ **updatePermissions**(`participantPermissions`): `Promise`<`void`\> diff --git a/docs/classes/internal.FilePresentationService.md b/docs/classes/internal.FilePresentationService.md index eedf6183..34a32ecf 100644 --- a/docs/classes/internal.FilePresentationService.md +++ b/docs/classes/internal.FilePresentationService.md @@ -24,6 +24,8 @@ The FilePresentationService allows presenting files during a conference. The Dol **10.** The presenter and the viewers receive [information](doc:rn-client-sdk-models-filepresentation) about the end of the file presentation via the [onFilePresentationChange](#onfilepresentationchange) listener. +The service is available only to participants who joined a conference using the [join](doc:rn-client-sdk-conferenceservice#join) method; it is not available for listeners. + ## Table of contents ### Constructors diff --git a/docs/classes/internal.LocalAudio.md b/docs/classes/internal.LocalAudio.md index 65f93ae6..462fec28 100644 --- a/docs/classes/internal.LocalAudio.md +++ b/docs/classes/internal.LocalAudio.md @@ -100,10 +100,9 @@ ___ ▸ **start**(): `Promise`<`void`\> -Starts sending the local participant’s audio streams from the local client to the conference. -This method is not available for listeners in Dolby Voice conferences. +Starts sending the local participant’s audio stream to a conference. The method is available only to participants who joined a conference using the [join](doc:rn-client-sdk-conferenceservice#join) method; it is not available for listeners. -The method requires up to a few seconds to become effective. +The method requires a few seconds to become effective. #### Returns @@ -115,8 +114,7 @@ ___ ▸ **stop**(): `Promise`<`void`\> -Stops sending local participant’s audio from the local client to the conference. -This method is not available for listeners in Dolby Voice conferences. +Stops sending local participant’s audio to a conference. The method is available only to participants who joined a conference using the [join](doc:rn-client-sdk-conferenceservice#join) method; it is not available for listeners. The method requires up to a few seconds to become effective. diff --git a/docs/classes/internal.LocalVideo.md b/docs/classes/internal.LocalVideo.md index df27b5b4..f04f7d49 100644 --- a/docs/classes/internal.LocalVideo.md +++ b/docs/classes/internal.LocalVideo.md @@ -29,7 +29,7 @@ This model is supported only in SDK 3.7 and later. ▸ **start**(): `Promise`<`void`\> -Enables the local participant's video and sends the video to a conference. +Enables the local participant's video and sends the video to a conference. The method is available only to participants who joined a conference using the [join](doc:rn-client-sdk-conferenceservice#join) method; it is not available for listeners. #### Returns @@ -41,7 +41,8 @@ ___ ▸ **stop**(): `Promise`<`void`\> -Disables the local participant's video and stops sending the video to a conference. +Disables the local participant's video and stops sending the video to a conference. The method is available only to participants who joined a conference using the [join](doc:rn-client-sdk-conferenceservice#join) method; it is not available for listeners. + Use this method only when the current participant is at the conference. #### Returns diff --git a/docs/classes/internal.MediaDeviceService.md b/docs/classes/internal.MediaDeviceService.md index b9f233cf..007124ab 100644 --- a/docs/classes/internal.MediaDeviceService.md +++ b/docs/classes/internal.MediaDeviceService.md @@ -12,9 +12,7 @@ The MediaDeviceService allows an application to manage media devices that are us ### Methods -- [getComfortNoiseLevel](internal.MediaDeviceService.md#getcomfortnoiselevel) - [isFrontCamera](internal.MediaDeviceService.md#isfrontcamera) -- [setComfortNoiseLevel](internal.MediaDeviceService.md#setcomfortnoiselevel) - [switchCamera](internal.MediaDeviceService.md#switchcamera) - [switchSpeaker](internal.MediaDeviceService.md#switchspeaker) @@ -26,20 +24,6 @@ The MediaDeviceService allows an application to manage media devices that are us ## Methods -### getComfortNoiseLevel - -▸ **getComfortNoiseLevel**(): `Promise`<[`ComfortNoiseLevel`](../enums/internal.ComfortNoiseLevel.md)\> - -**Note**: This method is deprecated in SDK 3.7 and replaced with the [getComfortNoiseLevel](doc:rn-client-sdk-references-localaudio#getcomfortnoiselevel) method available in the [LocalAudio](doc:rn-client-sdk-references-localaudio) model - -Retrieves the comfort noise level setting for output devices in Dolby Voice conferences. - -#### Returns - -`Promise`<[`ComfortNoiseLevel`](../enums/internal.ComfortNoiseLevel.md)\> - -___ - ### isFrontCamera ▸ **isFrontCamera**(): `Promise`<`boolean`\> @@ -52,26 +36,6 @@ Checks whether an application uses the front-facing (true) or back-facing camera ___ -### setComfortNoiseLevel - -▸ **setComfortNoiseLevel**(`noiseLevel`): `Promise`<`void`\> - -**Note**: This method is deprecated in SDK 3.7 and replaced with the [setComfortNoiseLevel](doc:rn-client-sdk-references-localaudio#setcomfortnoiselevel) method available in the [LocalAudio](doc:rn-client-sdk-references-localaudio) model. - -Configures the comfort noise level for output devices in Dolby Voice conferences. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `noiseLevel` | [`ComfortNoiseLevel`](../enums/internal.ComfortNoiseLevel.md) | The selected comfort noise level. | - -#### Returns - -`Promise`<`void`\> - -___ - ### switchCamera ▸ **switchCamera**(): `Promise`<`void`\> diff --git a/docs/classes/internal.RemoteAudio.md b/docs/classes/internal.RemoteAudio.md index f239b98f..f5c20d3f 100644 --- a/docs/classes/internal.RemoteAudio.md +++ b/docs/classes/internal.RemoteAudio.md @@ -31,9 +31,9 @@ This model is supported only in SDK 3.7 and later. ▸ **start**(`participant`): `Promise`<`void`\> -Allows the local participant to unmute a specific remote participant who is locally muted through the stop method. The start method does not impact audio transmission between remote participants and a conference and does not allow the local participant to force sending remote participants’ streams to the conference or to the local participant. This method is not available for listeners in Dolby Voice conferences. +Allows the local participant to start receiving audio from a specific remote participant. The start method does not impact audio transmission between remote participants and a conference and does not allow the local participant to force sending remote participants’ streams to the conference or to the local participant. The method requires a few seconds to become effective. -The start method requires up to a few seconds to become effective. +In Dolby Voice conferences and in the case of [mixed](doc:rn-client-sdk-enums-listentype#mixed) listeners, the method works as [mute](doc:rn-client-sdk-conferenceservice#mute), so it locally starts playing audio from a remote participant. #### Parameters @@ -51,9 +51,9 @@ ___ ▸ **stop**(`participant`): `Promise`<`void`\> -Allows the local participant to locally mute specific remote participants. This method does not impact audio transmission between remote participants and a conference and does not allow the local participant to stop sending remote participants’ streams to the conference. This method is not available for listeners in Dolby Voice conferences. +Allows the local participant to stop receiving audio from specific remote participants. This method does not impact audio transmission between remote participants and a conference and does not allow the local participant to stop sending remote participants’ streams to the conference. The method requires up to a few seconds to become effective. -The stop method requires up to a few seconds to become effective. +In Dolby Voice conferences and in the case of [mixed](doc:rn-client-sdk-enums-listentype#mixed) listeners, the method works as [mute](doc:rn-client-sdk-conferenceservice#mute), so it locally stops playing audio while the audio stream is still received. #### Parameters diff --git a/docs/classes/internal.RemoteVideo.md b/docs/classes/internal.RemoteVideo.md index 3c2618b9..80b94409 100644 --- a/docs/classes/internal.RemoteVideo.md +++ b/docs/classes/internal.RemoteVideo.md @@ -31,7 +31,7 @@ This model is supported only in SDK 3.7 and later. If the local participant used the stop method to stop receiving video streams from selected remote participants, the start method allows the participant to start receiving video streams from these participants. The start method does not impact the video transmission between remote participants and a conference and does not allow the local participant to force sending remote participants’ streams to the conference or to the local participant. -The start method requires a few seconds to become effective. +The start method requires a few seconds to become effective. The method is not available for [mixed](doc:rn-client-sdk-enums-listentype#mixed) listeners. #### Parameters @@ -51,7 +51,7 @@ ___ Allows the local participant to stop receiving video from specific remote participants. This method does not impact audio transmission between remote participants and a conference and does not allow the local participant to stop sending remote participants’ streams to the conference. -The stop method requires a few seconds to become effective. +The stop method requires a few seconds to become effective. The method is not available for [mixed](doc:rn-client-sdk-enums-listentype#mixed) listeners. #### Parameters diff --git a/docs/classes/internal.VideoPresentationService.md b/docs/classes/internal.VideoPresentationService.md index b1d89c75..60304cd8 100644 --- a/docs/classes/internal.VideoPresentationService.md +++ b/docs/classes/internal.VideoPresentationService.md @@ -18,6 +18,8 @@ The VideoPresentationService allows sharing videos during a conference. To prese **6.** The presenter calls the [stop](#stop) method to stop the video presentation. In such a situation, all conference participants receive this information via the [onVideoPresentationStopped](#onvideopresentationstopped) listener. +The service is available only to participants who joined a conference using the [join](doc:rn-client-sdk-conferenceservice#join) method; it is not available for listeners. + ## Table of contents ### Constructors diff --git a/docs/interfaces/internal.ConferenceJoinOptions.md b/docs/interfaces/internal.ConferenceJoinOptions.md index 808144a3..57cd9c85 100644 --- a/docs/interfaces/internal.ConferenceJoinOptions.md +++ b/docs/interfaces/internal.ConferenceJoinOptions.md @@ -56,7 +56,7 @@ ___ • `Optional` **preferRecvMono**: `boolean` -Indicates whether a participant wants to receive mono sound. By default, participants receive stereo audio. This configuration is only applicable when using the Opus codec and is available in non-Dolby Voice and Dolby Voice conferences. +Indicates whether a participant wants to receive mono sound. By default, the property is set to false. ___ @@ -64,7 +64,7 @@ ___ • `Optional` **preferSendMono**: `boolean` -Indicates whether a participant wants to send mono sound to a conference. By default, when using the Opus codec, participants' audio is sent as stereo. This configuration is only applicable when using the Opus codec and is available in non-Dolby Voice and Dolby Voice conferences. +Indicates whether a participant wants to send mono sound to a conference. By default, the property is set to true in most cases. The only situation when the property is set to false is when you set the [capture mode](doc:rn-client-sdk-references-localaudio#setcapturemode) to Unprocessed before joining a conference while using Opus. ___ diff --git a/docs/interfaces/internal.ConferenceListenOptions.md b/docs/interfaces/internal.ConferenceListenOptions.md index 2b22b5e7..ec4542ac 100644 --- a/docs/interfaces/internal.ConferenceListenOptions.md +++ b/docs/interfaces/internal.ConferenceListenOptions.md @@ -59,4 +59,4 @@ ___ • `Optional` **listenType**: [`ListenType`](../enums/internal.ListenType.md) -the listener type that indicates whether a participant wishes to join a conference as a regular listener or a mixed listener. This property is available in SDK 3.11 and later. +The listener type that indicates whether a participant wishes to join a conference as a regular listener or a mixed listener. This property is available in SDK 3.11 and later. diff --git a/docs/interfaces/internal.Participant.md b/docs/interfaces/internal.Participant.md index bc4d9c5a..196acace 100644 --- a/docs/interfaces/internal.Participant.md +++ b/docs/interfaces/internal.Participant.md @@ -20,7 +20,7 @@ The Participant interface gathers information about a conference participant. • **id**: `string` -The participant's ID. +The participant ID. ___ @@ -36,7 +36,7 @@ ___ • `Optional` **status**: [`ParticipantStatus`](../enums/internal.ParticipantStatus.md) -The participant's status. +The participant status. ___ @@ -52,4 +52,4 @@ ___ • `Optional` **type**: [`ParticipantType`](../enums/internal.ParticipantType.md) -The participant's type. +The participant type. diff --git a/docs/interfaces/internal.VideoForwardingOptions.md b/docs/interfaces/internal.VideoForwardingOptions.md index 5ed0f9b6..e04837e9 100644 --- a/docs/interfaces/internal.VideoForwardingOptions.md +++ b/docs/interfaces/internal.VideoForwardingOptions.md @@ -22,7 +22,7 @@ The VideoForwardingOptions model allows configuring the Video Forwarding functio • `Optional` **max**: `number` -The maximum number of video streams that may be transmitted to the local participant. The valid values are between 0 and 25. The default value is 4. In the case of providing a value smaller than 0 or greater than 25, SDK triggers an error. +The maximum number of video streams that may be transmitted to the local participant. The valid values are between 0 and 49. The default value is 4. In the case of providing a value smaller than 0 or greater than 49, SDK triggers an error. ___ diff --git a/src/services/audio/LocalAudio.ts b/src/services/audio/LocalAudio.ts index 5c2f8b2e..a4013166 100644 --- a/src/services/audio/LocalAudio.ts +++ b/src/services/audio/LocalAudio.ts @@ -55,10 +55,9 @@ export class LocalAudio { } /** - * Starts sending the local participant’s audio streams from the local client to the conference. - * This method is not available for listeners in Dolby Voice conferences. + * Starts sending the local participant’s audio stream to a conference. The method is available only to participants who joined a conference using the [join](doc:rn-client-sdk-conferenceservice#join) method; it is not available for listeners. * - * The method requires up to a few seconds to become effective. + * The method requires a few seconds to become effective. * */ public async start(): Promise { @@ -66,8 +65,7 @@ export class LocalAudio { } /** - * Stops sending local participant’s audio from the local client to the conference. - * This method is not available for listeners in Dolby Voice conferences. + * Stops sending local participant’s audio to a conference. The method is available only to participants who joined a conference using the [join](doc:rn-client-sdk-conferenceservice#join) method; it is not available for listeners. * * The method requires up to a few seconds to become effective. * diff --git a/src/services/audio/RemoteAudio.ts b/src/services/audio/RemoteAudio.ts index 4f86aa66..118ad531 100644 --- a/src/services/audio/RemoteAudio.ts +++ b/src/services/audio/RemoteAudio.ts @@ -14,9 +14,9 @@ export class RemoteAudio { _remoteAudio = CommsAPIRemoteAudioModule; /** - * Allows the local participant to unmute a specific remote participant who is locally muted through the stop method. The start method does not impact audio transmission between remote participants and a conference and does not allow the local participant to force sending remote participants’ streams to the conference or to the local participant. This method is not available for listeners in Dolby Voice conferences. + * Allows the local participant to start receiving audio from a specific remote participant. The start method does not impact audio transmission between remote participants and a conference and does not allow the local participant to force sending remote participants’ streams to the conference or to the local participant. The method requires a few seconds to become effective. * - * The start method requires up to a few seconds to become effective. + * In Dolby Voice conferences and in the case of [mixed](doc:rn-client-sdk-enums-listentype#mixed) listeners, the method works as [mute](doc:rn-client-sdk-conferenceservice#mute), so it locally starts playing audio from a remote participant. * * @param participant The selected remote participant who is locally muted through the stop method. * @@ -26,9 +26,9 @@ export class RemoteAudio { } /** - * Allows the local participant to locally mute specific remote participants. This method does not impact audio transmission between remote participants and a conference and does not allow the local participant to stop sending remote participants’ streams to the conference. This method is not available for listeners in Dolby Voice conferences. + * Allows the local participant to stop receiving audio from specific remote participants. This method does not impact audio transmission between remote participants and a conference and does not allow the local participant to stop sending remote participants’ streams to the conference. The method requires up to a few seconds to become effective. * - * The stop method requires up to a few seconds to become effective. + * In Dolby Voice conferences and in the case of [mixed](doc:rn-client-sdk-enums-listentype#mixed) listeners, the method works as [mute](doc:rn-client-sdk-conferenceservice#mute), so it locally stops playing audio while the audio stream is still received. * * @param participant The selected remote participant who should be locally muted. */ diff --git a/src/services/command/CommandService.ts b/src/services/command/CommandService.ts index 12ec44ec..322c3d22 100644 --- a/src/services/command/CommandService.ts +++ b/src/services/command/CommandService.ts @@ -17,7 +17,7 @@ export class CommandService { _nativeEvents = new NativeEvents(CommsAPICommandServiceModule); /** - * Sends a message to all conference participants. + * Sends a message to all conference participants. This method is not available for [mixed](doc:rn-client-sdk-enums-listentype#mixed) listeners. * @param message The message to send. */ public async send(message: string): Promise { diff --git a/src/services/conference/ConferenceService.ts b/src/services/conference/ConferenceService.ts index 07d1da0f..5eee4d1e 100644 --- a/src/services/conference/ConferenceService.ts +++ b/src/services/conference/ConferenceService.ts @@ -166,7 +166,7 @@ export class ConferenceService { } /** - * Kicks a participant out of the current conference. This actions requires you to be conference owner or to have the adequate permissions to kick a participant. + * Kicks a participant out of the current conference. This actions requires you to be conference owner or to have the adequate permissions to kick a participant. This method is not available for [mixed](doc:rn-client-sdk-enums-listentype#mixed) listeners. * @param participant The participant who needs to be kicked from a conference. */ public async kick(participant: Participant): Promise { @@ -224,6 +224,7 @@ export class ConferenceService { /** * **Note**: This method is deprecated in SDK 3.7 and replaced with the [setCaptureMode](doc:rn-client-sdk-references-localaudio#setcapturemode) method. + * @ignore * * Enables and disables audio processing for a conference participant. * @param options The AudioProcessingOptions model includes the AudioProcessingSenderOptions model responsible for enabling and disabling audio processing. @@ -236,6 +237,7 @@ export class ConferenceService { /** * Sets the maximum number of video streams that may be transmitted to the local participant. + * @ignore * * This method is deprecated in SDK 3.6. * @param max The maximum number of video streams that may be transmitted to the local participant. The valid parameter values are between 0 and 4. By default, the parameter is set to 4. @@ -258,7 +260,7 @@ export class ConferenceService { * - Prioritizing specific participants' video streams that need to be transmitted to the local participant * - Changing the [video forwarding strategy](doc:rn-client-sdk-enums-videoforwardingstrategy) that defines how the SDK should select conference participants whose videos will be received by the local participant * - * This method is available only in SDK 3.6 and later. + * This method is available only in SDK 3.6 and later and is not available for [mixed](doc:rn-client-sdk-enums-listentype#mixed) listeners. * * @param options The video forwarding options. */ @@ -272,6 +274,7 @@ export class ConferenceService { /** * **Note**: This method is deprecated in SDK 3.7 and replaced with the **start** methods that are available in the [LocalAudio](doc:rn-client-sdk-references-localaudio) and [RemoteAudio](doc:rn-client-sdk-references-remoteaudio) models. + * @ignore * * Starts audio transmission between the local client and a conference. The startAudio method impacts only the audio streams that the local participant sends and receives; the method does not impact the audio transmission between remote participants and a conference and does not allow the local participant to force sending remote participants’ streams to the conference or to the local participant. Depending on the specified participant in the `participant` parameter, the startAudio method starts the proper audio transmission: * - When the specified participant is the local participant, startAudio ensures sending local participant’s audio from the local client to the conference. @@ -283,7 +286,8 @@ export class ConferenceService { } /** - * Starts a screen sharing session. + * Starts a screen sharing session. The method is available only to participants who joined a conference using the [join](doc:rn-client-sdk-conferenceservice#join) method; it is not available for listeners. + * * The ScreenShare with iOS document (https://docs.dolby.io/communications-apis/docs/screenshare-with-ios) describes how to set up screen-share outside the application. * Instead of setting the following properties: * - CommsSDK.shared.appGroup = "YOUR_APP_GROUP" @@ -291,6 +295,8 @@ export class ConferenceService { * Set up keys in your `Info.plist` file: * - Add a new `DolbyioSdkAppGroupKey` as a string type and enter the group name ("YOUR_APP_GROUP"). * - Add a new `DolbyioSdkPreferredExtensionKey` as a string type and enter the broadcast extension bundle ID ("YOUR_BROADCAST_EXTENSION_BUNDLE_ID"). + * + * The SDK 3.10 and earlier support sharing only one screen per conference. The SDK 3.11 and later allow sharing two screens in one conference, so two participants can share their screens at the same time. */ public async startScreenShare(): Promise { return this._nativeModule.startScreenShare(); @@ -298,6 +304,7 @@ export class ConferenceService { /** * **Note**: This method is deprecated in SDK 3.7 and replaced with the **start** methods that are available in the [LocalVideo](doc:rn-client-sdk-references-localvideo) and [RemoteVideo](doc:rn-client-sdk-references-remotevideo) models. + * @ignore * * Notifies the server to either start sending the local participant's video stream to the conference or start sending a remote participant's video stream to the local participant. The startVideo method does not control the remote participant's video stream; if a remote participant does not transmit any video stream, the local participant cannot change it using the startVideo method. * @param participant The participant who will receive the video stream, either remote or local. @@ -308,6 +315,7 @@ export class ConferenceService { /** * **Note**: This method is deprecated in SDK 3.7 and replaced with the **stop** methods that are available in the [LocalAudio](doc:rn-client-sdk-references-localaudio) and [RemoteAudio](doc:rn-client-sdk-references-remoteaudio) models. + * @ignore * * Stops audio transmission between the local client and a conference. The stopAudio method impacts only the audio streams that the local participant sends and receives; the method does not impact the audio transmission between remote participants and a conference and does not allow the local participant to stop sending remote participants’ streams to the conference. Depending on the specified participant in the `participant` parameter, the stopAudio method stops the proper audio transmission: * - When the specified participant is the local participant, stopAudio stops sending local participant’s audio from the local client to the conference. @@ -319,7 +327,7 @@ export class ConferenceService { } /** - * Stops a screen sharing session. + * Stops a screen sharing session. The method is available only to participants who joined a conference using the [join](doc:rn-client-sdk-conferenceservice#join) method; it is not available for listeners. */ public async stopScreenShare(): Promise { return this._nativeModule.stopScreenShare(); @@ -434,6 +442,7 @@ export class ConferenceService { /** * **Note**: This method is deprecated in SDK 3.7 and replaced with the **stop** methods that are available in the [LocalVideo](doc:rn-client-sdk-references-localvideo) and [RemoteVideo](doc:rn-client-sdk-references-remotevideo) models. + * @ignore * * Notifies the server to either stop sending the local participant's video stream to the conference or stop sending a remote participant's video stream to the local participant. * @param participant The participant who wants to stop receiving a video stream. diff --git a/src/services/conference/models.ts b/src/services/conference/models.ts index eb20b44d..0a970c58 100644 --- a/src/services/conference/models.ts +++ b/src/services/conference/models.ts @@ -105,9 +105,9 @@ export interface ConferenceJoinOptions { maxVideoForwarding?: number; /** Allows joining conferences as a special participant called Mixer. For more information, see the [Recording Conferences](doc:guides-recording-conferences) article. */ mixing?: ConferenceMixingOptions; - /** Indicates whether a participant wants to receive mono sound. By default, participants receive stereo audio. This configuration is only applicable when using the Opus codec and is available in non-Dolby Voice and Dolby Voice conferences. */ + /** Indicates whether a participant wants to receive mono sound. By default, the property is set to false. */ preferRecvMono?: boolean; - /** Indicates whether a participant wants to send mono sound to a conference. By default, when using the Opus codec, participants' audio is sent as stereo. This configuration is only applicable when using the Opus codec and is available in non-Dolby Voice and Dolby Voice conferences. */ + /** Indicates whether a participant wants to send mono sound to a conference. By default, the property is set to true in most cases. The only situation when the property is set to false is when you set the [capture mode](doc:rn-client-sdk-references-localaudio#setcapturemode) to Unprocessed before joining a conference while using Opus. */ preferSendMono?: boolean; /** Enables sending the Simulcast video streams to other conference participants. */ simulcast?: boolean; @@ -141,7 +141,7 @@ export interface ConferenceListenOptions { spatialAudio?: boolean; /** Changes the video forwarding strategy for the local participant. This option is available only in SDK 3.6 and later. */ videoForwardingStrategy?: VideoForwardingStrategy; - /** the listener type that indicates whether a participant wishes to join a conference as a regular listener or a mixed listener. This property is available in SDK 3.11 and later. */ + /** The listener type that indicates whether a participant wishes to join a conference as a regular listener or a mixed listener. This property is available in SDK 3.11 and later. */ listenType?: ListenType; } @@ -161,15 +161,15 @@ export interface ConferenceMixingOptions { /** The Participant interface gathers information about a conference participant. */ export interface Participant { - /** The participant's ID. */ + /** The participant ID. */ id: string; /** Information about a conference participant. */ info: ParticipantInfo; - /** The participant's status. */ + /** The participant status. */ status?: ParticipantStatus; /** The participant's streams. */ streams?: MediaStream[]; - /** The participant's type. */ + /** The participant type. */ type?: ParticipantType; } @@ -493,7 +493,7 @@ export enum VideoForwardingStrategy { * - Prioritizing specific participants' video streams that need to be transmitted to the local participant * - Changing the video forwarding strategy that defines how the SDK should select conference participants whose videos will be received by the local participant */ export interface VideoForwardingOptions { - /** The maximum number of video streams that may be transmitted to the local participant. The valid values are between 0 and 25. The default value is 4. In the case of providing a value smaller than 0 or greater than 25, SDK triggers an error. */ + /** The maximum number of video streams that may be transmitted to the local participant. The valid values are between 0 and 49. The default value is 4. In the case of providing a value smaller than 0 or greater than 49, SDK triggers an error. */ max?: number; /** The list of participants whose video streams should be always transmitted to the local participant. */ participants?: Participant[]; diff --git a/src/services/filePresentation/FilePresentationService.ts b/src/services/filePresentation/FilePresentationService.ts index 045785ea..f8348fc6 100644 --- a/src/services/filePresentation/FilePresentationService.ts +++ b/src/services/filePresentation/FilePresentationService.ts @@ -34,6 +34,8 @@ const { CommsAPIFilePresentationServiceModule } = NativeModules; * * **10.** The presenter and the viewers receive [information](doc:rn-client-sdk-models-filepresentation) about the end of the file presentation via the [onFilePresentationChange](#onfilepresentationchange) listener. * + * The service is available only to participants who joined a conference using the [join](doc:rn-client-sdk-conferenceservice#join) method; it is not available for listeners. + * */ export class FilePresentationService { /** @internal */ diff --git a/src/services/mediaDevice/MediaDeviceService.ts b/src/services/mediaDevice/MediaDeviceService.ts index 0761c74f..d78d129f 100644 --- a/src/services/mediaDevice/MediaDeviceService.ts +++ b/src/services/mediaDevice/MediaDeviceService.ts @@ -14,6 +14,7 @@ export class MediaDeviceService { /** * **Note**: This method is deprecated in SDK 3.7 and replaced with the [getComfortNoiseLevel](doc:rn-client-sdk-references-localaudio#getcomfortnoiselevel) method available in the [LocalAudio](doc:rn-client-sdk-references-localaudio) model + * @ignore * * Retrieves the comfort noise level setting for output devices in Dolby Voice conferences. */ @@ -30,6 +31,7 @@ export class MediaDeviceService { /** * **Note**: This method is deprecated in SDK 3.7 and replaced with the [setComfortNoiseLevel](doc:rn-client-sdk-references-localaudio#setcomfortnoiselevel) method available in the [LocalAudio](doc:rn-client-sdk-references-localaudio) model. + * @ignore * * Configures the comfort noise level for output devices in Dolby Voice conferences. * diff --git a/src/services/video/LocalVideo.ts b/src/services/video/LocalVideo.ts index 61d84a0c..02595999 100644 --- a/src/services/video/LocalVideo.ts +++ b/src/services/video/LocalVideo.ts @@ -12,7 +12,7 @@ export class LocalVideo { _localVideo = CommsAPILocalVideoModule; /** - * Enables the local participant's video and sends the video to a conference. + * Enables the local participant's video and sends the video to a conference. The method is available only to participants who joined a conference using the [join](doc:rn-client-sdk-conferenceservice#join) method; it is not available for listeners. * */ public async start(): Promise { @@ -20,7 +20,8 @@ export class LocalVideo { } /** - * Disables the local participant's video and stops sending the video to a conference. + * Disables the local participant's video and stops sending the video to a conference. The method is available only to participants who joined a conference using the [join](doc:rn-client-sdk-conferenceservice#join) method; it is not available for listeners. + * * Use this method only when the current participant is at the conference. */ public async stop(): Promise { diff --git a/src/services/video/RemoteVideo.ts b/src/services/video/RemoteVideo.ts index 6c7f941a..eca5bc1a 100644 --- a/src/services/video/RemoteVideo.ts +++ b/src/services/video/RemoteVideo.ts @@ -16,7 +16,7 @@ export class RemoteVideo { /** * If the local participant used the stop method to stop receiving video streams from selected remote participants, the start method allows the participant to start receiving video streams from these participants. The start method does not impact the video transmission between remote participants and a conference and does not allow the local participant to force sending remote participants’ streams to the conference or to the local participant. * - * The start method requires a few seconds to become effective. + * The start method requires a few seconds to become effective. The method is not available for [mixed](doc:rn-client-sdk-enums-listentype#mixed) listeners. * * @param participant The selected remote participant who is locally muted through the stop method. * @@ -28,7 +28,7 @@ export class RemoteVideo { /** * Allows the local participant to stop receiving video from specific remote participants. This method does not impact audio transmission between remote participants and a conference and does not allow the local participant to stop sending remote participants’ streams to the conference. * - * The stop method requires a few seconds to become effective. + * The stop method requires a few seconds to become effective. The method is not available for [mixed](doc:rn-client-sdk-enums-listentype#mixed) listeners. * * @param participant The selected remote participant who should be locally muted. */ diff --git a/src/services/videoPresentation/VideoPresentationService.ts b/src/services/videoPresentation/VideoPresentationService.ts index f7d6653c..c0ede163 100644 --- a/src/services/videoPresentation/VideoPresentationService.ts +++ b/src/services/videoPresentation/VideoPresentationService.ts @@ -24,6 +24,8 @@ const { CommsAPIVideoPresentationServiceModule } = NativeModules; * **5.** The presenter can call the [seek](#seek) method to navigate to a specific section of the shared video. After calling the seek method, all conference participants receive [information](doc:rn-client-sdk-models-videopresentationeventtype) about the updated timestamp via the [onVideoPresentationChange](#onvideopresentationchange) listener. * * **6.** The presenter calls the [stop](#stop) method to stop the video presentation. In such a situation, all conference participants receive this information via the [onVideoPresentationStopped](#onvideopresentationstopped) listener. + * + * The service is available only to participants who joined a conference using the [join](doc:rn-client-sdk-conferenceservice#join) method; it is not available for listeners. */ export class VideoPresentationService { /** @internal */