ListenOptions

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

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.

forwardingStrategy

• Optional forwardingStrategy: VideoForwardingStrategy

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

leaveConferenceOnBeforeUnload

• Optional leaveConferenceOnBeforeUnload: boolean

Allows handling the beforeunload event on the application level instead of on the SDK level. By default, the SDK listens to the beforeunload event and leaves a conference when this event is triggered. When leaveConferenceOnBeforeUnload is set to false, the SDK stops reacting on the beforeunload event, which allows customizing the beforeunload handling. In this case, the SDK does not react to events such as closing a tab to leave a conference and these events need to be also handled on the application level.

maxVideoForwarding

• Optional maxVideoForwarding: number

Sets the maximum number of video streams that may be transmitted to the joining participant. The valid parameter's values are between 0 and 25 for desktop browsers and between 0 and 4 for mobile browsers. In the case of providing a value smaller than 0 or greater than the valid values, SDK triggers the VideoForwardingError. If the parameter value is not specified, the SDK automatically sets the maximum possible value: 25 for desktop browsers and 4 for mobile browsers.

This property is available in SDK 3.1 and later.

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.

type

• Optional type: ListenType

The listener type that indicates whether a participant wishes to join a conference as a regular listener or a mixed listener who can connect to the conference using Real-time Streaming. This property is available in SDK 3.9 and later.