2020 API AWARDS WINNER - BEST IN MEDIA APIs LEARN MORE

Participant

The Participant model gathers information about conference participants, such as _LINK(ID, Participant, getid), status, and information. It also checks whether the participant is locally active, accesses streams available for the participant and streams manager that enables stream manipulation.

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

Methods

isLocallyActive

isLocallyActive(): boolean

Informs if the current Participant instance is connected to the local device.

Returns: boolean - the flag indicating if the participant is already connected.

getId

getId(): String

Gets the Voxeet identifier of a specific conference participant. The ID is managed by the SDK.

Returns: @Nullable String - possibly a null value.

getInfo

getInfo(): ParticipantInfo

Gets information about the current participant.

Returns: @Nullable ParticipantInfo - displayed information.

streams

streams(): List<MediaStream>

An accessor to streams available for the current Participant instance.

Returns: @NonNull List<MediaStream> - a non-null list containing the MediaStream.

streamsHandler

streamsHandler(): ParticipantMediaStreamHandler

The accessor to the streams manager available for the current Participant instance. The manager adds filtering and methods to manipulate the streams.

Returns: @NonNull ParticipantMediaStreamHandler - a non-null instance of the ParticipantMediaStreamHandler.

getStatus

getStatus(): ConferenceParticipantStatus

Gets the current status.

Returns: @NonNull ConferenceParticipantStatus - the instance of the valid status.