Options
All
  • Public
  • Public/Protected
  • All
Menu

The participant interface.

Hierarchy

  • Participant

Index

Properties

audio: "" | "computer" | "phone"

User's audio state.

  • '': No audio.
  • computer: Joined by computer audio.
  • phone: Joined by phone.
avatar?: string

User's avatar. Users can set their avatar in their web profile.

bShareAudioOn?: boolean

Whether the sharer is also sharing the tab audio.

bShareToSubsession?: boolean

Whether the sharer is also sharing to the subsession.

bVideoOn: boolean

Whether the user started video.

bVideoShare?: boolean

Whether the share is optimized for video.

dialType?: string

How the phone user joined the session. Only present when the user is a phone user.

  • 'dial in': User dialed into the session.
  • 'dial out': User was invited by the session user.
displayName: string

User's display name.

isAllowIndividualRecording: boolean

Whether to allow individual recording.

isHost: boolean

Whether the user is the host.

isInFailover?: boolean

Whether the user is in a failover process.

isManager: boolean

Whether the user is a manager.

isPhoneUser?: boolean

Whether the user connected via the phone.

isSpeakerOnly?: boolean

Whether the user is only connected to the audio speaker, not the microphone.

isVideoConnect: boolean
isVoiceTranslatorOn?: boolean

Whether the voice translator is on.

muted?: boolean

Whether audio is muted. If the user is not joined to audio (not connected to the microphone), the value is undefined

phoneNumber?: string

The phone number if the user is a public switched telephone network (PSTN) call out user. For privacy concerns, only the calling user has this property.

sharerOn: boolean

Whether the user started sharing.

sharerPause: boolean

Whether the share is paused.

subsessionId?: string

Subsession ID. Available if the user is in a subsession.

userGuid?: string

The unified ID of a user among the main session or subsession.

userId: number

User ID.

userIdentity?: string

The user_identity from the JWT payload.

deprecated

use userKey instead

userKey?: string

The user_key from the JWT payload.

voiceListeningLanguage?: string

The selected listening language of the user if the voice translator is on.

voiceSpeakingLanguage?: string

The selected speaking language of the user if the voice translator is on.

voiceTimbre?: number

The selected voice timbre of the user if the voice translator is on.