2020 API AWARDS WINNER - BEST IN MEDIA APIs LEARN MORE

ConferenceInformation

The ConferenceInformation model gathers information about:

Available in the package com.voxeet.sdk.services.conference.information.ConferenceInformation.

Methods

getPosition

getPosition(@NonNull participant: Participant): ParticipantPosition

Retrieves the participant position in the 3D audio context.

Parameters

NameTypeDescription
participantParticipantnon null valid instance of the conference participant

Returns: @NonNull ParticipantPosition - the position of the given participant.

getPosition

getPosition(@NonNull participantId: String): ParticipantPosition

Retrieves the participant's position in the 3D audio context.

Parameters

NameTypeDescription
participantIdStringnon null valid participant's ID

Returns: @NonNull ParticipantPosition - the position of the given participant.

setPosition

setPosition(@NonNull participant: Participant, @NonNull point: ParticipantPosition): void

Sets the participant's position.

Parameters

NameTypeDescription
participantParticipantnon null valid instance of the conference participant
pointParticipantPositionnon null participant's position

setPosition

setPosition(@NonNull participantId: String, @NonNull point: ParticipantPosition): void

Sets the participant's position.

Parameters

NameTypeDescription
participantIdStringnon null participant's ID.
pointParticipantPositionnon null participant's position.

getConference

getConference(): Conference

Gets the Conference instance from the information holder.

Returns: @NonNull Conference - the valid instance.

getConferenceType

getConferenceType(): LocalConferenceType

Gets the current local conference type (none, conference, or replay). It is not a conference presentation from the server point of view.v

Returns: @NonNull LocalConferenceType - the current conference type.

getConferenceState

getConferenceState(): ConferenceStatus

Gets the current conference state. All possible states are sufficient to manage a pure conference UX and UI.

Returns: @NonNull ConferenceStatus - the conference state.

isOwnVideoStarted

isOwnVideoStarted(): boolean

This method is helpful in dealing with new privacy features in Android P+.

Returns: boolean - a boolean indicating the proper state.

getConferenceParticipantType

getConferenceParticipantType(): ConferenceParticipantType

Retrieves the current state of the conference participant (for example: listener, normal, or broadcaster).

Returns: ConferenceParticipantType - the current type for the local session participant.

isBroadcaster

isBroadcaster(): boolean

Informs if the currently logged in participant is in the broadcaster mode. This method is useful for webinars.

Returns: boolean - informs if there is a broadcaster in the current session.

isListener

isListener(): boolean

Informs if the currently logged in participant is in a listening mode.

Returns: boolean - informs if there is a listener in the current session.

isScreenShareOn

isScreenShareOn(): boolean

Checks if the screen is currently shared from a perspective of a screen share lifecycle.

Returns: boolean - the screen share state.

getVideoState

getVideoState(): MediaState

Gets the state of the local video that is displayed during the conference. The state changes as in the following cycle: stopped ▸ starting ▸ started ▸ stopping ▸ stopped.

Returns: @NonNull MediaState - the current non-null enum value.

getAudioState

getAudioState(): MediaState

Gets the state of the local audio that is displayed during the conference. The state changes as in the following cycle: stopped ▸ starting ▸ started ▸ stopping ▸ stopped.

Returns: @NonNull MediaState - the current non-null enum value.