zoom_meeting_live_stream_ctrl

Zoom Meeting Live Stream Ctrl
Description:
  • Zoom Meeting Live Stream Ctrl
Source:
Returns:
Type
ZoomMeetingLiveStreamCtrl
Description:
  • Zoom Meeting Live Stream Ctrl
Source:
Returns:
Type
ZoomMeetingLiveStreamCtrl

Methods

(inner) CanEnableLiveStreamReminder() → {Boolean}

Description:
  • Check if the current user can enable/disable the live stream reminder.
Source:
Returns:
True means the current user can enable/disable the live stream reminder.
Type
Boolean

(inner) CanEnableLiveStreamReminder() → {Boolean}

Description:
  • Check if the current user can enable/disable the live stream reminder.
Source:
Returns:
True means the current user can enable/disable the live stream reminder.
Type
Boolean

(inner) CanStartLiveStream() → {Number}

Description:
  • Determine if it is able to start live streaming.
Source:
Returns:
If it is enabled to start the live streaming, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) CanStartLiveStream() → {Number}

Description:
  • Determine if it is able to start live streaming.
Source:
Returns:
If it is enabled to start the live streaming, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) CanStartRawLiveStream() → {Number}

Description:
  • Whether if the current user is able to start raw live streaming.
Source:
Returns:
If the current user is able to start raw live streaming, the return value is SDKERR_SUCCESS. Otherwise it fails,and returns NULL. To get extended error information, see ZoomSDKError.
Type
Number

(inner) CanStartRawLiveStream() → {Number}

Description:
  • Whether if the current user is able to start raw live streaming.
Source:
Returns:
If the current user is able to start raw live streaming, the return value is SDKERR_SUCCESS. Otherwise it fails,and returns NULL. To get extended error information, see ZoomSDKError.
Type
Number

(inner) EnableLiveStreamReminder(enable) → {Number}

Description:
  • Enable or disable the live stream reminder.
Source:
Parameters:
Name Type Description
enable Boolean True means enable the live stream reminder. False means disable the live stream reminder.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise it fails. To get extended error information, see ZoomSDKError.
Type
Number

(inner) EnableLiveStreamReminder(enable) → {Number}

Description:
  • Enable or disable the live stream reminder.
Source:
Parameters:
Name Type Description
enable Boolean True means enable the live stream reminder. False means disable the live stream reminder.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise it fails. To get extended error information, see ZoomSDKError.
Type
Number

(inner) GetCurrentLiveStreamItem() → {Object}

Description:
  • Get the current live stream object.
Source:
Returns:
If the function succeeds, the return value is the current live stream object. Otherwise failed, the return value is NULL
Type
Object

(inner) GetCurrentLiveStreamItem() → {Object}

Description:
  • Get the current live stream object.
Source:
Returns:
If the function succeeds, the return value is the current live stream object. Otherwise failed, the return value is NULL
Type
Object

(inner) GetCurrentLiveStreamStatus() → {Number}

Description:
  • Get live stream status of current meeting.
Source:
Returns:
If the function succeeds, the return value is the live stream status of current meeting. Otherwise failed. For more details, see LiveStreamStatus.
Type
Number

(inner) GetCurrentLiveStreamStatus() → {Number}

Description:
  • Get live stream status of current meeting.
Source:
Returns:
If the function succeeds, the return value is the live stream status of current meeting. Otherwise failed. For more details, see LiveStreamStatus.
Type
Number

(inner) GetLiveStreamItemInfo(liveStreamHandle) → {Object}

Description:
  • get the live stream item info.
Source:
Parameters:
Name Type Description
liveStreamHandle Number the handle of live stream
Returns:
contains liveStreamURL, liveStreamURLDescription, liveStreamViewerURL
Type
Object

(inner) GetLiveStreamItemInfo(liveStreamHandle) → {Object}

Description:
  • get the live stream item info.
Source:
Parameters:
Name Type Description
liveStreamHandle Number the handle of live stream
Returns:
contains liveStreamURL, liveStreamURLDescription, liveStreamViewerURL
Type
Object

(inner) GetRawLiveStreamPrivilegeUserList() → {Array}

Description:
  • Get the list of users'IDs who have raw live stream privileges.
Source:
Returns:
If the function succeeds, the return value is a list of users'IDs who have raw live stream privileges.
Type
Array

(inner) GetRawLiveStreamPrivilegeUserList() → {Array}

Description:
  • Get the list of users'IDs who have raw live stream privileges.
Source:
Returns:
If the function succeeds, the return value is a list of users'IDs who have raw live stream privileges.
Type
Array

(inner) GetRawLiveStreamingInfoList() → {Array}

Description:
  • Get a list of current active raw live streams.
Source:
Returns:
If the function succeeds, the return value is a list of current active raw live streams.
Type
Array

(inner) GetRawLiveStreamingInfoList() → {Array}

Description:
  • Get a list of current active raw live streams.
Source:
Returns:
If the function succeeds, the return value is a list of current active raw live streams.
Type
Array

(inner) GetSupportLiveStreamItems() → {Array}

Description:
  • Get the list of handles used by live streaming in the current meeting. You can get live stream information by GetLiveStreamItemInfo interface.
Source:
Returns:
If the function succeeds, the return value is the meeting information to be live streamed. Otherwise failed, the return value is NULL
Type
Array

(inner) GetSupportLiveStreamItems() → {Array}

Description:
  • Get the list of handles used by live streaming in the current meeting. You can get live stream information by GetLiveStreamItemInfo interface.
Source:
Returns:
If the function succeeds, the return value is the meeting information to be live streamed. Otherwise failed, the return value is NULL
Type
Array

(inner) IsLiveStreamReminderEnabled() → {Boolean}

Description:
  • Check if the live stream reminder is enabled. When the live stream reminder is enabled, the new join user is notified that the meeting is at capacity but that they can watch the meeting live stream with the callback onMeetingFullToWatchLiveStream when the meeting user has reached the meeting capability.
Source:
Returns:
True means the live stream reminder is enabled.
Type
Boolean

(inner) IsLiveStreamReminderEnabled() → {Boolean}

Description:
  • Check if the live stream reminder is enabled. When the live stream reminder is enabled, the new join user is notified that the meeting is at capacity but that they can watch the meeting live stream with the callback onMeetingFullToWatchLiveStream when the meeting user has reached the meeting capability.
Source:
Returns:
True means the live stream reminder is enabled.
Type
Boolean

(inner) IsRawLiveStreamSupported() → {Boolean}

Description:
  • Query Whether the meeting supports raw live streams.
Source:
Returns:
true if supported, false if not supported.
Type
Boolean

(inner) IsRawLiveStreamSupported() → {Boolean}

Description:
  • Query Whether the meeting supports raw live streams.
Source:
Returns:
true if supported, false if not supported.
Type
Boolean

(inner) RemoveRawLiveStreamPrivilege(userID) → {Number}

Description:
  • Remove the raw live stream privilege.
Source:
Parameters:
Name Type Description
userID Number Specify the ID of the user whose privilege will be removed.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise it fails. To get extended error information, see ZoomSDKError.
Type
Number

(inner) RemoveRawLiveStreamPrivilege(userID) → {Number}

Description:
  • Remove the raw live stream privilege.
Source:
Parameters:
Name Type Description
userID Number Specify the ID of the user whose privilege will be removed.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise it fails. To get extended error information, see ZoomSDKError.
Type
Number

(inner) SetOnLiveStreamReminderStatusChangeFailedCB(onLiveStreamReminderStatusChangeFailed) → {Boolean}

Description:
  • Set callback event when the live stream reminder enable status change fails.
Source:
Parameters:
Name Type Description
onLiveStreamReminderStatusChangeFailed function
Returns:
Type
Boolean

(inner) SetOnLiveStreamReminderStatusChangeFailedCB(onLiveStreamReminderStatusChangeFailed) → {Boolean}

Description:
  • Set callback event when the live stream reminder enable status change fails.
Source:
Parameters:
Name Type Description
onLiveStreamReminderStatusChangeFailed function
Returns:
Type
Boolean

(inner) SetOnLiveStreamReminderStatusChangedCB(onLiveStreamReminderStatusChanged) → {Boolean}

Description:
  • Set callback event when the live stream reminder enable status changes.
Source:
Parameters:
Name Type Description
onLiveStreamReminderStatusChanged function
Returns:
Type
Boolean

(inner) SetOnLiveStreamReminderStatusChangedCB(onLiveStreamReminderStatusChanged) → {Boolean}

Description:
  • Set callback event when the live stream reminder enable status changes.
Source:
Parameters:
Name Type Description
onLiveStreamReminderStatusChanged function
Returns:
Type
Boolean

(inner) SetOnLiveStreamStatusChangeCB(onLiveStreamStatusChange) → {Boolean}

Description:
  • Set the callback of live stream status change.
Source:
Parameters:
Name Type Description
onLiveStreamStatusChange function
Returns:
Type
Boolean

(inner) SetOnLiveStreamStatusChangeCB(onLiveStreamStatusChange) → {Boolean}

Description:
  • Set the callback of live stream status change.
Source:
Parameters:
Name Type Description
onLiveStreamStatusChange function
Returns:
Type
Boolean

(inner) SetOnRawLiveStreamPrivilegeChangedCB(onRawLiveStreamPrivilegeChanged) → {Boolean}

Description:
  • Set the callback of raw live stream privilege changed.
Source:
Parameters:
Name Type Description
onRawLiveStreamPrivilegeChanged function
Returns:
Type
Boolean

(inner) SetOnRawLiveStreamPrivilegeChangedCB(onRawLiveStreamPrivilegeChanged) → {Boolean}

Description:
  • Set the callback of raw live stream privilege changed.
Source:
Parameters:
Name Type Description
onRawLiveStreamPrivilegeChanged function
Returns:
Type
Boolean

(inner) SetOnRawLiveStreamPrivilegeRequestTimeoutCB(onRawLiveStreamPrivilegeRequestTimeout) → {Boolean}

Description:
  • Set the callback of raw live stream privilege request timeout.
Source:
Parameters:
Name Type Description
onRawLiveStreamPrivilegeRequestTimeout function
Returns:
Type
Boolean

(inner) SetOnRawLiveStreamPrivilegeRequestTimeoutCB(onRawLiveStreamPrivilegeRequestTimeout) → {Boolean}

Description:
  • Set the callback of raw live stream privilege request timeout.
Source:
Parameters:
Name Type Description
onRawLiveStreamPrivilegeRequestTimeout function
Returns:
Type
Boolean

(inner) SetOnRawLiveStreamPrivilegeRequestedCB(onRawLiveStreamPrivilegeRequested) → {Boolean}

Description:
  • Set the callback of raw live stream privilege requested.
Source:
Parameters:
Name Type Description
onRawLiveStreamPrivilegeRequested function
Returns:
Type
Boolean

(inner) SetOnRawLiveStreamPrivilegeRequestedCB(onRawLiveStreamPrivilegeRequested) → {Boolean}

Description:
  • Set the callback of raw live stream privilege requested.
Source:
Parameters:
Name Type Description
onRawLiveStreamPrivilegeRequested function
Returns:
Type
Boolean

(inner) SetOnUserRawLiveStreamPrivilegeChangedCB(onUserRawLiveStreamPrivilegeChanged) → {Boolean}

Description:
  • Set the callback of user raw live stream privilege changed.
Source:
Parameters:
Name Type Description
onUserRawLiveStreamPrivilegeChanged function
Returns:
Type
Boolean

(inner) SetOnUserRawLiveStreamPrivilegeChangedCB(onUserRawLiveStreamPrivilegeChanged) → {Boolean}

Description:
  • Set the callback of user raw live stream privilege changed.
Source:
Parameters:
Name Type Description
onUserRawLiveStreamPrivilegeChanged function
Returns:
Type
Boolean

(inner) SetOnUserRawLiveStreamingStatusChangedCB(onUserRawLiveStreamingStatusChanged) → {Boolean}

Description:
  • Set the callback of user raw live streaming status changed.
Source:
Parameters:
Name Type Description
onUserRawLiveStreamingStatusChanged function
Returns:
Type
Boolean

(inner) SetOnUserRawLiveStreamingStatusChangedCB(onUserRawLiveStreamingStatusChanged) → {Boolean}

Description:
  • Set the callback of user raw live streaming status changed.
Source:
Parameters:
Name Type Description
onUserRawLiveStreamingStatusChanged function
Returns:
Type
Boolean

(inner) SetOnUserThresholdReachedForLiveStreamCB(onUserThresholdReachedForLiveStream) → {Boolean}

Description:
  • Set callback event when the meeting or webinar user has nearly reached the meeting capacity, like 80% or 100% for the meeting or webinar capacity.
Source:
Parameters:
Name Type Description
onUserThresholdReachedForLiveStream function
Returns:
Type
Boolean

(inner) SetOnUserThresholdReachedForLiveStreamCB(onUserThresholdReachedForLiveStream) → {Boolean}

Description:
  • Set callback event when the meeting or webinar user has nearly reached the meeting capacity, like 80% or 100% for the meeting or webinar capacity.
Source:
Parameters:
Name Type Description
onUserThresholdReachedForLiveStream function
Returns:
Type
Boolean

(inner) StartLiveStream(liveStreamHandle) → {Number}

Description:
  • Start live streaming.
Source:
Parameters:
Name Type Description
liveStreamHandle Number the handle of live stream item
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) StartLiveStream(liveStreamHandle) → {Number}

Description:
  • Start live streaming.
Source:
Parameters:
Name Type Description
liveStreamHandle Number the handle of live stream item
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) StartLiveStreamWithSteamingURL(streamingURL, streamingKey, broadcastURL) → {Number}

Description:
  • Start live streaming. Get the parameters from the third party of live stream service
Source:
Parameters:
Name Type Description
streamingURL String The URL of live streaming.
streamingKey String The key of live streaming.
broadcastURL String The broadcast URL of live-stream.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) StartLiveStreamWithSteamingURL(streamingURL, streamingKey, broadcastURL) → {Number}

Description:
  • Start live streaming. Get the parameters from the third party of live stream service
Source:
Parameters:
Name Type Description
streamingURL String The URL of live streaming.
streamingKey String The key of live streaming.
broadcastURL String The broadcast URL of live-stream.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) StopLiveStream() → {Number}

Description:
  • Stop live streaming.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) StopLiveStream() → {Number}

Description:
  • Stop live streaming.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) StopRawLiveStream() → {Number}

Description:
  • Stop raw live streaming.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) StopRawLiveStream() → {Number}

Description:
  • Stop raw live streaming.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

Events

onLiveStreamReminderStatusChangeFailed

Description:
  • Callback event when the live stream reminder enable status change fails.
Source:

onLiveStreamReminderStatusChangeFailed

Description:
  • Callback event when the live stream reminder enable status change fails.
Source:

onLiveStreamReminderStatusChanged

Description:
  • Callback event when the live stream reminder enable status changes.
Source:
Parameters:
Name Type Description
enable Boolean True means the live stream reminder is enabled.

onLiveStreamReminderStatusChanged

Description:
  • Callback event when the live stream reminder enable status changes.
Source:
Parameters:
Name Type Description
enable Boolean True means the live stream reminder is enabled.

onLiveStreamStatusChange

Description:
  • Callback event when live stream status changes.
Source:
Parameters:
Name Type Description
status String Live stream status. For more details, see LiveStreamStatus enum.

onLiveStreamStatusChange

Description:
  • Callback event when live stream status changes.
Source:
Parameters:
Name Type Description
status String Live stream status. For more details, see LiveStreamStatus enum.

onRawLiveStreamPrivilegeChanged

Description:
  • Callback event when the current user's raw live streaming privilege changes.
Source:
Parameters:
Name Type Description
hasPrivilege Boolean Specify whether or not the user has privileg.

onRawLiveStreamPrivilegeChanged

Description:
  • Callback event when the current user's raw live streaming privilege changes.
Source:
Parameters:
Name Type Description
hasPrivilege Boolean Specify whether or not the user has privileg.

onRawLiveStreamPrivilegeRequestTimeout

Description:
  • Callback event when the current user's request has time out.
Source:

onRawLiveStreamPrivilegeRequestTimeout

Description:
  • Callback event when the current user's request has time out.
Source:

onRawLiveStreamPrivilegeRequested

Description:
  • Callback event when a user requests raw live streaming privilege.
Source:

onRawLiveStreamPrivilegeRequested

Description:
  • Callback event when a user requests raw live streaming privilege.
Source:

onUserRawLiveStreamPrivilegeChanged

Description:
  • Callback event when another user's raw live streaming privilege has changed.
Source:
Parameters:
Name Type Description
userid Number The ID of the user whose privilege has changed.
hasPrivilege Boolean Specify whether the user has privilege or not.

onUserRawLiveStreamPrivilegeChanged

Description:
  • Callback event when another user's raw live streaming privilege has changed.
Source:
Parameters:
Name Type Description
userid Number The ID of the user whose privilege has changed.
hasPrivilege Boolean Specify whether the user has privilege or not.

onUserRawLiveStreamingStatusChanged

Description:
  • Callback event when users start/stop raw live streaming.
Source:
Parameters:
Name Type Description
livingList Array list of users with an active raw live stream. contains object with broadcastUrl and userId

onUserRawLiveStreamingStatusChanged

Description:
  • Callback event when users start/stop raw live streaming.
Source:
Parameters:
Name Type Description
livingList Array list of users with an active raw live stream. contains object with broadcastUrl and userId

onUserThresholdReachedForLiveStream

Description:
  • Callback event when the meeting or webinar user has nearly reached the meeting capacity, like 80% or 100% for the meeting or webinar capacity. The host can start live stream to let unjoined user watch live stream.
Source:
Parameters:
Name Type Description
percent Number Proportion of joined users to the total capacity.

onUserThresholdReachedForLiveStream

Description:
  • Callback event when the meeting or webinar user has nearly reached the meeting capacity, like 80% or 100% for the meeting or webinar capacity. The host can start live stream to let unjoined user watch live stream.
Source:
Parameters:
Name Type Description
percent Number Proportion of joined users to the total capacity.
Zoom Meeting Live Stream Ctrl
Description:
  • Zoom Meeting Live Stream Ctrl
Source:
Returns:
Type
ZoomMeetingLiveStreamCtrl
Description:
  • Zoom Meeting Live Stream Ctrl
Source:
Returns:
Type
ZoomMeetingLiveStreamCtrl

Methods

(inner) CanEnableLiveStreamReminder() → {Boolean}

Description:
  • Check if the current user can enable/disable the live stream reminder.
Source:
Returns:
True means the current user can enable/disable the live stream reminder.
Type
Boolean

(inner) CanEnableLiveStreamReminder() → {Boolean}

Description:
  • Check if the current user can enable/disable the live stream reminder.
Source:
Returns:
True means the current user can enable/disable the live stream reminder.
Type
Boolean

(inner) CanStartLiveStream() → {Number}

Description:
  • Determine if it is able to start live streaming.
Source:
Returns:
If it is enabled to start the live streaming, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) CanStartLiveStream() → {Number}

Description:
  • Determine if it is able to start live streaming.
Source:
Returns:
If it is enabled to start the live streaming, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) CanStartRawLiveStream() → {Number}

Description:
  • Whether if the current user is able to start raw live streaming.
Source:
Returns:
If the current user is able to start raw live streaming, the return value is SDKERR_SUCCESS. Otherwise it fails,and returns NULL. To get extended error information, see ZoomSDKError.
Type
Number

(inner) CanStartRawLiveStream() → {Number}

Description:
  • Whether if the current user is able to start raw live streaming.
Source:
Returns:
If the current user is able to start raw live streaming, the return value is SDKERR_SUCCESS. Otherwise it fails,and returns NULL. To get extended error information, see ZoomSDKError.
Type
Number

(inner) EnableLiveStreamReminder(enable) → {Number}

Description:
  • Enable or disable the live stream reminder.
Source:
Parameters:
Name Type Description
enable Boolean True means enable the live stream reminder. False means disable the live stream reminder.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise it fails. To get extended error information, see ZoomSDKError.
Type
Number

(inner) EnableLiveStreamReminder(enable) → {Number}

Description:
  • Enable or disable the live stream reminder.
Source:
Parameters:
Name Type Description
enable Boolean True means enable the live stream reminder. False means disable the live stream reminder.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise it fails. To get extended error information, see ZoomSDKError.
Type
Number

(inner) GetCurrentLiveStreamItem() → {Object}

Description:
  • Get the current live stream object.
Source:
Returns:
If the function succeeds, the return value is the current live stream object. Otherwise failed, the return value is NULL
Type
Object

(inner) GetCurrentLiveStreamItem() → {Object}

Description:
  • Get the current live stream object.
Source:
Returns:
If the function succeeds, the return value is the current live stream object. Otherwise failed, the return value is NULL
Type
Object

(inner) GetCurrentLiveStreamStatus() → {Number}

Description:
  • Get live stream status of current meeting.
Source:
Returns:
If the function succeeds, the return value is the live stream status of current meeting. Otherwise failed. For more details, see LiveStreamStatus.
Type
Number

(inner) GetCurrentLiveStreamStatus() → {Number}

Description:
  • Get live stream status of current meeting.
Source:
Returns:
If the function succeeds, the return value is the live stream status of current meeting. Otherwise failed. For more details, see LiveStreamStatus.
Type
Number

(inner) GetLiveStreamItemInfo(liveStreamHandle) → {Object}

Description:
  • get the live stream item info.
Source:
Parameters:
Name Type Description
liveStreamHandle Number the handle of live stream
Returns:
contains liveStreamURL, liveStreamURLDescription, liveStreamViewerURL
Type
Object

(inner) GetLiveStreamItemInfo(liveStreamHandle) → {Object}

Description:
  • get the live stream item info.
Source:
Parameters:
Name Type Description
liveStreamHandle Number the handle of live stream
Returns:
contains liveStreamURL, liveStreamURLDescription, liveStreamViewerURL
Type
Object

(inner) GetRawLiveStreamPrivilegeUserList() → {Array}

Description:
  • Get the list of users'IDs who have raw live stream privileges.
Source:
Returns:
If the function succeeds, the return value is a list of users'IDs who have raw live stream privileges.
Type
Array

(inner) GetRawLiveStreamPrivilegeUserList() → {Array}

Description:
  • Get the list of users'IDs who have raw live stream privileges.
Source:
Returns:
If the function succeeds, the return value is a list of users'IDs who have raw live stream privileges.
Type
Array

(inner) GetRawLiveStreamingInfoList() → {Array}

Description:
  • Get a list of current active raw live streams.
Source:
Returns:
If the function succeeds, the return value is a list of current active raw live streams.
Type
Array

(inner) GetRawLiveStreamingInfoList() → {Array}

Description:
  • Get a list of current active raw live streams.
Source:
Returns:
If the function succeeds, the return value is a list of current active raw live streams.
Type
Array

(inner) GetSupportLiveStreamItems() → {Array}

Description:
  • Get the list of handles used by live streaming in the current meeting. You can get live stream information by GetLiveStreamItemInfo interface.
Source:
Returns:
If the function succeeds, the return value is the meeting information to be live streamed. Otherwise failed, the return value is NULL
Type
Array

(inner) GetSupportLiveStreamItems() → {Array}

Description:
  • Get the list of handles used by live streaming in the current meeting. You can get live stream information by GetLiveStreamItemInfo interface.
Source:
Returns:
If the function succeeds, the return value is the meeting information to be live streamed. Otherwise failed, the return value is NULL
Type
Array

(inner) IsLiveStreamReminderEnabled() → {Boolean}

Description:
  • Check if the live stream reminder is enabled. When the live stream reminder is enabled, the new join user is notified that the meeting is at capacity but that they can watch the meeting live stream with the callback onMeetingFullToWatchLiveStream when the meeting user has reached the meeting capability.
Source:
Returns:
True means the live stream reminder is enabled.
Type
Boolean

(inner) IsLiveStreamReminderEnabled() → {Boolean}

Description:
  • Check if the live stream reminder is enabled. When the live stream reminder is enabled, the new join user is notified that the meeting is at capacity but that they can watch the meeting live stream with the callback onMeetingFullToWatchLiveStream when the meeting user has reached the meeting capability.
Source:
Returns:
True means the live stream reminder is enabled.
Type
Boolean

(inner) IsRawLiveStreamSupported() → {Boolean}

Description:
  • Query Whether the meeting supports raw live streams.
Source:
Returns:
true if supported, false if not supported.
Type
Boolean

(inner) IsRawLiveStreamSupported() → {Boolean}

Description:
  • Query Whether the meeting supports raw live streams.
Source:
Returns:
true if supported, false if not supported.
Type
Boolean

(inner) RemoveRawLiveStreamPrivilege(userID) → {Number}

Description:
  • Remove the raw live stream privilege.
Source:
Parameters:
Name Type Description
userID Number Specify the ID of the user whose privilege will be removed.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise it fails. To get extended error information, see ZoomSDKError.
Type
Number

(inner) RemoveRawLiveStreamPrivilege(userID) → {Number}

Description:
  • Remove the raw live stream privilege.
Source:
Parameters:
Name Type Description
userID Number Specify the ID of the user whose privilege will be removed.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise it fails. To get extended error information, see ZoomSDKError.
Type
Number

(inner) SetOnLiveStreamReminderStatusChangeFailedCB(onLiveStreamReminderStatusChangeFailed) → {Boolean}

Description:
  • Set callback event when the live stream reminder enable status change fails.
Source:
Parameters:
Name Type Description
onLiveStreamReminderStatusChangeFailed function
Returns:
Type
Boolean

(inner) SetOnLiveStreamReminderStatusChangeFailedCB(onLiveStreamReminderStatusChangeFailed) → {Boolean}

Description:
  • Set callback event when the live stream reminder enable status change fails.
Source:
Parameters:
Name Type Description
onLiveStreamReminderStatusChangeFailed function
Returns:
Type
Boolean

(inner) SetOnLiveStreamReminderStatusChangedCB(onLiveStreamReminderStatusChanged) → {Boolean}

Description:
  • Set callback event when the live stream reminder enable status changes.
Source:
Parameters:
Name Type Description
onLiveStreamReminderStatusChanged function
Returns:
Type
Boolean

(inner) SetOnLiveStreamReminderStatusChangedCB(onLiveStreamReminderStatusChanged) → {Boolean}

Description:
  • Set callback event when the live stream reminder enable status changes.
Source:
Parameters:
Name Type Description
onLiveStreamReminderStatusChanged function
Returns:
Type
Boolean

(inner) SetOnLiveStreamStatusChangeCB(onLiveStreamStatusChange) → {Boolean}

Description:
  • Set the callback of live stream status change.
Source:
Parameters:
Name Type Description
onLiveStreamStatusChange function
Returns:
Type
Boolean

(inner) SetOnLiveStreamStatusChangeCB(onLiveStreamStatusChange) → {Boolean}

Description:
  • Set the callback of live stream status change.
Source:
Parameters:
Name Type Description
onLiveStreamStatusChange function
Returns:
Type
Boolean

(inner) SetOnRawLiveStreamPrivilegeChangedCB(onRawLiveStreamPrivilegeChanged) → {Boolean}

Description:
  • Set the callback of raw live stream privilege changed.
Source:
Parameters:
Name Type Description
onRawLiveStreamPrivilegeChanged function
Returns:
Type
Boolean

(inner) SetOnRawLiveStreamPrivilegeChangedCB(onRawLiveStreamPrivilegeChanged) → {Boolean}

Description:
  • Set the callback of raw live stream privilege changed.
Source:
Parameters:
Name Type Description
onRawLiveStreamPrivilegeChanged function
Returns:
Type
Boolean

(inner) SetOnRawLiveStreamPrivilegeRequestTimeoutCB(onRawLiveStreamPrivilegeRequestTimeout) → {Boolean}

Description:
  • Set the callback of raw live stream privilege request timeout.
Source:
Parameters:
Name Type Description
onRawLiveStreamPrivilegeRequestTimeout function
Returns:
Type
Boolean

(inner) SetOnRawLiveStreamPrivilegeRequestTimeoutCB(onRawLiveStreamPrivilegeRequestTimeout) → {Boolean}

Description:
  • Set the callback of raw live stream privilege request timeout.
Source:
Parameters:
Name Type Description
onRawLiveStreamPrivilegeRequestTimeout function
Returns:
Type
Boolean

(inner) SetOnRawLiveStreamPrivilegeRequestedCB(onRawLiveStreamPrivilegeRequested) → {Boolean}

Description:
  • Set the callback of raw live stream privilege requested.
Source:
Parameters:
Name Type Description
onRawLiveStreamPrivilegeRequested function
Returns:
Type
Boolean

(inner) SetOnRawLiveStreamPrivilegeRequestedCB(onRawLiveStreamPrivilegeRequested) → {Boolean}

Description:
  • Set the callback of raw live stream privilege requested.
Source:
Parameters:
Name Type Description
onRawLiveStreamPrivilegeRequested function
Returns:
Type
Boolean

(inner) SetOnUserRawLiveStreamPrivilegeChangedCB(onUserRawLiveStreamPrivilegeChanged) → {Boolean}

Description:
  • Set the callback of user raw live stream privilege changed.
Source:
Parameters:
Name Type Description
onUserRawLiveStreamPrivilegeChanged function
Returns:
Type
Boolean

(inner) SetOnUserRawLiveStreamPrivilegeChangedCB(onUserRawLiveStreamPrivilegeChanged) → {Boolean}

Description:
  • Set the callback of user raw live stream privilege changed.
Source:
Parameters:
Name Type Description
onUserRawLiveStreamPrivilegeChanged function
Returns:
Type
Boolean

(inner) SetOnUserRawLiveStreamingStatusChangedCB(onUserRawLiveStreamingStatusChanged) → {Boolean}

Description:
  • Set the callback of user raw live streaming status changed.
Source:
Parameters:
Name Type Description
onUserRawLiveStreamingStatusChanged function
Returns:
Type
Boolean

(inner) SetOnUserRawLiveStreamingStatusChangedCB(onUserRawLiveStreamingStatusChanged) → {Boolean}

Description:
  • Set the callback of user raw live streaming status changed.
Source:
Parameters:
Name Type Description
onUserRawLiveStreamingStatusChanged function
Returns:
Type
Boolean

(inner) SetOnUserThresholdReachedForLiveStreamCB(onUserThresholdReachedForLiveStream) → {Boolean}

Description:
  • Set callback event when the meeting or webinar user has nearly reached the meeting capacity, like 80% or 100% for the meeting or webinar capacity.
Source:
Parameters:
Name Type Description
onUserThresholdReachedForLiveStream function
Returns:
Type
Boolean

(inner) SetOnUserThresholdReachedForLiveStreamCB(onUserThresholdReachedForLiveStream) → {Boolean}

Description:
  • Set callback event when the meeting or webinar user has nearly reached the meeting capacity, like 80% or 100% for the meeting or webinar capacity.
Source:
Parameters:
Name Type Description
onUserThresholdReachedForLiveStream function
Returns:
Type
Boolean

(inner) StartLiveStream(liveStreamHandle) → {Number}

Description:
  • Start live streaming.
Source:
Parameters:
Name Type Description
liveStreamHandle Number the handle of live stream item
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) StartLiveStream(liveStreamHandle) → {Number}

Description:
  • Start live streaming.
Source:
Parameters:
Name Type Description
liveStreamHandle Number the handle of live stream item
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) StartLiveStreamWithSteamingURL(streamingURL, streamingKey, broadcastURL) → {Number}

Description:
  • Start live streaming. Get the parameters from the third party of live stream service
Source:
Parameters:
Name Type Description
streamingURL String The URL of live streaming.
streamingKey String The key of live streaming.
broadcastURL String The broadcast URL of live-stream.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) StartLiveStreamWithSteamingURL(streamingURL, streamingKey, broadcastURL) → {Number}

Description:
  • Start live streaming. Get the parameters from the third party of live stream service
Source:
Parameters:
Name Type Description
streamingURL String The URL of live streaming.
streamingKey String The key of live streaming.
broadcastURL String The broadcast URL of live-stream.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) StopLiveStream() → {Number}

Description:
  • Stop live streaming.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) StopLiveStream() → {Number}

Description:
  • Stop live streaming.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) StopRawLiveStream() → {Number}

Description:
  • Stop raw live streaming.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) StopRawLiveStream() → {Number}

Description:
  • Stop raw live streaming.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

Events

onLiveStreamReminderStatusChangeFailed

Description:
  • Callback event when the live stream reminder enable status change fails.
Source:

onLiveStreamReminderStatusChangeFailed

Description:
  • Callback event when the live stream reminder enable status change fails.
Source:

onLiveStreamReminderStatusChanged

Description:
  • Callback event when the live stream reminder enable status changes.
Source:
Parameters:
Name Type Description
enable Boolean True means the live stream reminder is enabled.

onLiveStreamReminderStatusChanged

Description:
  • Callback event when the live stream reminder enable status changes.
Source:
Parameters:
Name Type Description
enable Boolean True means the live stream reminder is enabled.

onLiveStreamStatusChange

Description:
  • Callback event when live stream status changes.
Source:
Parameters:
Name Type Description
status String Live stream status. For more details, see LiveStreamStatus enum.

onLiveStreamStatusChange

Description:
  • Callback event when live stream status changes.
Source:
Parameters:
Name Type Description
status String Live stream status. For more details, see LiveStreamStatus enum.

onRawLiveStreamPrivilegeChanged

Description:
  • Callback event when the current user's raw live streaming privilege changes.
Source:
Parameters:
Name Type Description
hasPrivilege Boolean Specify whether or not the user has privileg.

onRawLiveStreamPrivilegeChanged

Description:
  • Callback event when the current user's raw live streaming privilege changes.
Source:
Parameters:
Name Type Description
hasPrivilege Boolean Specify whether or not the user has privileg.

onRawLiveStreamPrivilegeRequestTimeout

Description:
  • Callback event when the current user's request has time out.
Source:

onRawLiveStreamPrivilegeRequestTimeout

Description:
  • Callback event when the current user's request has time out.
Source:

onRawLiveStreamPrivilegeRequested

Description:
  • Callback event when a user requests raw live streaming privilege.
Source:

onRawLiveStreamPrivilegeRequested

Description:
  • Callback event when a user requests raw live streaming privilege.
Source:

onUserRawLiveStreamPrivilegeChanged

Description:
  • Callback event when another user's raw live streaming privilege has changed.
Source:
Parameters:
Name Type Description
userid Number The ID of the user whose privilege has changed.
hasPrivilege Boolean Specify whether the user has privilege or not.

onUserRawLiveStreamPrivilegeChanged

Description:
  • Callback event when another user's raw live streaming privilege has changed.
Source:
Parameters:
Name Type Description
userid Number The ID of the user whose privilege has changed.
hasPrivilege Boolean Specify whether the user has privilege or not.

onUserRawLiveStreamingStatusChanged

Description:
  • Callback event when users start/stop raw live streaming.
Source:
Parameters:
Name Type Description
livingList Array list of users with an active raw live stream. contains object with broadcastUrl and userId

onUserRawLiveStreamingStatusChanged

Description:
  • Callback event when users start/stop raw live streaming.
Source:
Parameters:
Name Type Description
livingList Array list of users with an active raw live stream. contains object with broadcastUrl and userId

onUserThresholdReachedForLiveStream

Description:
  • Callback event when the meeting or webinar user has nearly reached the meeting capacity, like 80% or 100% for the meeting or webinar capacity. The host can start live stream to let unjoined user watch live stream.
Source:
Parameters:
Name Type Description
percent Number Proportion of joined users to the total capacity.

onUserThresholdReachedForLiveStream

Description:
  • Callback event when the meeting or webinar user has nearly reached the meeting capacity, like 80% or 100% for the meeting or webinar capacity. The host can start live stream to let unjoined user watch live stream.
Source:
Parameters:
Name Type Description
percent Number Proportion of joined users to the total capacity.