• Public
  • Public/Protected
  • All

Namespace VideoClient




  • Rename your name or other participant's name

    • Only the host or manager can rename others.
    • The host can set whether the participants are allowed to rename themselves. refer to the client.isAllowToRename() get the value.
     await client.rename([new name]);


    • name: string

      new display name

    • Optional userId: number

      rename the spcified user

    Returns ExecutedResult


  • Get the in meeting users of the meeting.

    Returns Participant[]




  • getMediaStream(): typeof Stream
  • Get the media stream instance for managing the media.

    This usually the first step of using media.

    Returns typeof Stream



  • Get the user by userId.


    • userId: number

    Returns Participant | undefined


  • init(language: string, dependentAssets: string | "CDN" | "Global" | "CN", webEndpoint?: string): ExecutedResult
  • Initilize the ZOOM Video SDK before join a meeting. The ZOOM Video SDK uses an SDK key & Secret for authentication. Login to the Zoom Marketplace and Create a JWT App to get SDK keys & Secrets.


    • language: string

      The language of Zoom Video Web SDK. Default is en-US

    • dependentAssets: string | "CDN" | "Global" | "CN"

      In the ZOOM Video SDK, web workers and web assembly are used to process media stream. This part of the code is separated from the SDK, so it is necessary to specify the dependent assets path. When the SDK is released, the web worker and the web assembly will be also included(the lib folder), you can either deploy these assets to your private servers or use the cloud assets provided by ZOOM. The property has following value:

      • Global: The default value. The dependent assets path will be https://source.zoom.us/{version}/lib
      • CDN: The dependent assets path will be https://dmogdx0jrul3u.cloudfront.net/{version}/lib
      • CN: Only applicable for China. The dependent assets path will be https://jssdk.zoomus.cn/{version}/lib
      • {FULL_ASSETS_PATH}: The SDK will load the dependent assets spcified by the developer.
    • Optional webEndpoint: string

      optional spcify the web endpoint,default is zoom.us

    Returns ExecutedResult


  • isHost(): boolean
  • Whether current user is host

    Returns boolean


  • isManager(): boolean
  • Whether current user is manager

    Returns boolean


  • join(topic: string, token: string, userName: string, password?: string): ExecutedResult
  • Join the meeting

    • Make sure call init method before join.


    • topic: string
    • token: string

      A JWT, should be generated on server.

    • userName: string

      user name

    • Optional password: string

      If a password is required when joining the meeting, pass the password, otherwise omit it

    Returns ExecutedResult

    a executed promise. Following are the possible error reasons:

    • duplicated operation: Duplicated invoke the join method.
    • invalid apiKey or signature: ApiKey or signature is not correct.
    • invalid password: Password is not correct.
    • meeting is not started: The meeting is not started. If you are the host of the meeting, you can start the meeting.
    • meeting is locked: The meeting is locked by the host, can not join the meeting.
    • meeting is at capacity: The meeting is at capacity.
    • meeting is ended: The meeting is already ended.
    • rejected by information barrier: Can not join the meeting because og the information barrier.
    • rejected by existed participant: Can not join the meeting because another client using the account is already in the meeting.
    • invalid parameters: Can not join the meeting because the invalid parameters.
    • rejected by been denied: Can not join the meeting because the host has expeled you.
    • internal error: Internal error.


  • Leave the meeting


    • Optional end: boolean

      optional default false, if true, the session will end. Only the host has the privilege.

    Returns ExecutedResult


  • Make other participant as the host.

    • Only the host can make host.
    • There is only one host in the meeting. Once make other as the host, the original host is not the meeting host.


    • userId: number

    Returns ExecutedResult


  • Make other participants as the manager

    • Only the host can make manager.
    • There may be multiple managers in session.


    • userId: number

    Returns ExecutedResult


  • off(event: string, callback: (payload: any) => void): void
  • Remove the event handler.


    • event: string

      event name

    • callback: (payload: any) => void

      the event handler

        • (payload: any): void
        • Parameters

          • payload: any

          Returns void

    Returns void



  • Remove the participant

    • Only the host or manager can remove others.


    • userId: number

    Returns ExecutedResult


  • Revoke the manager permission from the participant

    • Only the host can revoke Manager.


    • userId: number

    Returns ExecutedResult

Generated using TypeDoc