zoom_meeting_video

Zoom Meeting Video
Description:
  • Zoom Meeting Video
Source:
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:
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:
Parameters:
Name Type Description
bHide Boolean bHide or not
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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:
Parameters:
Name Type Description
bHide Boolean bHide or not
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) MeetingVideo_MuteVideo(userid) → {Number}

Description:
  • Turn off the user's own video.
Source:
Parameters:
Name Type Description
userid Number Specifies which the user's video to mute
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) MeetingVideo_MuteVideo(userid) → {Number}

Description:
  • Turn off the user's own video.
Source:
Parameters:
Name Type Description
userid Number Specifies which the user's video to mute
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

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

Description:
  • Pin the video of the assigned user to the first view.
Source:
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:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

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

Description:
  • Pin the video of the assigned user to the first view.
Source:
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:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) MeetingVideo_SetActiveSpeakerVideoUserChangedCB(onActiveSpeakerVideoUserChanged) → {Boolean}

Description:
  • Set onActiveSpeakerVideoUserChanged callback.
Source:
Parameters:
Name Type Description
onActiveSpeakerVideoUserChanged function
Returns:
true or false
Type
Boolean

(inner) MeetingVideo_SetActiveSpeakerVideoUserChangedCB(onActiveSpeakerVideoUserChanged) → {Boolean}

Description:
  • Set onActiveSpeakerVideoUserChanged callback.
Source:
Parameters:
Name Type Description
onActiveSpeakerVideoUserChanged function
Returns:
true or false
Type
Boolean

(inner) MeetingVideo_SetActiveVideoUserChangedCB(onActiveVideoUserChanged) → {Boolean}

Description:
  • Set onActiveVideoUserChanged callback.
Source:
Parameters:
Name Type Description
onActiveVideoUserChanged function
Returns:
true or false
Type
Boolean

(inner) MeetingVideo_SetActiveVideoUserChangedCB(onActiveVideoUserChanged) → {Boolean}

Description:
  • Set onActiveVideoUserChanged callback.
Source:
Parameters:
Name Type Description
onActiveVideoUserChanged function
Returns:
true or false
Type
Boolean

(inner) MeetingVideo_SetMeetingVideoStatusCB(onUserVideoStatusChange) → {Boolean}

Description:
  • Set onUserVideoStatusChange callback.
Source:
Parameters:
Name Type Description
onUserVideoStatusChange function
Returns:
true or false
Type
Boolean

(inner) MeetingVideo_SetMeetingVideoStatusCB(onUserVideoStatusChange) → {Boolean}

Description:
  • Set onUserVideoStatusChange callback.
Source:
Parameters:
Name Type Description
onUserVideoStatusChange function
Returns:
true or false
Type
Boolean

(inner) MeetingVideo_SetVideoQualityPreference(mode, minimumFrameRate, maximumFrameRate) → {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:
Parameters:
Name Type Description
mode Number 0: Balance mode; 1: Smoothness mode; 2: Sharpness mode; 3: Custom mode
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
maximumFrameRate 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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) MeetingVideo_SetVideoQualityPreference(mode, minimumFrameRate, maximumFrameRate) → {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:
Parameters:
Name Type Description
mode Number 0: Balance mode; 1: Smoothness mode; 2: Sharpness mode; 3: Custom mode
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
maximumFrameRate 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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) MeetingVideo_SpotlightVideo(userid) → {Number}

Description:
  • Spotlight the video of the assigned user to the first view.
Source:
Parameters:
Name Type Description
userid Number Specifies which the user's video to pin
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) MeetingVideo_SpotlightVideo(userid) → {Number}

Description:
  • Spotlight the video of the assigned user to the first view.
Source:
Parameters:
Name Type Description
userid Number Specifies which the user's video to pin
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) MeetingVideo_UnMuteVideo(userid) → {Number}

Description:
  • Turn on the user's own video.
Source:
Parameters:
Name Type Description
userid Number Specifies which the user's video to unmute
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) MeetingVideo_UnMuteVideo(userid) → {Number}

Description:
  • Turn on the user's own video.
Source:
Parameters:
Name Type Description
userid Number Specifies which the user's video to unmute
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

Events

onActiveSpeakerVideoUserChanged

Description:
  • Callback event of the active speaker video user changes.
Source:
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:
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:
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:
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:
Parameters:
Name Type Description
userId String The user ID whose video status changes
status String New video status ZoomMeetingVideoStatus

onUserVideoStatusChange

Description:
  • Callback event of the user video status changes.
Source:
Parameters:
Name Type Description
userId String The user ID whose video status changes
status String New video status ZoomMeetingVideoStatus
Zoom Meeting Video
Description:
  • Zoom Meeting Video
Source:
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:
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:
Parameters:
Name Type Description
bHide Boolean bHide or not
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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:
Parameters:
Name Type Description
bHide Boolean bHide or not
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) MeetingVideo_MuteVideo(userid) → {Number}

Description:
  • Turn off the user's own video.
Source:
Parameters:
Name Type Description
userid Number Specifies which the user's video to mute
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) MeetingVideo_MuteVideo(userid) → {Number}

Description:
  • Turn off the user's own video.
Source:
Parameters:
Name Type Description
userid Number Specifies which the user's video to mute
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

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

Description:
  • Pin the video of the assigned user to the first view.
Source:
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:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

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

Description:
  • Pin the video of the assigned user to the first view.
Source:
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:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) MeetingVideo_SetActiveSpeakerVideoUserChangedCB(onActiveSpeakerVideoUserChanged) → {Boolean}

Description:
  • Set onActiveSpeakerVideoUserChanged callback.
Source:
Parameters:
Name Type Description
onActiveSpeakerVideoUserChanged function
Returns:
true or false
Type
Boolean

(inner) MeetingVideo_SetActiveSpeakerVideoUserChangedCB(onActiveSpeakerVideoUserChanged) → {Boolean}

Description:
  • Set onActiveSpeakerVideoUserChanged callback.
Source:
Parameters:
Name Type Description
onActiveSpeakerVideoUserChanged function
Returns:
true or false
Type
Boolean

(inner) MeetingVideo_SetActiveVideoUserChangedCB(onActiveVideoUserChanged) → {Boolean}

Description:
  • Set onActiveVideoUserChanged callback.
Source:
Parameters:
Name Type Description
onActiveVideoUserChanged function
Returns:
true or false
Type
Boolean

(inner) MeetingVideo_SetActiveVideoUserChangedCB(onActiveVideoUserChanged) → {Boolean}

Description:
  • Set onActiveVideoUserChanged callback.
Source:
Parameters:
Name Type Description
onActiveVideoUserChanged function
Returns:
true or false
Type
Boolean

(inner) MeetingVideo_SetMeetingVideoStatusCB(onUserVideoStatusChange) → {Boolean}

Description:
  • Set onUserVideoStatusChange callback.
Source:
Parameters:
Name Type Description
onUserVideoStatusChange function
Returns:
true or false
Type
Boolean

(inner) MeetingVideo_SetMeetingVideoStatusCB(onUserVideoStatusChange) → {Boolean}

Description:
  • Set onUserVideoStatusChange callback.
Source:
Parameters:
Name Type Description
onUserVideoStatusChange function
Returns:
true or false
Type
Boolean

(inner) MeetingVideo_SetVideoQualityPreference(mode, minimumFrameRate, maximumFrameRate) → {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:
Parameters:
Name Type Description
mode Number 0: Balance mode; 1: Smoothness mode; 2: Sharpness mode; 3: Custom mode
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
maximumFrameRate 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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) MeetingVideo_SetVideoQualityPreference(mode, minimumFrameRate, maximumFrameRate) → {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:
Parameters:
Name Type Description
mode Number 0: Balance mode; 1: Smoothness mode; 2: Sharpness mode; 3: Custom mode
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
maximumFrameRate 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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) MeetingVideo_SpotlightVideo(userid) → {Number}

Description:
  • Spotlight the video of the assigned user to the first view.
Source:
Parameters:
Name Type Description
userid Number Specifies which the user's video to pin
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) MeetingVideo_SpotlightVideo(userid) → {Number}

Description:
  • Spotlight the video of the assigned user to the first view.
Source:
Parameters:
Name Type Description
userid Number Specifies which the user's video to pin
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) MeetingVideo_UnMuteVideo(userid) → {Number}

Description:
  • Turn on the user's own video.
Source:
Parameters:
Name Type Description
userid Number Specifies which the user's video to unmute
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) MeetingVideo_UnMuteVideo(userid) → {Number}

Description:
  • Turn on the user's own video.
Source:
Parameters:
Name Type Description
userid Number Specifies which the user's video to unmute
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

Events

onActiveSpeakerVideoUserChanged

Description:
  • Callback event of the active speaker video user changes.
Source:
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:
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:
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:
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:
Parameters:
Name Type Description
userId String The user ID whose video status changes
status String New video status ZoomMeetingVideoStatus

onUserVideoStatusChange

Description:
  • Callback event of the user video status changes.
Source:
Parameters:
Name Type Description
userId String The user ID whose video status changes
status String New video status ZoomMeetingVideoStatus