Type Alias ZoomVideoSdkUserType

ZoomVideoSdkUserType: {
    audioStatus: ZoomVideoSdkAudioStatus;
    canSetUserVolume: (userId: string, isSharing: boolean) => Promise<boolean>;
    customUserId: string;
    getIsHost: () => Promise<boolean>;
    getIsManager: () => Promise<boolean>;
    getShareStatus: () => Promise<ShareStatus>;
    getUserName: () => Promise<string>;
    getUserReference: () => Promise<string>;
    getUserVolume: (userId: string, isSharing: boolean) => Promise<number>;
    hasIndividualRecordingConsent: (userId: string) => Promise<boolean>;
    hasMultiCamera: boolean;
    isHost: boolean;
    isManager: boolean;
    multiCameraIndex: string;
    setUserVolume: (
        userId: string,
        isSharing: boolean,
        volume: number,
    ) => Promise<boolean>;
    shareStatisticInfo: ZoomVideoSdkShareStatisticInfo;
    userId: string;
    userName: string;
    videoStatisticInfo: ZoomVideoSdkVideoStatisticInfo;
    videoStatus: ZoomVideoSdkVideoStatus;
}

Zoom Video SDK user information.

Type declaration

  • audioStatus: ZoomVideoSdkAudioStatus

    The user's audio status.

  • canSetUserVolume: (userId: string, isSharing: boolean) => Promise<boolean>

    Determine which audio you can set, shared audio or microphone.

  • customUserId: string

    User's custom identity that is passed in the JWT or in SDKSessionContext.customUserId

  • getIsHost: () => Promise<boolean>

    Determine whether the user is the host.

  • getIsManager: () => Promise<boolean>

    Determine whether the user is the manager.

  • getShareStatus: () => Promise<ShareStatus>

    Get the user's share status.

  • getUserName: () => Promise<string>

    Get the name of the user in the session.

  • getUserReference: () => Promise<string>

    Get the user's reference.

  • getUserVolume: (userId: string, isSharing: boolean) => Promise<number>

    Get user volume.

  • hasIndividualRecordingConsent: (userId: string) => Promise<boolean>

    Determine whether the user has individual recording consent.

  • hasMultiCamera: boolean

    Determine whether the user has multiple cameras.

  • isHost: boolean

    Determine whether the user is the host.

  • isManager: boolean

    Determine whether the user is the manager.

  • multiCameraIndex: string

    The index of the user's multi-camera stream.

  • setUserVolume: (userId: string, isSharing: boolean, volume: number) => Promise<boolean>

    Set the user's local volume. This does not affect how other participants hear the user.

  • shareStatisticInfo: ZoomVideoSdkShareStatisticInfo

    The user's screen share statistic information.

  • userId: string

    The userId of the user object.

  • userName: string

    User name.

  • videoStatisticInfo: ZoomVideoSdkVideoStatisticInfo

    The user's video statistic information.

  • videoStatus: ZoomVideoSdkVideoStatus

    The user video status.

Settings

Member Visibility
MMNEPVFCICPMFPCPTTAAATR