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

    Interface ParticipantPropertiesPayload

    The participant properties interface.

    interface ParticipantPropertiesPayload {
        audio?: string;
        audioConnectionStatus?: number;
        avatar?: string;
        bCCEditor?: boolean;
        bCoHost: boolean;
        bHold?: boolean;
        bid?: number;
        bLocalRecord?: boolean;
        bRaiseHand?: boolean;
        bVideoOn?: boolean;
        displayName?: string;
        feedback?: number;
        isGuest?: boolean;
        isHost?: boolean;
        muted?: boolean;
        os?: number;
        reason?: "on hold" | "failover";
        sharerOn?: boolean;
        sharerPause?: boolean;
        source?: "on hold" | "failover";
        userId: number;
        userRole?: number;
        userType?: number;
        zoomID?: string;
    }
    Index

    Properties

    audio? audioConnectionStatus? avatar? bCCEditor? bCoHost bHold? bid? bLocalRecord? bRaiseHand? bVideoOn? displayName? feedback? isGuest? isHost? muted? os? reason? sharerOn? sharerPause? source? userId userRole? userType? zoomID?

    Properties

    audio?: string

    The user's audio.

    audioConnectionStatus?: number

    Participants's audio status.

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

    Avatar of the user.

    bCCEditor?: boolean

    Whether the user can edit closed captions.

    bCoHost: boolean

    Whether the user is a co-host.

    bHold?: boolean

    Whether the user is on hold.

    bid?: number

    The breakout room's ID.

    bLocalRecord?: boolean

    Whether the user is starting local recording.

    bRaiseHand?: boolean

    Whether the user's hand is raised.

    bVideoOn?: boolean

    Whether the user is starting the video.

    displayName?: string

    Display name.

    feedback?: number

    Nonverbal feedback.

    isGuest?: boolean

    Whether the user is a guest (does not belong to the same account).

    isHost?: boolean

    Whether the user is the host.

    muted?: boolean

    Whether the audio is muted.

    os?: number

    The current client's type.

    reason?: "on hold" | "failover"

    Whether the participants leave the meeting due to failover or an on hold change.

    sharerOn?: boolean

    Whether the user is starting sharing.

    sharerPause?: boolean

    Whether sharing is paused.

    source?: "on hold" | "failover"

    Whether a new user joins the meeting due to failover or an on hold change.

    userId: number

    The user's ID.

    userRole?: number

    The user's role.

    userType?: number

    The type of user:

    • 9: Client
    • 5: Phone
    • 15: H323 device
    zoomID?: string

    The internal ID.

    Settings

    Member Visibility

    On This Page

    Properties