Zoom Video SDK for React - v0.0.2
    Preparing search index...

    Interface Participant

    The participant interface.

    interface Participant {
        audio: "" | "computer" | "phone";
        avatar?: string;
        bShareAudioOn?: boolean;
        bShareToSubsession?: boolean;
        bVideoOn: boolean;
        bVideoShare?: boolean;
        displayName: string;
        isAllowIndividualRecording: boolean;
        isHost: boolean;
        isInFailover?: boolean;
        isManager: boolean;
        isPhoneUser?: boolean;
        isSpeakerOnly?: boolean;
        isVideoConnect: boolean;
        muted?: boolean;
        phoneNumber?: string;
        sharerOn: boolean;
        sharerPause: boolean;
        subsessionId?: string;
        userGuid?: string;
        userId: number;
        userIdentity?: string;
        userKey?: string;
    }
    Index

    Properties

    audio avatar? bShareAudioOn? bShareToSubsession? bVideoOn bVideoShare? displayName isAllowIndividualRecording isHost isInFailover? isManager isPhoneUser? isSpeakerOnly? isVideoConnect muted? phoneNumber? sharerOn sharerPause subsessionId? userGuid? userId userIdentity? userKey?

    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.

    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
    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.

    use userKey instead

    userKey?: string

    The user_key from the JWT payload.

    Settings

    Member Visibility

    On This Page

    Properties