The Participant model gathers information about conference participants, such as ID, type, status, additional information about the participant, and information whether the participant is connected to the local device. It also checks whether the participant is locally active. The model also includes information about the streams that the participant uses, information about the transmitted and received audio streams, and offers a streams handler that allows accessing the streams manager.
Available in the package com.voxeet.sdk.models.Participant.
▸ isLocallyActive(): boolean
Checks if the participant is connected to the local device.
▸ getId(): String
Gets the participant's ID.
Returns: @Nullable String
▸ getInfo(): ParticipantInfo
Gets information about the current participant.
Returns: @Nullable ParticipantInfo
▸ streams(): List<MediaStream>
Gets information about participant's streams.
Returns: @NonNull List<MediaStream>
▸ streamsHandler(): ParticipantMediaStreamHandler
Accesses streams manager that allows manipulating the participant's streams.
Returns: @NonNull ParticipantMediaStreamHandler
▸ getStatus(): ConferenceParticipantStatus
Gets the current participant's status.
Returns: @NonNull ConferenceParticipantStatus
▸ participantType(): ParticipantType
Gets the participant's type.
Returns: @NonNull ParticipantType
▸ audioReceivingFrom(): boolean
For example, if client A calls the stopAudio 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.
Note: This method is available only in SDK 3.2 and next releases.
▸ audioTransmitting(): boolean
The participant's audio transmitting status modified using startAudio or stopAudio methods on the local participant. This property is true when the participant is transmitting audio to the conference. If this property is false then it indicates that the participant is muted into the conference.
Note: This property is available only in SDK 3.2 and next releases.
Updated 5 months ago