zoom_meeting_video

Zoom Meeting Video

Description:

Zoom Meeting Video

Source:

zoom_meeting_video.js, line 6

Parameters:

Name	Type	Description
`onUserVideoStatusChange`	function	Callback event of the user video status changes.
`onActiveSpeakerVideoUserChanged`	function	Callback event of the active speaker video user changes.
`onActiveVideoUserChanged`	function	Callback event of the active video user changes.

Returns:

Type: ZoomMeetingVideo

Description:

Zoom Meeting Video

Source:

zoom_meeting_video.js, line 6

Parameters:

Name	Type	Description
`onUserVideoStatusChange`	function	Callback event of the user video status changes.
`onActiveSpeakerVideoUserChanged`	function	Callback event of the active speaker video user changes.
`onActiveVideoUserChanged`	function	Callback event of the active video user changes.

Returns:

Type: ZoomMeetingVideo

Methods

(inner) MeetingVideo_HideOrShowNoVideoUserOnVideoWall(bHide) → {Number}

Description:

Display or not the user who does not turn on the video in the video all mode.

Source:

zoom_meeting_video.js, line 199

Parameters:

Name	Type	Description
`bHide`	Boolean	bHide or not

Returns:

TRUE indicates to hide, FALSE show. Otherwise failed. To get extended error information, Defined in: ZoomSDKError

Type: Number

(inner) MeetingVideo_HideOrShowNoVideoUserOnVideoWall(bHide) → {Number}

Description:

Display or not the user who does not turn on the video in the video all mode.

Source:

zoom_meeting_video.js, line 199

Parameters:

Name	Type	Description
`bHide`	Boolean	bHide or not

Returns:

TRUE indicates to hide, FALSE show. Otherwise failed. To get extended error information, Defined in: ZoomSDKError

Type: Number

(inner) MeetingVideo_MuteVideo(userid) → {Number}

Description:

Turn off the user's own video.

Source:

zoom_meeting_video.js, line 103

Parameters:

Name	Type	Description
`userid`	Number	Specifies which the user's video to mute

Returns:

If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError

Type: Number

(inner) MeetingVideo_MuteVideo(userid) → {Number}

Description:

Turn off the user's own video.

Source:

zoom_meeting_video.js, line 103

Parameters:

Name	Type	Description
`userid`	Number	Specifies which the user's video to mute

Returns:

If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError

Type: Number

(inner) MeetingVideo_PinVideo(bPin, bFirstView, userid) → {Number}

Description:

pin video

Source:

zoom_meeting_video.js, line 147

Parameters:

Name	Type	Description
`bPin`	Boolean	bPin or not
`bFirstView`	Boolean	bFirstView or not
`userid`	Number	Specifies which the user's video to pin

Returns:

Defined in: ZoomSDKError

Type: Number

(inner) MeetingVideo_PinVideo(bPin, bFirstView, userid) → {Number}

Description:

pin video

Source:

zoom_meeting_video.js, line 147

Parameters:

Name	Type	Description
`bPin`	Boolean	bPin or not
`bFirstView`	Boolean	bFirstView or not
`userid`	Number	Specifies which the user's video to pin

Returns:

Defined in: ZoomSDKError

Type: Number

(inner) MeetingVideo_SetActiveSpeakerVideoUserChangedCB(onActiveSpeakerVideoUserChanged) → {Boolean}

Description:

Set callback function of notification of the active speaker video user changes.

Source:

zoom_meeting_video.js, line 77

Parameters:

Name	Type	Description
`onActiveSpeakerVideoUserChanged`	function

Returns:

Type: Boolean

(inner) MeetingVideo_SetActiveSpeakerVideoUserChangedCB(onActiveSpeakerVideoUserChanged) → {Boolean}

Description:

Set callback function of notification of the active speaker video user changes.

Source:

zoom_meeting_video.js, line 77

Parameters:

Name	Type	Description
`onActiveSpeakerVideoUserChanged`	function

Returns:

Type: Boolean

(inner) MeetingVideo_SetActiveVideoUserChangedCB(onActiveVideoUserChanged) → {Boolean}

Description:

Set callback function of notification of the active video user changes.

Source:

zoom_meeting_video.js, line 90

Parameters:

Name	Type	Description
`onActiveVideoUserChanged`	function

Returns:

Type: Boolean

(inner) MeetingVideo_SetActiveVideoUserChangedCB(onActiveVideoUserChanged) → {Boolean}

Description:

Set callback function of notification of the active video user changes.

Source:

zoom_meeting_video.js, line 90

Parameters:

Name	Type	Description
`onActiveVideoUserChanged`	function

Returns:

Type: Boolean

(inner) MeetingVideo_SetMeetingVideoStatusCB(onUserVideoStatusChange) → {Boolean}

Description:

Set callback function of notification of the user video status changes.

Source:

zoom_meeting_video.js, line 64

Parameters:

Name	Type	Description
`onUserVideoStatusChange`	function

Returns:

Type: Boolean

(inner) MeetingVideo_SetMeetingVideoStatusCB(onUserVideoStatusChange) → {Boolean}

Description:

Set callback function of notification of the user video status changes.

Source:

zoom_meeting_video.js, line 64

Parameters:

Name	Type	Description
`onUserVideoStatusChange`	function

Returns:

Type: Boolean

(inner) MeetingVideo_SetVideoQualityPreference(mode, minimumFrameRate, minimumFrameRate) → {Number}

Description:

Set the video quality preference that automatically adjust user's video to prioritize frame rate versus resolution based on the current bandwidth available.

Source:

zoom_meeting_video.js, line 221

Parameters:

Name	Type	Description
`mode`	Number	Defined in: SDKVideoPreferenceMode
`minimumFrameRate`	Number	0 for the default value,minimum_frame_rate should be less than maximum_frame_rate, range: from 0 to 30 .out of range for frame-rate will use default frame-rate of Zoom
`minimumFrameRate`	Number	0 for the default value,maximum_frame_rate should be less and equal than 30, range: from 0 to 30.out of range for frame-rate will use default frame-rate of Zoom

Returns:

If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError

Type: Number

(inner) MeetingVideo_SetVideoQualityPreference(mode, minimumFrameRate, minimumFrameRate) → {Number}

Description:

Set the video quality preference that automatically adjust user's video to prioritize frame rate versus resolution based on the current bandwidth available.

Source:

zoom_meeting_video.js, line 221

Parameters:

Name	Type	Description
`mode`	Number	Defined in: SDKVideoPreferenceMode
`minimumFrameRate`	Number	0 for the default value,minimum_frame_rate should be less than maximum_frame_rate, range: from 0 to 30 .out of range for frame-rate will use default frame-rate of Zoom
`minimumFrameRate`	Number	0 for the default value,maximum_frame_rate should be less and equal than 30, range: from 0 to 30.out of range for frame-rate will use default frame-rate of Zoom

Returns:

If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError

Type: Number

(inner) MeetingVideo_SpotlightVideo(bSpotlight, userid) → {Number}

Description:

Spotlight the video of the assigned user to the first view.

Source:

zoom_meeting_video.js, line 174

Parameters:

Name	Type	Description
`bSpotlight`	Boolean	bSpotlight or not
`userid`	Number	Specifies which the user's video to pin

Returns:

If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError

Type: Number

(inner) MeetingVideo_SpotlightVideo(bSpotlight, userid) → {Number}

Description:

Spotlight the video of the assigned user to the first view.

Source:

zoom_meeting_video.js, line 174

Parameters:

Name	Type	Description
`bSpotlight`	Boolean	bSpotlight or not
`userid`	Number	Specifies which the user's video to pin

Returns:

If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError

Type: Number

(inner) MeetingVideo_UnMuteVideo(userid) → {Number}

Description:

Turn on the user's own video.

Source:

zoom_meeting_video.js, line 125

Parameters:

Name	Type	Description
`userid`	Number	Specifies which the user's video to unmute

Returns:

If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError

Type: Number

(inner) MeetingVideo_UnMuteVideo(userid) → {Number}

Description:

Turn on the user's own video.

Source:

zoom_meeting_video.js, line 125

Parameters:

Name	Type	Description
`userid`	Number	Specifies which the user's video to unmute

Returns:

If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError

Type: Number

Events

onActiveSpeakerVideoUserChanged

Description:

Callback event of the active speaker video user changes.

Source:

zoom_meeting_video.js, line 34

Parameters:

Name	Type	Description
`userId`	String	The ID of user who becomes the new active speaker.

onActiveSpeakerVideoUserChanged

Description:

Callback event of the active speaker video user changes.

Source:

zoom_meeting_video.js, line 34

Parameters:

Name	Type	Description
`userId`	String	The ID of user who becomes the new active speaker.

onActiveVideoUserChanged

Description:

Callback event of the active video user changes.

Source:

zoom_meeting_video.js, line 45

Parameters:

Name	Type	Description
`userId`	String	The ID of user who becomes the new active speaker.

onActiveVideoUserChanged

Description:

Callback event of the active video user changes.

Source:

zoom_meeting_video.js, line 45

Parameters:

Name	Type	Description
`userId`	String	The ID of user who becomes the new active speaker.

onUserVideoStatusChange

Description:

Callback event of the user video status changes.

Source:

zoom_meeting_video.js, line 22

Parameters:

Name	Type	Description
`userId`	String	The user ID whose video status changes
`status`	String	New video status. Defined in: ZoomMeetingVideoStatus

onUserVideoStatusChange

Description:

Callback event of the user video status changes.

Source:

zoom_meeting_video.js, line 22

Parameters:

Name	Type	Description
`userId`	String	The user ID whose video status changes
`status`	String	New video status. Defined in: ZoomMeetingVideoStatus

Zoom Meeting Video

Description:

Zoom Meeting Video

Source:

zoom_meeting_video.js, line 6

Parameters:

Name	Type	Description
`onUserVideoStatusChange`	function	Callback event of the user video status changes.
`onActiveSpeakerVideoUserChanged`	function	Callback event of the active speaker video user changes.
`onActiveVideoUserChanged`	function	Callback event of the active video user changes.

Returns:

Type: ZoomMeetingVideo

Description:

Zoom Meeting Video

Source:

zoom_meeting_video.js, line 6

Parameters:

Name	Type	Description
`onUserVideoStatusChange`	function	Callback event of the user video status changes.
`onActiveSpeakerVideoUserChanged`	function	Callback event of the active speaker video user changes.
`onActiveVideoUserChanged`	function	Callback event of the active video user changes.

Returns:

Type: ZoomMeetingVideo

Methods

(inner) MeetingVideo_HideOrShowNoVideoUserOnVideoWall(bHide) → {Number}

Description:

Display or not the user who does not turn on the video in the video all mode.

Source:

zoom_meeting_video.js, line 199

Parameters:

Name	Type	Description
`bHide`	Boolean	bHide or not

Returns:

TRUE indicates to hide, FALSE show. Otherwise failed. To get extended error information, Defined in: ZoomSDKError

Type: Number

(inner) MeetingVideo_HideOrShowNoVideoUserOnVideoWall(bHide) → {Number}

Description:

Display or not the user who does not turn on the video in the video all mode.

Source:

zoom_meeting_video.js, line 199

Parameters:

Name	Type	Description
`bHide`	Boolean	bHide or not

Returns:

TRUE indicates to hide, FALSE show. Otherwise failed. To get extended error information, Defined in: ZoomSDKError

Type: Number

(inner) MeetingVideo_MuteVideo(userid) → {Number}

Description:

Turn off the user's own video.

Source:

zoom_meeting_video.js, line 103

Parameters:

Name	Type	Description
`userid`	Number	Specifies which the user's video to mute

Returns:

If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError

Type: Number

(inner) MeetingVideo_MuteVideo(userid) → {Number}

Description:

Turn off the user's own video.

Source:

zoom_meeting_video.js, line 103

Parameters:

Name	Type	Description
`userid`	Number	Specifies which the user's video to mute

Returns:

If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError

Type: Number

(inner) MeetingVideo_PinVideo(bPin, bFirstView, userid) → {Number}

Description:

pin video

Source:

zoom_meeting_video.js, line 147

Parameters:

Name	Type	Description
`bPin`	Boolean	bPin or not
`bFirstView`	Boolean	bFirstView or not
`userid`	Number	Specifies which the user's video to pin

Returns:

Defined in: ZoomSDKError

Type: Number

(inner) MeetingVideo_PinVideo(bPin, bFirstView, userid) → {Number}

Description:

pin video

Source:

zoom_meeting_video.js, line 147

Parameters:

Name	Type	Description
`bPin`	Boolean	bPin or not
`bFirstView`	Boolean	bFirstView or not
`userid`	Number	Specifies which the user's video to pin

Returns:

Defined in: ZoomSDKError

Type: Number

(inner) MeetingVideo_SetActiveSpeakerVideoUserChangedCB(onActiveSpeakerVideoUserChanged) → {Boolean}

Description:

Set callback function of notification of the active speaker video user changes.

Source:

zoom_meeting_video.js, line 77

Parameters:

Name	Type	Description
`onActiveSpeakerVideoUserChanged`	function

Returns:

Type: Boolean

(inner) MeetingVideo_SetActiveSpeakerVideoUserChangedCB(onActiveSpeakerVideoUserChanged) → {Boolean}

Description:

Set callback function of notification of the active speaker video user changes.

Source:

zoom_meeting_video.js, line 77

Parameters:

Name	Type	Description
`onActiveSpeakerVideoUserChanged`	function

Returns:

Type: Boolean

(inner) MeetingVideo_SetActiveVideoUserChangedCB(onActiveVideoUserChanged) → {Boolean}

Description:

Set callback function of notification of the active video user changes.

Source:

zoom_meeting_video.js, line 90

Parameters:

Name	Type	Description
`onActiveVideoUserChanged`	function

Returns:

Type: Boolean

(inner) MeetingVideo_SetActiveVideoUserChangedCB(onActiveVideoUserChanged) → {Boolean}

Description:

Set callback function of notification of the active video user changes.

Source:

zoom_meeting_video.js, line 90

Parameters:

Name	Type	Description
`onActiveVideoUserChanged`	function

Returns:

Type: Boolean

(inner) MeetingVideo_SetMeetingVideoStatusCB(onUserVideoStatusChange) → {Boolean}

Description:

Set callback function of notification of the user video status changes.

Source:

zoom_meeting_video.js, line 64

Parameters:

Name	Type	Description
`onUserVideoStatusChange`	function

Returns:

Type: Boolean

(inner) MeetingVideo_SetMeetingVideoStatusCB(onUserVideoStatusChange) → {Boolean}

Description:

Set callback function of notification of the user video status changes.

Source:

zoom_meeting_video.js, line 64

Parameters:

Name	Type	Description
`onUserVideoStatusChange`	function

Returns:

Type: Boolean

(inner) MeetingVideo_SetVideoQualityPreference(mode, minimumFrameRate, minimumFrameRate) → {Number}

Description:

Set the video quality preference that automatically adjust user's video to prioritize frame rate versus resolution based on the current bandwidth available.

Source:

zoom_meeting_video.js, line 221

Parameters:

Name	Type	Description
`mode`	Number	Defined in: SDKVideoPreferenceMode
`minimumFrameRate`	Number	0 for the default value,minimum_frame_rate should be less than maximum_frame_rate, range: from 0 to 30 .out of range for frame-rate will use default frame-rate of Zoom
`minimumFrameRate`	Number	0 for the default value,maximum_frame_rate should be less and equal than 30, range: from 0 to 30.out of range for frame-rate will use default frame-rate of Zoom

Returns:

If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError

Type: Number

(inner) MeetingVideo_SetVideoQualityPreference(mode, minimumFrameRate, minimumFrameRate) → {Number}

Description:

Set the video quality preference that automatically adjust user's video to prioritize frame rate versus resolution based on the current bandwidth available.

Source:

zoom_meeting_video.js, line 221

Parameters:

Name	Type	Description
`mode`	Number	Defined in: SDKVideoPreferenceMode
`minimumFrameRate`	Number	0 for the default value,minimum_frame_rate should be less than maximum_frame_rate, range: from 0 to 30 .out of range for frame-rate will use default frame-rate of Zoom
`minimumFrameRate`	Number	0 for the default value,maximum_frame_rate should be less and equal than 30, range: from 0 to 30.out of range for frame-rate will use default frame-rate of Zoom

Returns:

If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError

Type: Number

(inner) MeetingVideo_SpotlightVideo(bSpotlight, userid) → {Number}

Description:

Spotlight the video of the assigned user to the first view.

Source:

zoom_meeting_video.js, line 174

Parameters:

Name	Type	Description
`bSpotlight`	Boolean	bSpotlight or not
`userid`	Number	Specifies which the user's video to pin

Returns:

If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError

Type: Number

(inner) MeetingVideo_SpotlightVideo(bSpotlight, userid) → {Number}

Description:

Spotlight the video of the assigned user to the first view.

Source:

zoom_meeting_video.js, line 174

Parameters:

Name	Type	Description
`bSpotlight`	Boolean	bSpotlight or not
`userid`	Number	Specifies which the user's video to pin

Returns:

If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError

Type: Number

(inner) MeetingVideo_UnMuteVideo(userid) → {Number}

Description:

Turn on the user's own video.

Source:

zoom_meeting_video.js, line 125

Parameters:

Name	Type	Description
`userid`	Number	Specifies which the user's video to unmute

Returns:

If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError

Type: Number

(inner) MeetingVideo_UnMuteVideo(userid) → {Number}

Description:

Turn on the user's own video.

Source:

zoom_meeting_video.js, line 125

Parameters:

Name	Type	Description
`userid`	Number	Specifies which the user's video to unmute

Returns:

If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError

Type: Number

Events

onActiveSpeakerVideoUserChanged

Description:

Callback event of the active speaker video user changes.

Source:

zoom_meeting_video.js, line 34

Parameters:

Name	Type	Description
`userId`	String	The ID of user who becomes the new active speaker.

onActiveSpeakerVideoUserChanged

Description:

Callback event of the active speaker video user changes.

Source:

zoom_meeting_video.js, line 34

Parameters:

Name	Type	Description
`userId`	String	The ID of user who becomes the new active speaker.

onActiveVideoUserChanged

Description:

Callback event of the active video user changes.

Source:

zoom_meeting_video.js, line 45

Parameters:

Name	Type	Description
`userId`	String	The ID of user who becomes the new active speaker.

onActiveVideoUserChanged

Description:

Callback event of the active video user changes.

Source:

zoom_meeting_video.js, line 45

Parameters:

Name	Type	Description
`userId`	String	The ID of user who becomes the new active speaker.

onUserVideoStatusChange

Description:

Callback event of the user video status changes.

Source:

zoom_meeting_video.js, line 22

Parameters:

Name	Type	Description
`userId`	String	The user ID whose video status changes
`status`	String	New video status. Defined in: ZoomMeetingVideoStatus

onUserVideoStatusChange

Description:

Callback event of the user video status changes.

Source:

zoom_meeting_video.js, line 22

Parameters:

Name	Type	Description
`userId`	String	The user ID whose video status changes
`status`	String	New video status. Defined in: ZoomMeetingVideoStatus