Participant

The Participant model contains information about a conference participant.

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

Methods

isLocallyActive

isLocallyActive(): boolean

Checks if the participant is connected to the local device.

Returns: boolean


getId

getId(): String

Gets the participant ID.

Returns: @Nullable String


getInfo

getInfo(): ParticipantInfo

Gets information about the current participant.

Returns: @Nullable ParticipantInfo


setVolume

setVolume(volume: float): void

Sets the participant's volume in non-Dolby Voice conferences to a preferred value between 0 and 1. Providing an unsupported number results in constraining the volume to either 0 or 1. This method is supported in SDK 3.11 and later.

Parameters

NameTypeDescription
volumefloatThe preferred volume level between 0 (no audio) and 1 (full volume).

streams

streams(): List<MediaStream>

Gets information about participant's streams.

Returns: @NonNull List<MediaStream>


streamsHandler

streamsHandler(): ParticipantMediaStreamHandler

Accesses streams manager that allows manipulating the participant's streams.

Returns: @NonNull ParticipantMediaStreamHandler


getStatus

getStatus(): ConferenceParticipantStatus

Gets the current participant's status.

Returns: @NonNull ConferenceParticipantStatus


participantType

participantType(): ParticipantType

Gets the participant's type.

Returns: @NonNull ParticipantType


audioReceivingFrom

audioReceivingFrom(): boolean

Checks whether the local participant receives audio from a specific remote participant.

For example, if client A calls the stop method to stop receiving audio from participant B and then calls participant.audioReceivingFrom for participant B, client A receives false. This means that client A does not receive audio streams from participant B. If the participants audioTransmitting is false, then its audioReceivingFrom will also be false as the conference is unable to send down audio for a participant that is not sending their audio into the conference.

Returns: boolean


audioTransmitting

audioTransmitting(): boolean

A boolean that indicates whether the participant is transmitting audio into a conference. True indicates that the participant is sending audio; otherwise, false. The mute function does not affect this flag.

Returns: boolean