ConferenceJoinOptions class Models

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




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.
read / write
constraints ConferenceConstraints?
Sets the conference WebRTC constraints. By default, only audio is enabled: {audio: true, video: false}.
read / write
hashCode int
The hash code for this object.
maxVideoForwarding num?
Sets the maximum number of video streams that may be transmitted to the joining participant. The valid parameter values are between 0 and 25 for mobile browsers. By default, the parameter is set to 4.
read / write
mixing ConferenceMixingOptions?
Allows joining a conference as a special participant called Mixer. For more information, see the Recording Conferences article.
read / write
runtimeType Type
A representation of the runtime type of the object.
simulcast bool?
Enables sending the Simulcast video streams to other conference participants.
read / write
spatialAudio bool?
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 SpatialAudioStyle, the application must place remote participants in a 3D space using the ConferenceService.setSpatialPosition method.
read / write
videoForwardingStrategy VideoForwardingStrategy?
Defines how the SDK should select conference participants whose videos will be transmitted to the local participant.
read / write


noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
toJson() Map<String, Object?>
Returns a representation of this object as a JSON object.
toString() String
A string representation of this object.


operator ==(Object other) bool
The equality operator.