Class ZoomVideoSdkUser

Implements

Constructors

constructor

Properties

audioStatus customUserId hasMultiCamera isHost isManager multiCameraIndex shareStatisticInfo userId userName videoStatisticInfo videoStatus

Methods

canSetUserVolume getIsHost getIsManager getShareStatus getUserName getUserReference getUserVolume hasIndividualRecordingConsent setUserVolume

Constructors

constructor

Properties

audioStatus

audioStatus: ZoomVideoSdkAudioStatus

The user's audio status.

customUserId

customUserId: string

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

hasMultiCamera

hasMultiCamera: boolean

Determine whether the user has multiple cameras.

isHost

isHost: boolean

Determine whether the user is the host.

isManager

isManager: boolean

Determine whether the user is the manager.

multiCameraIndex

multiCameraIndex: string

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

shareStatisticInfo

shareStatisticInfo: ZoomVideoSdkShareStatisticInfo

The user's screen share statistic information.

userId

userId: string

The userId of the user object.

userName

userName: string

User name.

videoStatisticInfo

videoStatisticInfo: ZoomVideoSdkVideoStatisticInfo

The user's video statistic information.

videoStatus

videoStatus: ZoomVideoSdkVideoStatus

The user video status.

Methods

canSetUserVolume

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

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

    Parameters

    • userId: string
    • isSharing: boolean

    Returns Promise<any>

getIsHost

  • getIsHost(): Promise<any>

    Determine whether the user is the host.

    Returns Promise<any>

getIsManager

  • getIsManager(): Promise<any>

    Determine whether the user is the manager.

    Returns Promise<any>

getShareStatus

  • getShareStatus(): Promise<any>

    Get the user's share status.

    Returns Promise<any>

getUserName

  • getUserName(): Promise<any>

    Get the name of the user in the session.

    Returns Promise<any>

getUserReference

  • getUserReference(): Promise<any>

    Get the user's reference.

    Returns Promise<any>

getUserVolume

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

    Get user volume.

    Parameters

    • userId: string
    • isSharing: boolean

    Returns Promise<any>

hasIndividualRecordingConsent

  • hasIndividualRecordingConsent(userId: string): Promise<any>

    Determine whether the user has individual recording consent.

    Parameters

    • userId: string

    Returns Promise<any>

setUserVolume

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

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

    Parameters

    • userId: string
    • isSharing: boolean
    • volume: number

    Returns Promise<any>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR