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 Mechanisms 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
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.
Updated 3 months ago