Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface of a ParticipantPropertiesPayload.

Hierarchy

  • ParticipantPropertiesPayload

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.

bShareAudioOn?: boolean

Whether the sharer is also sharing the tab's 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.

displayName?: string

User's display name.

isAllowIndividualRecording: boolean

Whether to allow individual recordings.

isHost?: boolean

Whether the user is the host.

isManager?: boolean

Whether the user is a manager.

isPhoneUser?: boolean

Whether the user joined via a phone call.

isSpeakerOnly?: boolean

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

isVideoConnect?: boolean
muted?: boolean

Whether the audio is muted.

phoneNumber?: string

The phone number if the user is a call out user. For the privacy concern, only the calling user has this property.

sharerOn?: boolean

Whether the user started sharing.

sharerPause?: boolean

Whether sharing is paused.

subsessionId?: string

Subsession ID. It's available if the user is in a subsession.

userGuid?: string

The unified ID of a user within the main session or subsessions.

userId: number

User ID.

userIdentity?: string

The user_identity from the JWT payload, not the in-session user ID.