NEWDolby Interactivity APIs are now the Dolby.io Communications APIs Learn More >
X

JoinOptions

The JoinOptions model defines how the application expects to join a conference in terms of media preference. The JoinOptions model specifies:

For more information related to JoinOptions, see MediaStreamConstraints.

Properties

conferenceAccessToken

Optional conferenceAccessToken: string

The conference access token that is required to join a protected conference if the conference is created using the create REST API. If the conference is created using the create method, the token is managed by the SDK and is not visible to the application users. For more information, see the Enhanced Conference Access Control document.


constraints

Optional constraints: any

Sets the conference WebRTC constraints. By default, only audio is enabled: {audio: true, video: false}.


leaveConferenceOnBeforeUnload

Optional leaveConferenceOnBeforeUnload: boolean

Allows handling the beforeunload event on the application level instead of on the SDK level. By default, the SDK listens to the beforeunload event and leaves a conference when this event is triggered. When leaveConferenceOnBeforeUnload is set to false, the SDK stops reacting on the beforeunload event, which allows customizing the beforeunload handling. When leaveConferenceOnBeforeUnload is set to false, the SDK does not react to events such as closing a tab to leave a conference and such events need to be also handled on the application level.


maxVideoForwarding

Optional maxVideoForwarding: number

Sets the maximum number of video streams that may be transmitted to the joining participant. The valid parameter's values are between 0 and 25 for desktop browsers and between 0 and 4 for mobile browsers. In the case of providing a value smaller than 0 or greater than the valid values, SDK triggers the VideoForwardingError. If the parameter value is not specified, the SDK automatically sets the maximum possible value: 25 for desktop browsers and 4 for mobile browsers.


mixing

Optional mixing: MixingOptions

Allows joining conferences as Mixer. For Dolby Voice conferences, the web client sends mono Opus and receives stereo Opus. The two options do not affect clients connecting to Dolby Voice conferences; the behavior is hard-coded.


preferRecvMono

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.


preferSendMono

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.


spatialAudio

Optional spatialAudio: boolean

🚀

Closed Beta

This API is a part of the Beta program.

Allows the local participant to change remote participants' locations and experience spatial audio. By default, this parameter is set to false. When set to true, the application must place remote participants in a 3D space using the setSpatialPosition method.

❗️

Warning

Remote participants' audio is disabled until the participants are assigned to specific locations. We recommend calling setSpatialPosition from the participantUpdated event to ensure that all participants are assigned to specific positions.


simulcast

Optional simulcast: Boolean

Enables sending the Simulcast video streams to other conference participants.


videoFilter

Optional videoFilter: VideoFilter

The video filter that allows blurring or changing the local participant's background. The video filters are available only for the Dolby.io Communications SDK for Desktop users.


videoFilterOptions

Optional videoFilterOptions: VideoFilterOptions

Video filter options that include the image file for the staticImage filter and information about the video stream on which the video filter should be applied.


Did this page help you?