2020 API AWARDS WINNER - BEST IN MEDIA APIs LEARN MORE

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 that is set by a developer.

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 at the current conference there are participants with 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 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.

hasMixer

hasMixer(): boolean

Checks if the current Conference has a Mixer participant currently connected. It helps to filter out such participants into the UI or add a label. It returns a true value when 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

Filters participants to find the one with the desired Voxeet 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

Filters participants to find the one with a desired external ID 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

Informs about the current conference status.

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