VideoClient | Zoom Video SDK for Web

The video client is the core of the Video SDK.

Functions

changeName

changeName(name: string, userId?: number): ExecutedResult

Renames your name or another user's name.
- Only the host or manager can rename others.
- The host can set whether the user is allowed to rename themselves. See client.isAllowToRename() to get the value.
Parameters
- name: string
  
  New display name.
- Optional userId: number
  
  User ID of the user to rename.
Returns ExecutedResult

getAllUser

getAllUser(): Participant[]

Get the in session users of the session.

Returns Participant[]

getChatClient

getChatClient(): typeof ChatClient

Gets chat client.

Returns typeof ChatClient

getCommandClient

getCommandClient(): typeof CommandChannel

Gets command client.

Returns typeof CommandChannel

getCurrentUserInfo

getCurrentUserInfo(): Participant

Get current user info.

Returns Participant

getLiveTranscriptionClient

getLiveTranscriptionClient(): typeof LiveTranscriptionClient

Get LiveTranscription client

Returns typeof LiveTranscriptionClient

getMediaStream

getMediaStream(): typeof Stream

Gets the media stream instance for managing the media.

This usually the first step of using media.

Returns typeof Stream

getRecordingClient

getRecordingClient(): typeof RecordingClient

Gets recording client.

Returns typeof RecordingClient

getSessionHost

getSessionHost(): Participant | undefined

Gets the host of the session.

Returns Participant | undefined

getSessionInfo

getSessionInfo(): SessionInfo

Gets the current session’s information.

Returns SessionInfo

getSubsessionClient

getSubsessionClient(): typeof SubsessionClient

Gets subsession client.

Returns typeof SubsessionClient

getUser

getUser(userId: number): Participant | undefined

Gets the user by user ID.

Parameters
- userId: number
Returns Participant | undefined

init

init(language: string, dependentAssets: string | "CDN" | "Global" | "CN", options?: InitOptions): ExecutedResult

Initialize the Zoom Video SDK before join a session. The Zoom Video SDK uses an SDK key & secret for authentication.

Parameters
- language: string
  
  The language of the Video SDK. The default is en-US.
- dependentAssets: string | "CDN" | "Global" | "CN"
  In the Zoom Video SDK, web workers and web assembly are used to process the 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/videosdk/{version}/lib/
  - CDN: The dependent assets path will be https://dmogdx0jrul3u.cloudfront.net/videosdk/{version}/lib/
  - CN: Only applicable for China. The dependent assets path will be https://jssdk.zoomus.cn/videosdk/{version}/lib
  - {FULL_ASSETS_PATH}: The SDK will load the dependent assets specified by the developer.
- Optional options: InitOptions
  
  Optional additional options for initialization.
Returns ExecutedResult

isHost

isHost(): boolean

Determines whether the current user is the host.

Returns boolean

isManager

isManager(): boolean

Determines whether the current user is a manager.

Returns boolean

join

join(topic: string, token: string, userName: string, password?: string, sessionIdleTimeoutMins?: number): ExecutedResult

Join the session
- Make sure to call the init method before joining.
Parameters
- 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 session, pass the password, otherwise omit it.
- Optional sessionIdleTimeoutMins: number
  
  Idle timeout to end the session.
Returns ExecutedResult

an executed promise. Following are the possible error reasons:
- duplicated operation: Duplicated invoking of the join method.
- invalid apiKey/sdkKey or signature: API key, SDK key, or signature is not correct.
- invalid password: Password is not correct.
- invalid parameters: Can not join the session because of invalid parameters.
- internal error: Internal error.

leave

leave(end?: boolean): ExecutedResult

Leaves or ends the session.

Parameters
- Optional end: boolean
  
  Optional. Default is false. If true, the session ends. Only the host has the privilege to do this.
Returns ExecutedResult

makeHost

makeHost(userId: number): ExecutedResult

Makes other participant the host.
- Only the host can make someone else the host.
- There is only one host in a session. Once the host makes another user the host, the original host will no longer be the host.
Parameters
- userId: number
Returns ExecutedResult

makeManager

makeManager(userId: number): ExecutedResult

Makes another participant a manager.
- Only the host can make others into managers.
- There may be multiple managers in session.
Parameters
- userId: number
Returns ExecutedResult

off

off(event: string, callback: (payload: any) => void): void

Remove the event handler.

Parameters
- event: string
  
  Event name.
- callback: (payload: any) => void
  
  The event handler.
  - - (payload: any): void
    - Parameters
      - payload: any
      Returns void
Returns void

on

on(event: string, callback: (payload: any) => void): void
on(event: "connection-change", listener: typeof event_connection_change): void
on(event: "user-added", listener: typeof event_user_add): void
on(event: "user-updated", listener: typeof event_user_update): void
on(event: "user-removed", listener: typeof event_user_remove): void
on(event: "video-active-change", listener: typeof event_video_active_change): void
on(event: "video-dimension-change", listener: typeof event_video_dimension_change): void
on(event: "active-speaker", listener: typeof event_audio_active_speaker): void
on(event: "host-ask-unmute-audio", listener: typeof event_host_ask_unmute_audio): void
on(event: "current-audio-change", listener: typeof event_current_audio_change): void
on(event: "dialout-state-change", listener: typeof event_dial_out_change): void
on(event: "audio-statistic-data-change", listener: typeof event_audio_statistic_data_change): void
on(event: "video-statistic-data-change", listener: typeof event_video_statistic_data_change): void
on(event: "chat-on-message", listener: typeof event_chat_received_message): void
on(event: "chat-privilege-change", listener: typeof event_chat_privilege_change): void
on(event: "command-channel-status", listener: typeof event_command_channel_status): void
on(event: "command-channel-message", listener: typeof event_command_channel_message): void
on(event: "recording-change", listener: typeof event_recording_change): void
on(event: "individual-recording-change", listener: typeof event_individual_recording_change): void
on(event: "auto-play-audio-failed", listener: typeof event_auto_play_audio_failed): void
on(event: "device-change", listener: typeof event_device_change): void
on(event: "video-capturing-change", listener: typeof event_video_capturing_change): void
on(event: "active-share-change", listener: typeof event_active_share_change): void
on(event: "share-content-dimension-change", listener: typeof event_share_content_dimension_change): void
on(event: "peer-share-state-change", listener: typeof event_peer_share_state_change): void
on(event: "share-privilege-change", listener: typeof event_share_privilege_change): void
on(event: "passively-stop-share", listener: typeof event_passively_stop_share): void
on(event: "share-content-change", listener: typeof event_share_content_change): void
on(event: "peer-video-state-change", listener: typeof event_peer_video_state_change): void
on(event: "share-audio-change", listener: typeof event_share_audio_change): void
on(event: "subsession-invite-to-join", listener: typeof event_bo_invite_to_join): void
on(event: "subsession-countdown", listener: typeof event_bo_room_countdown): void
on(event: "subsession-time-up", listener: typeof event_bo_room_time_up): void
on(event: "closing-subsession-countdown", listener: typeof event_bo_closing_room_countdown): void
on(event: "subsession-broadcast-message", listener: typeof event_bo_broadcast_message): void
on(event: "subsession-ask-for-help", listener: typeof event_bo_ask_for_help): void
on(event: "subsession-ask-for-help-response", listener: typeof event_bo_ask_for_help_response): void
on(event: "subsession-state-change", listener: typeof event_bo_room_state_change): void
on(event: "main-session-user-updated", listener: typeof event_bo_main_session_change): void
on(event: "video-virtual-background-preload-change", listener: typeof event_video_vb_preload_change): void
on(event: "media-sdk-change", listener: typeof event_media_sdk_change): void
on(event: "video-detailed-data-change", listener: typeof event_video_cell_detailed_change): void
on(event: "caption-status", listener: typeof event_caption_status): void
on(event: "caption-message", listener: typeof event_caption_message): void
on(event: "caption-enable", listener: typeof event_caption_enable): void
on(event: "share-can-see-screen", listener: typeof event_share_can_see_screen): void
on(event: "far-end-camera-request-control", listener: typeof event_far_end_camera_request): void
on(event: "far-end-camera-response-control", listener: typeof event_far_end_camera_response): void
on(event: "far-end-camera-in-control-change", listener: typeof event_far_end_camera_in_control_change): void
on(event: "far-end-camera-capability-change", listener: typeof event_far_end_camera_capability_change): void
on(event: "network-quality-change", listener: typeof event_network_quality_change): void

Listens for events and handles them.

Parameters
- event: string
  
  Event name.
- callback: (payload: any) => void
  
  Ehe event handler.
  - - (payload: any): void
    - Parameters
      - payload: any
      Returns void
Returns void
Parameters
- event: "connection-change"
- listener: typeof event_connection_change
  
  Details in event_connection_change.
Returns void
Parameters
- event: "user-added"
- listener: typeof event_user_add
  
  Details in event_user_add.
Returns void
Parameters
- event: "user-updated"
- listener: typeof event_user_update
  
  Details in event_user_update.
Returns void
Parameters
- event: "user-removed"
- listener: typeof event_user_remove
  
  Details in event_user_remove.
Returns void
Parameters
- event: "video-active-change"
- listener: typeof event_video_active_change
  
  Details in event_video_active_change.
Returns void
Parameters
- event: "video-dimension-change"
- listener: typeof event_video_dimension_change
  
  Details in event_video_dimension_change.
Returns void
Parameters
- event: "active-speaker"
- listener: typeof event_audio_active_speaker
  
  Details in event_audio_active_speaker.
Returns void
Parameters
- event: "host-ask-unmute-audio"
- listener: typeof event_host_ask_unmute_audio
  
  Details in {@link event_audio_unmute_consent}.
Returns void
Parameters
- event: "current-audio-change"
- listener: typeof event_current_audio_change
  
  Details in event_current_audio_change.
Returns void
Parameters
- event: "dialout-state-change"
- listener: typeof event_dial_out_change
  
  Details in event_dial_out_change.
Returns void
Parameters
- event: "audio-statistic-data-change"
- listener: typeof event_audio_statistic_data_change
  
  Detail in event_audio_statistic_data_change.
Returns void
Parameters
- event: "video-statistic-data-change"
- listener: typeof event_video_statistic_data_change
  
  Detail in event_video_statistic_data_change.
Returns void
Parameters
- event: "chat-on-message"
- listener: typeof event_chat_received_message
  
  Details in event_chat_received_message.
Returns void
Parameters
- event: "chat-privilege-change"
- listener: typeof event_chat_privilege_change
  
  Details in event_chat_privilege_change.
Returns void
Parameters
- event: "command-channel-status"
- listener: typeof event_command_channel_status
  
  Details in event_command_channel_status.
Returns void
Parameters
- event: "command-channel-message"
- listener: typeof event_command_channel_message
  
  Details in event_command_channel_message.
Returns void
Parameters
- event: "recording-change"
- listener: typeof event_recording_change
  
  Details in event_recording_change.
Returns void
Parameters
- event: "individual-recording-change"
- listener: typeof event_individual_recording_change
  
  Details in {@link event_iso_recording_change}.
Returns void
Parameters
- event: "auto-play-audio-failed"
- listener: typeof event_auto_play_audio_failed
  
  Details in event_auto_play_audio_failed.
Returns void
Parameters
- event: "device-change"
- listener: typeof event_device_change
  
  Details in event_device_change.
Returns void
Parameters
- event: "video-capturing-change"
- listener: typeof event_video_capturing_change
  
  Details in event_video_capturing_change.
Returns void
Parameters
- event: "active-share-change"
- listener: typeof event_active_share_change
  
  Details in event_active_share_change.
Returns void
Parameters
- event: "share-content-dimension-change"
- listener: typeof event_share_content_dimension_change
  
  Details in event_share_content_dimension_change.
Returns void
Parameters
- event: "peer-share-state-change"
- listener: typeof event_peer_share_state_change
  
  Details in event_peer_share_state_change.
Returns void
Parameters
- event: "share-privilege-change"
- listener: typeof event_share_privilege_change
  
  Details in event_share_privilege_change.
Returns void
Parameters
- event: "passively-stop-share"
- listener: typeof event_passively_stop_share
  
  Details in event_passively_stop_share.
Returns void
Parameters
- event: "share-content-change"
- listener: typeof event_share_content_change
  
  Details in event_share_content_change.
Returns void
Parameters
- event: "peer-video-state-change"
- listener: typeof event_peer_video_state_change
  
  Details in event_peer_video_state_change.
Returns void
Parameters
- event: "share-audio-change"
- listener: typeof event_share_audio_change
  
  Details inevent_share_audio_change
Returns void
Parameters
- event: "subsession-invite-to-join"
- listener: typeof event_bo_invite_to_join
  
  Details in event_bo_invite_to_join.
Returns void
Parameters
- event: "subsession-countdown"
- listener: typeof event_bo_room_countdown
  
  Details in event_bo_room_countdown.
Returns void
Parameters
- event: "subsession-time-up"
- listener: typeof event_bo_room_time_up
  
  Details in event_bo_room_time_up.
Returns void
Parameters
- event: "closing-subsession-countdown"
- listener: typeof event_bo_closing_room_countdown
  
  Details in event_bo_closing_room_countdown.
Returns void
Parameters
- event: "subsession-broadcast-message"
- listener: typeof event_bo_broadcast_message
  
  Details in event_bo_broadcast_message.
Returns void
Parameters
- event: "subsession-ask-for-help"
- listener: typeof event_bo_ask_for_help
  
  Details in event_bo_ask_for_help.
Returns void
Parameters
- event: "subsession-ask-for-help-response"
- listener: typeof event_bo_ask_for_help_response
  
  Details in event_bo_ask_for_help_response.
Returns void
Parameters
- event: "subsession-state-change"
- listener: typeof event_bo_room_state_change
  
  Details in event_bo_room_state_change.
Returns void
Parameters
- event: "main-session-user-updated"
- listener: typeof event_bo_main_session_change
  
  Details in event_bo_main_session_change.
Returns void
Parameters
- event: "video-virtual-background-preload-change"
- listener: typeof event_video_vb_preload_change
  
  Details in event_video_vb_preload_change
Returns void
Parameters
- event: "media-sdk-change"
- listener: typeof event_media_sdk_change
  
  Details in event_media_sdk_change
Returns void
Parameters
- event: "video-detailed-data-change"
- listener: typeof event_video_cell_detailed_change
  
  Details in event_video_cell_detailed_change
Returns void
Parameters
- event: "caption-status"
- listener: typeof event_caption_status
  
  Details in event_caption_status
Returns void
Parameters
- event: "caption-message"
- listener: typeof event_caption_message
  
  Details in event_caption_message
Returns void
Parameters
- event: "caption-enable"
- listener: typeof event_caption_enable
  
  Details in event_caption_enable
Returns void
Parameters
- event: "share-can-see-screen"
- listener: typeof event_share_can_see_screen
  
  Details in event_share_can_see_screen
Returns void
Parameters
- event: "far-end-camera-request-control"
- listener: typeof event_far_end_camera_request
  
  Details in event_far_end_camera_request
Returns void
Parameters
- event: "far-end-camera-response-control"
- listener: typeof event_far_end_camera_response
  
  Details in event_far_end_camera_response
Returns void
Parameters
- event: "far-end-camera-in-control-change"
- listener: typeof event_far_end_camera_in_control_change
  
  Details in event_far_end_camera_in_control_change
Returns void
Parameters
- event: "far-end-camera-capability-change"
- listener: typeof event_far_end_camera_capability_change
  
  Details in event_far_end_camera_capability_change
Returns void
Parameters
- event: "network-quality-change"
- listener: typeof event_network_quality_change
  
  Details in event_network_quality_change
Returns void

removeUser

removeUser(userId: number): ExecutedResult

Removes the participant.
- Only the host or manager can remove others.
Parameters
- userId: number
Returns ExecutedResult

revokeManager

revokeManager(userId: number): ExecutedResult

Revokes the manager permission from the participant.
- Only the host can revoke manager permissions.
Parameters
- userId: number
Returns ExecutedResult

Index

Functions

Functions

changeName

Parameters

name: string

Optional userId: number

Returns ExecutedResult

getAllUser

Returns Participant[]

getChatClient

Returns typeof ChatClient

getCommandClient

Returns typeof CommandChannel

getCurrentUserInfo

Returns Participant

getLiveTranscriptionClient

Returns typeof LiveTranscriptionClient

getMediaStream

Returns typeof Stream

getRecordingClient

Returns typeof RecordingClient

getSessionHost

Returns Participant | undefined

getSessionInfo

Returns SessionInfo

getSubsessionClient

Returns typeof SubsessionClient

getUser

Parameters

userId: number

Returns Participant | undefined

init

Parameters

language: string

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

Optional options: InitOptions

Returns ExecutedResult

isHost

Returns boolean

isManager

Returns boolean

join

Parameters

topic: string

token: string

userName: string

Optional password: string

Optional sessionIdleTimeoutMins: number

Returns ExecutedResult

leave

Parameters

Optional end: boolean

Returns ExecutedResult

makeHost

Parameters

userId: number

Returns ExecutedResult

makeManager

Parameters

userId: number

Returns ExecutedResult

off

Parameters

event: string

callback: (payload: any) => void

Parameters

payload: any

Returns void

Returns void

on

Parameters

event: string

callback: (payload: any) => void

Parameters

payload: any

Returns void

Returns void

Parameters

event: "connection-change"