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

ParticipantInfo

The ParticipantInfo model contains information about conference participants, such as the
external ID, name, and URL of the participant's avatar.

Properties

avatarUrl

Optional avatarUrl: string

The URL of the participant's avatar.


externalId

Optional externalId: string

The external unique identifier that the customer's application can add to the participant while opening a session. If a participant uses the same external ID in conferences, the participant's ID also remains the same across all sessions. When a second participant joins a conference using the same external ID as another participant who has already joined the conference, the SDK removes the first participant who uses this external ID and emits the switched event (SDK 2.2.3+).

Note: This property is required to invite participants to a conference.


name

Optional name: string

The participant's name.


Did this page help you?