Zoom Meeting SDK for Web - Component View
    Preparing search index...

    Interface Participant

    Participant interface.

    interface Participant {
        astAdmin?: boolean;
        audio: string;
        audioConnectionStatus?: number;
        audioStatus?: number;
        avatar: string;
        bHold: boolean;
        bLocalRecord?: boolean;
        botAuthorizerName?: string;
        botBrandName?: string;
        bRaiseHand: boolean;
        bVideoConnect?: boolean;
        bVideoOn: boolean;
        customerKey?: string;
        displayName: string;
        feedback: number;
        isAdmin?: boolean;
        isAllowToTalk?: boolean;
        isAssistant?: boolean;
        isBotUser?: 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;
    }
    Index

    Properties

    astAdmin? audio audioConnectionStatus? audioStatus? avatar bHold bLocalRecord? botAuthorizerName? botBrandName? bRaiseHand bVideoConnect? bVideoOn customerKey? displayName feedback isAdmin? isAllowToTalk? isAssistant? isBotUser? isCoHost isGuest isHold isHost isPhoneUser isVideoConnect? muted participantUUID? pronoun? rmcAdmin? sharePause sharerOn strPronoun? userGuid? userId userName video

    Properties

    astAdmin?: boolean

    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

    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

    in v4.0.0, use isHold

    bLocalRecord?: boolean

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

    botAuthorizerName?: string

    Authorizer name of the bot, if applicable

    botBrandName?: string

    Brand name of the bot, if applicable

    bRaiseHand: boolean

    Whether the user has raised their hand.

    bVideoConnect?: boolean

    in v4.0.0, use isVideoConnect

    bVideoOn: boolean

    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

    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
    isBotUser?: boolean

    Whether the participant is a bot user

    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

    in v4.0.0, use isAdmin

    sharePause: boolean

    Whether the share is paused.

    sharerOn: boolean

    Whether the user has started sharing.

    strPronoun?: string

    in v4.0.0, use pronoun

    userGuid?: string

    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.

    Settings

    Member Visibility

    On This Page

    Properties