Participant
The Participant model contains information about a conference participant.
Events
status
• status(status
: ParticipantStatus): void
Emitted when the participant's status changes during a conference.
Parameters:
Name | Type | Description |
---|---|---|
status | ParticipantStatus | The participant's status. |
Returns: void
Properties
audioTransmitting
• audioTransmitting: boolean = false
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.
id
• id: string
The participant ID.
info
• info: ParticipantInfo = new ParticipantInfo()
Information about the conference participant.
status
• status: ParticipantStatus
The participant status.
streams
• streams: MediaStreamWithType[] = new Array<MediaStreamWithType>()
The participant's streams.
type
• type: ParticipantType
The participant type.
videoTransmitting
• videoTransmitting: boolean = false
The status of video transmission.
For the local participant, true indicates that the local participant's video is transmitted to a conference. For a remote participant, true indicates that the remote participant's video is transmitted to the local client.
Note: This property is available only in SDK 3.8 and next releases.
Accessors
audioReceivingFrom
• get 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
Updated 4 months ago