ConferenceListenOptions

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

Available in the package com.voxeet.sdk.services.builders.ConferenceListenOptions.

Methods

getAccessToken

▸ getAccessToken(): String

The conference access token received from the create or invite REST API. The conference access token is required to join a protected conference. For more information, see the Enhanced Conference Access Control article.

Returns: @Nullable String - The conference access token or null.

---

getConference

▸ getConference(): Conference

Gets the conference.

Returns: @Nullable Conference - The conference ID or a null value.

---

getListenType

▸ getListenType(): ListenType

Gets 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: @Nullable ListenType

---

getMaxVideoForwarding

▸ getMaxVideoForwarding(): Integer

Gets the maximum number of forwarded video for the current conference.

Returns: @Nullable Integer

---

getVideoForwardingStrategy

▸ getVideoForwardingStrategy(): VideoForwardingStrategy

Gets the video forwarding strategy that the local participant uses in the current conference. This method is available only in SDK 3.6 and later.

Returns: @NonNull VideoForwardingStrategy

---

isSpatialAudio

▸ isSpatialAudio(): boolean

Gets the flag indicating whether the local participant uses spatial audio.

Returns: boolean - The spatial audio flag.

---

setListenType

▸ setListenType(): ListenType

Sets the listener type that indicates whether a participant wishes to join a conference as a regular listener or a mixed listener. This property is available in SDK 3.11 and later.

Returns: @Nullable ListenType