NEWDolby Interactivity APIs are now the Dolby.io Communications APIs Learn More >
X

Participant

The Participant model gathers information about the conference participant, such as:

  • The participant's ID, status, and type
  • Information about streams that the participant uses
  • Additional information about the participant
  • Information whether the participant's audio is enabled

The model also notifies about the participant's status changes.

Events

status

status(status: ParticipantStatus): void

Emitted when the participant's status changes during a conference.

Parameters:

NameTypeDescription
statusParticipantStatusThe participant's status.

Returns: void

Properties

audioTransmitting

audioTransmitting: boolean = false

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.


id

id: string

The participant's ID.


info

info: ParticipantInfo = new ParticipantInfo()

The information about the conference participant.


status

status: ParticipantStatus

The participant's status.


streams

streams: MediaStreamWithType[] = new Array<MediaStreamWithType>()

The participant's streams.


type

type: ParticipantType

The type of the participant, either listener or user.

Accessors

audio

• get audio(): boolean

The participant's audio status.

Note: The SDK 3.2 deprecates the audio accessor and replaces this accessor with audioTransmitting and audioReceivingFrom to provide more specific information about audio streams.

Returns: boolean


audioReceivingFrom

• get audioReceivingFrom(): boolean

Identifies if the local client receives audio from the asked participant. This can be modified using startAudio or stopAudio methods.

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 accessor is available only in SDK 3.2 and next releases.

Returns: boolean


Did this page help you?