NEWDolby Interactivity APIs are now the Dolby.io Communications APIs Learn More >
X

Conference

The Conference model allows the application to get information about the conference, such as:

Available in the package com.voxeet.sdk.models.Conference.

Methods

getId

getId(): String

Gets the conference ID.

Returns: @NonNull String - the conference ID.


getAlias

getAlias(): String

Gets the conference alias.

Returns: @Nullable String - the conference alias.


getParticipants

getParticipants(): CopyOnWriteArrayList<Participant>

Gets information about conference participants.

Returns: @NonNull CopyOnWriteArrayList<Participant> - the direct reference to the array of participants.


hasAny

hasAny(@NonNull status: ConferenceParticipantStatus, local: boolean): boolean

Checks if the participants at the current conference have one of the following statuses:

  • on-air
  • left
  • invited

Parameters

NameTypeDescription
statusConferenceParticipantStatusnon null participant's status
localbooleaninformation that the search includes only local participants

Returns: boolean - at least one participant with the corresponding state.


hasLocalStreams

hasLocalStreams(includeLocalParticipant: boolean): boolean

Checks if the Conference instance has the locally-based MediaStream.

Parameters

NameTypeDescription
includeLocalParticipantbooleaninformation that the search includes only local participants

Returns: boolean - the indicator of the local streams that is in 'connecting' or 'on air' state.


isNew

isNew(): boolean

Checks if the created conference is new.

Returns: boolean - boolean indicating if the created conference is new


hasMixer

hasMixer(): boolean

Checks if the current Conference has a Mixer participant currently connected. This method returns true if a Mixer participant exists in the conference.

Returns: boolean - the presence of an on-air mixer participant at the conference.


findParticipantById

findParticipantById(@Nullable participantId: String): Participant

Finds a conference participant who has the specific participantId. A null value informs that such a participant does not exist at a conference.

Parameters

NameTypeDescription
participantIdStringnullable valid ID of the conference participant

Returns: @Nullable Participant - the instance of the participant or a null value.


findParticipantByExternalId

findParticipantByExternalId(@Nullable externalId: String): Participant

Finds a conference participant who has the specific externalId. A null value informs that such participant does not exist at a conference.

Parameters

NameTypeDescription
externalIdStringnullable valid external ID of the conference participant

Returns: @Nullable Participant - the instance of the participant or a null value.


getConferenceInfos

getConferenceInfos(): ConferenceInfos

Gets a raw information about the conference.

Returns: @Nullable ConferenceInfos - the information or a null value if it does not exist.


getRecordingInformation

getRecordingInformation(): Conference.RecordingInformation

Gets the status of the current conference recording.

Returns: @Nullable Conference.RecordingInformation - the reference to the recording information.


getState

getState(): ConferenceStatus

Provides the current conference status.

Returns: @NonNull ConferenceStatus - the valid ConferenceState for a manipulation.


getPermissions

getPermissions(): Set<ConferencePermission>

Provides a list of the local participant's conference permissions.

Returns: @NonNull Set<ConferencePermission> - conference permissions.


isDolbyVoice

isDolbyVoice(): boolean

Checks if a conference is is enabled with Dolby Voice.

Returns: boolean


Did this page help you?