ConferenceJoinOptions

The ConferenceJoinOptions interface defines how an application expects to join a conference in terms of media preference.

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: ConferenceConstraints

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


maxVideoForwarding

Optional maxVideoForwarding: number

Sets the maximum number of video streams that may be transmitted to the joining participant. The valid parameter values are between 0 and 4 for mobile browsers, with 4 set as the default value.


mixing

Optional mixing: ConferenceMixingOptions

Allows joining conferences as a special participant called Mixer. For more information, see the Recording Conferences article.


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.


simulcast

Optional simulcast: boolean

Enables sending the Simulcast video streams to other conference participants.


spatialAudio

Optional spatialAudio: boolean

Enables spatial audio for the local participant who joins a Dolby Voice conference. By default, this parameter is set to false. When set to true in a conference that uses the individual spatial audio style, the application must place remote participants in a 3D space using the setSpatialPosition method.

❗️

Warning

In the individual spatial audio style, remote participants' audio is disabled until the participants are assigned to specific locations. We recommend calling setSpatialPosition from the participantAdded event to ensure that all participants are assigned to specific positions.


videoForwardingStrategy

Optional videoForwardingStrategy: VideoForwardingStrategy

Changes the video forwarding strategy for the local participant. This option is available only in SDK 3.6 and later.


Did this page help you?