ConferenceJoinOptions class
The ConferenceJoinOptions class defines how an application expects to join a conference in terms of media preference.
Constructors
Properties
- 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.
getter/setter pair
- constraints ↔ ConferenceConstraints?
-
Sets the conference WebRTC constraints. By default, only audio is enabled:
{audio: true, video: false}
.getter/setter pair - hashCode → int
-
The hash code for this object.
no setterinherited
- 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 4 for mobile browsers. By default, the parameter is set to 4.
getter/setter pair
- mixing ↔ ConferenceMixingOptions?
-
Allows joining a conference as a special participant called Mixer. For more information, see the Recording Conferences article.
getter/setter pair
- preferRecvMono ↔ bool?
-
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.
getter/setter pair
- preferSendMono ↔ bool?
-
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.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- simulcast ↔ bool?
-
Enables sending the Simulcast video streams to other conference participants.
getter/setter pair
- 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.getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, Object?> - Returns a representation of this object as a JSON object.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited