Skip to content
This repository has been archived by the owner on Aug 30, 2024. It is now read-only.

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
mhelf-dolby committed Sep 12, 2023
1 parent 6bc2ecd commit b65b1c2
Show file tree
Hide file tree
Showing 24 changed files with 69 additions and 218 deletions.
2 changes: 1 addition & 1 deletion docs/classes/internal.CommandService.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
140 changes: 6 additions & 134 deletions docs/classes/internal.ConferenceService.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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`\>
Expand All @@ -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

Expand All @@ -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"
Expand All @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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`\>
Expand Down
2 changes: 2 additions & 0 deletions docs/classes/internal.FilePresentationService.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 3 additions & 5 deletions docs/classes/internal.LocalAudio.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.

Expand Down
5 changes: 3 additions & 2 deletions docs/classes/internal.LocalVideo.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down
36 changes: 0 additions & 36 deletions docs/classes/internal.MediaDeviceService.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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`\>
Expand All @@ -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`\>
Expand Down
8 changes: 4 additions & 4 deletions docs/classes/internal.RemoteAudio.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/classes/internal.RemoteVideo.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down
2 changes: 2 additions & 0 deletions docs/classes/internal.VideoPresentationService.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading

0 comments on commit b65b1c2

Please sign in to comment.