VTListenOptions

The VTListenOptions model defines how the application expects to join a conference using the listen method.

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?

---

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 49. In the case of providing a value smaller than 0, SDK triggers the videoForwarding error. In the case of providing a value greater than 49, the Dolby.io server triggers an error.

Returns: Int?

---

videoForwardingStrategy

▸ videoForwardingStrategy: VideoForwardingStrategy

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

Returns: VideoForwardingStrategy

---

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.

Returns: boolean

---

type

▸ type: ListenType

The listener type that indicates whether a participant is a regular listener or a mixed listener. This property is available in SDK 3.11 and later.

Returns: ListenType