Participant interface.

interface Participant {
    astAdmin?: boolean;
    audio: string;
    audioConnectionStatus?: number;
    audioStatus?: number;
    avatar: string;
    bHold: boolean;
    bLocalRecord?: boolean;
    bRaiseHand: boolean;
    bVideoConnect?: boolean;
    bVideoOn: boolean;
    customerKey?: string;
    displayName: string;
    feedback: number;
    isAdmin?: boolean;
    isAllowToTalk?: boolean;
    isAssistant?: boolean;
    isCoHost: boolean;
    isGuest: boolean;
    isHold: boolean;
    isHost: boolean;
    isPhoneUser: boolean;
    isVideoConnect?: boolean;
    muted: boolean;
    participantUUID?: string;
    pronoun?: string;
    rmcAdmin?: boolean;
    sharePause: boolean;
    sharerOn: boolean;
    strPronoun?: string;
    userGuid?: string;
    userId: number;
    userName: string;
    video: boolean;
}

Properties

astAdmin?: boolean

Deprecated

in v4.0.0, use isAssistant

audio: string

User's audio state.

  • '': No audio.
  • computer: Joined by computer audio.
  • phone: Joined by phone.
audioConnectionStatus?: number

Deprecated

in v4.0.0, use audioStatus

audioStatus?: number

Participants's audio status.

  • 0: NotConnect,
  • 1: Connecting,
  • 2: ConnectSuccess,
  • 3: ConnectFail,
avatar: string

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

bHold: boolean

Deprecated

in v4.0.0, use isHold

bLocalRecord?: boolean

Whether the participant started local recording (such as on computer).

bRaiseHand: boolean

Whether the user has raised their hand.

bVideoConnect?: boolean

Deprecated

in v4.0.0, use isVideoConnect

bVideoOn: boolean

Deprecated

in v4.0.0, use video

customerKey?: string

Optional. An identifier for the user that you can get back from the Meeting API.

displayName: string

Deprecated

in v4.0.0, use userName

feedback: number

Nonverbal feedback of a user.

isAdmin?: boolean
isAllowToTalk?: boolean

Whether the user is allowed to talk. Available in webinars.

isAssistant?: boolean
isCoHost: boolean

Whether the user is a co-host.

isGuest: boolean

Whether the user is a guest (not attached to the account).

isHold: boolean

Whether the user is on hold.

isHost: boolean

Whether the user is the host.

isPhoneUser: boolean

Whether the user is a phone call user.

isVideoConnect?: boolean

Whether video is connected.

muted: boolean

Whether audio is muted.

participantUUID?: string

participantUUID

pronoun?: string

User pronoun

rmcAdmin?: boolean

Deprecated

in v4.0.0, use isAdmin

sharePause: boolean

Whether the share is paused.

sharerOn: boolean

Whether the user has started sharing.

strPronoun?: string

Deprecated

in v4.0.0, use pronoun

userGuid?: string

Deprecated

in v4.0.0, use participantUUID

userId: number

User's unique ID.

userName: string

User's display name.

video: boolean

Whether the user started video.