receive the privilege value when it's changed
- - client.on('chat-privilege-change', (data: { chatPrivilege: number }) => {
- console.log(data);
- // do something
- })
-receive instant messages sent from other
- - client.on('chat-on-message', data => {
- console.log(data);
- // do something
- })
-the structure of data is the same as ChatMessage
-Generated using TypeDoc
-The State of Meeting connection.
+The State of Meeting connection.
-Generated using TypeDoc
-Reason of passively stop screen share
-Privilege change or others start new sharing
-User click the stop share on the browser control bar
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Reason of passively stop screen share
+Privilege change or others start new sharing
+User click the stop share on the browser control bar
+Generated using TypeDoc
+The State of Video
+Generated using TypeDoc
+Interface of active speaker in meeting.
+Display name of user
+Identify of user
+Generated using TypeDoc
+Generated using TypeDoc
+Define error types of operations.
-closed: The meeting is not joined.on hold: You are on hold.reconnecting: The meeting is reconnecting.The result of asynchronous operation. It is a promise object.
-.catch(error=>{}) or try{ *your code* }catch(error){} to handle the errors.Generated using TypeDoc
-A MediaCompatiblity object. The object has following properties:
audio: boolean, whether the audio is compatible with the current web browser.Creates a new LocalAudioTrack to manage local audio capture
+Creates a new LocalAudioTrack to manage local audio capture
Creates a new LocalVideoTrack to start/stop local video capture and playback
+Creates a new LocalVideoTrack to start/stop local video capture and playback
Reason of the meeting closed
-kicked by host: Been kicked by the host.ended by host: The meeting is ended by the hose.expeled by host: Been expeled by the host.Reason of the meeting reconnecting
-on hold: From on hold to into meeting.failover: Remote server disconnect unexpectedly.promote|depromote: From attendee to panelist and vice versa.Occurs when some participant is start sharing screen
-client.on('active-share-change',payload=>{
- if(payload.state==='Active'){
- stream.startRenderScreenShare(payload.userId,canvas);
- }else if(payload.state==='Inactive'){
- stream.stopRenderScreenShare();
- }
-})
-Occurs when some participants in meeting are talking
-client.on('active-speaker', (payload) => {
- console.log(`Active user:`,payload);
-});
-active user
-Occurs when host ask you to unmute audio.
-the event detail
-Spotlight: Host spotlighted you, and if you are muted, you will receive the consent.Unmute: Host ask you to unmute audio.Allow to talk: You are an attendee of a webinar, the host allowed you to talk.client.on('unmute-audio-consent', (payload) => {
- console.log(payload.reason);
-});
-Occurs when the host change the privilege of chat
-the event detail
-client.on('chat-privilege-change',payload=>{
- console.log(payload.chatPrivilege);
-})
-Occurs when receive a chat
-the event detail
-client.on('chat-on-message',payload=>{
- console.log('from %s, message:%s',payload.sender.name,payload.message);
-})
-Occurs when the connection is changed.
-The event detail.
-Occurs when current audio is changed
-the event detail
-join: Join the audio. refer to the type attribute get the detail.leave: Leave the audio.muted: Audio muted, refer to the source attribute get the detail.unmuted: Audio unmuted,refer to the source attribute get the detail.phone: Join by the phone.active: User active action.passive(mute all): Muted due to the host muted all.passive(mute one): Muted due to the host muted you.passive: Umnuted due to the host unmuted you.client.on('current-audio-change', (payload) => {
- if(payload.action==='join'){
- console.log('Joined by ',payload.type);
- }
-});
-Occurs when add or remove the microphone/speaker/camera
-Occurs when the encode or decode state of media sdk changes
-Occurs when current sharing is passively stopped.
-Occurs when some participant starts or stops screen share.
-client.on('peer-share-state-change',payload=>{
- if(payload.action==='Start'){
- console.log(`user:${payload.userId} starts share`);
- }else if(payload.action==='Stop'){
- console.log(`user:${payload.userId} stops share`);
- }
-})
-Occurs when other participants start/stop video
-Occurs when received shared content automatically changed
-Occurs when shared content dimension change
-client.on('share-content-dimension-change',payload=>{
- viewportElement.style.width = `${payload.width}px`;
- viewportElement.style.height = `${payload.height}px`;
-})
-Occurs when the host change the share privilege
-Occurs when new participant join the meeting
-client.on('user-added',(payload)=>{
- // You can refresh the participants when
- const participants = client.getParticipantsList();
-})
-The event detail
-Occurs when the participants leave the meeting
-The event detail
-Occurs when the properties of the participants updated.
-The event detail
-Occurs when remote video stream changes.
-client.on('video-active-change', async(payload) => {
- try {
- if (payload.state === 'Active') {
- await stream.startRenderVideo(canvas, quality, payload.id, '');
- } else {
- await astream.stopRenderVideo();
- }
- } catch (error) {
- console.log(error);
- }
-});
-The event detail
-Occurs when local video capture stream changes.
-client.on('video-capturing-change', (payload) => {
- try {
- if (payload.state === 'Started') {
- console.log('Capture started');
- } else if (payload.state === 'Stopped') {
- console.log('Capture stopped');
- } else {
- console.log('Stop capturing Failed');
- }
- } catch (error) {
- console.log(error);
- }
-});
-The event detail
-Occurs when received video content dimension change
-client.on('video-dimension-change', payload=>{
- viewportElement.style.width = `${payload.width}px`;
- viewportElement.style.height = `${payload.height}px`;
-})
-Occurs when the SDK try to auto play audio failed. It may occur invoke stream.joinComputerAudio() immediately after join the meeting.
-client.on('auto-play-audio-failed',()=>{
- console.log('auto play audio failed, waiting user's interaction');
-})
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-'': Success.Error: Failure. Details in ErrorTypes.Error: Failure. Details in ErrorTypes.Optional. Underlying color when video is stopped,default is transparent.
[]: The video flag is false in media constraints.Array<CameraDevice>: A CameraDevice interface has following property:Get the available microphones.
-Get the available speakers.
-Pause screen share
-Required. Quality of the video. 90P/180P/360P/720P. Currently supports up to 360P
'': SuccessError: Failure. Deatils in ErrorTypes.Error: Failure. Deatils in ErrorTypes.Resume screen share
-executed promise. Following are the possible error reasons:
USER_FORBIDDEN_MICROPHONE: The user has blocked accesses to the microphone from the sdk, try to grant the privilege and rejoin the meeting.executed promise.
executed promise.
'': SuccessError: Failure. Errors besides ErrorTypes that may be returned are listed below.Error: Failure. Errors besides ErrorTypes that may be returned are listed below.CAN_NOT_DETECT_CAMERA: Cannot detect camera device.CAN_NOT_FIND_CAMERA: The provided camera device id is not included in camera device list.VIDEO_USER_FORBIDDEN_CAPTURE: The user has forbidden use camera, he/she can allow camera and rejoin the meeting.Optional. Underlying color when video is stopped,default is transparent.
'': Success.Error: Failure. Details in ErrorTypes.Error: Failure. Details in ErrorTypes.Stop screen share
-Stop render received screen share content.
-executed promise.
'': SuccessError: Failure. Details in ErrorTypes.Error: Failure. Details in ErrorTypes.The id of camera device.
'': Success.Error: Failure. Details in ErrorTypes.Error: Failure. Details in ErrorTypes.Rename your name or other participant's name
+client.isAllowToRename() get the value.if(client.isAllowToRename()){
+ await client.rename([new name]);
+}
+new display name
+rename the spcified user
+Get the in meeting users of the meeting.
+Get chat client.
+Get current user info.
+Get the media stream instance for managing the media.
+This usually the first step of using media.
+Get the user by userId.
+Get the user by userId.
+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.
+The language of Zoom Video Web SDK. Default is en-US
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}/libCDN: The dependent assets path will be https://dmogdx0jrul3u.cloudfront.net/{version}/libCN: 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 spcify the web endpoint,default is zoom.us
+Whether current user is host
+Whether current user is manager
+Join the meeting
+init method before join.A JWT, should be generated on server.
+user name
+If a password is required when joining the meeting, pass the password, otherwise omit it
+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 default false, if true, the session will end. Only the host has the privilege.
+Make other participant as the host.
+Make other participants as the manager
+Remove the event handler.
+event name
+the event handler
+Listen for the events and handle them.
+event name
+the event handler
+Details in event_connection_change.
+Details in event_user_add.
+Details in event_user_update.
+Details in event_user_remove.
+Details in event_video_active_change.
+Details in event_video_dimension_change.
+Details in event_audio_active_speaker.
+Details in event_audio_unmute_consent.
+Details in event_current_audio_change.
+Details in event_chat_received_message.
+Details in event_chat_privilege_change.
+Details in event_auto_play_audio_failed.
+Details in event_device_change.
+Details in event_video_capturing_change.
+Details in event_active_share_change.
+Details in event_share_content_dimension_change.
+Details in event_peer_share_state_change.
+Details in event_share_privilege_change.
+Details in event_passively_stop_share.
+Details in event_share_content_change.
+Details in event_peer_video_state_change.
+Remove the participant
+Revoke the manager permission from the participant
+Rename your name or other participant's name
-client.isAllowToRename() get the value.if(client.isAllowToRename()){
- await client.rename([new name]);
-}
-new display name
-rename the spcified user
-Get the in meeting users of the meeting.
-Get chat client.
-Get current user info.
-Get the media stream instance for managing the media.
-This usually the first step of using media.
-Get the user by userId.
-Get the user by userId.
-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.
-The language of Zoom Video Web SDK. Default is en-US
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}/libCDN: The dependent assets path will be https://dmogdx0jrul3u.cloudfront.net/{version}/libCN: 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 spcify the web endpoint,default is zoom.us
-Whether current user is host
-Whether current user is manager
-Join the meeting
-init method before join.A JWT, should be generated on server.
-user name
-If a password is required when joining the meeting, pass the password, otherwise omit it
-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 default false, if true, the session will end. Only the host has the privilege.
-Make other participant as the host.
-Make other participants as the manager
-Remove the event handler.
-event name
-the event handler
-Listen for the events and handle them.
-event name
-the event handler
-Details in event_connection_change.
-Details in event_user_add.
-Details in event_user_update.
-Details in event_user_remove.
-Details in event_video_active_change.
-Details in event_video_dimension_change.
-Details in event_audio_active_speaker.
-Details in event_audio_unmute_consent.
-Details in event_current_audio_change.
-Details in event_chat_received_message.
-Details in event_chat_privilege_change.
-Details in event_auto_play_audio_failed.
-Details in event_device_change.
-Details in event_video_capturing_change.
-Details in event_active_share_change.
-Details in event_share_content_dimension_change.
-Details in event_peer_share_state_change.
-Details in event_share_privilege_change.
-Details in event_passively_stop_share.
-Details in event_share_content_change.
-Details in event_peer_video_state_change.
-Remove the participant
-Revoke the manager permission from the participant
-Generated using TypeDoc
-
A series of events are exposed to indicate the status of Chat.
-