VTJoinOptions

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

• Conference access token that is required to join a protected conference
• The WebRTC constraints
• The maximum number of video streams that may be transmitted to the joining participant
• Information whether the joining participant wants to enable spatial audio

Accessors

conferenceAccessToken

▸ 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.

Returns: String?

constraints

▸ constraints: [VTJoinOptionsConstraints]

Sets the conference WebRTC constraints.

Returns: [VTJoinOptionsConstraints]

maxVideoForwarding

▸ maxVideoForwarding: Int?

Sets the maximum number of video streams that may be transmitted to the joining participant. The valid values are between 0 and 4. In the case of providing a value smaller than 0 or greater than 4, SDK triggers the videoForwarding error.

Returns: Int?

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.

❗️

Warning

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.