zoom_meeting_webinar

Zoom Meeting Webinar
Description:
  • Zoom Meeting Webinar
Source:
Parameters:
Name Type Description
onPromptAttendee2PanelistResult function Callback to promote attendees to panelist.
onDepromptPanelist2AttendeeResult function Callback to demote attendees to panelist.
onAllowPanelistStartVideoNotification function Callback to enable the panelist to start the video.
onDisallowPanelistStartVideoNotification function Callback to disable the panelist to start the video.
onSelfAllowTalkNotification function Callback event that attendees are required to enable the mic in the view-only mode of webinar.
onSelfDisallowTalkNotification function Callback event that attendees are required to turn off the mic in the view-only mode of webinar.
onAllowAttendeeChatNotification function Callback to enable the attendees to chat. Available only for the host and the co-host.
onDisallowAttendeeChatNotification function Callback to disable the attendees to chat. Available only for the host and the co-host.
onAllowWebinarReactionStatusChanged function Callback to emoji Reactions Status Changed.
onAllowAttendeeRaiseHandStatusChanged function Callback to attendee raise hand Status Changed.
onAllowAttendeeViewTheParticipantCountStatusChanged function Callback to attendee view the participant count status Changed.
onAttendeeAudioStatusNotification function Attendee will receive this callback if his audio status changes.
onAttendeePromoteConfirmResult function When attendee agree or decline the promote invitation, host will receive this callback.
Returns:
Type
ZoomMeetingWebinar
Description:
  • Zoom Meeting Webinar
Source:
Parameters:
Name Type Description
onPromptAttendee2PanelistResult function Callback to promote attendees to panelist.
onDepromptPanelist2AttendeeResult function Callback to demote attendees to panelist.
onAllowPanelistStartVideoNotification function Callback to enable the panelist to start the video.
onDisallowPanelistStartVideoNotification function Callback to disable the panelist to start the video.
onSelfAllowTalkNotification function Callback event that attendees are required to enable the mic in the view-only mode of webinar.
onSelfDisallowTalkNotification function Callback event that attendees are required to turn off the mic in the view-only mode of webinar.
onAllowAttendeeChatNotification function Callback to enable the attendees to chat. Available only for the host and the co-host.
onDisallowAttendeeChatNotification function Callback to disable the attendees to chat. Available only for the host and the co-host.
onAllowWebinarReactionStatusChanged function Callback to emoji Reactions Status Changed.
onAllowAttendeeRaiseHandStatusChanged function Callback to attendee raise hand Status Changed.
onAllowAttendeeViewTheParticipantCountStatusChanged function Callback to attendee view the participant count status Changed.
onAttendeeAudioStatusNotification function Attendee will receive this callback if his audio status changes.
onAttendeePromoteConfirmResult function When attendee agree or decline the promote invitation, host will receive this callback.
Returns:
Type
ZoomMeetingWebinar

Methods

(inner) AllowAttendeeRaiseHand() → {Number}

Description:
  • The attendee is permitted to use the raise hand. If the function succeeds, the user will receive the onAllowAttendeeRaiseHandStatusChanged(bool) callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) AllowAttendeeRaiseHand() → {Number}

Description:
  • The attendee is permitted to use the raise hand. If the function succeeds, the user will receive the onAllowAttendeeRaiseHandStatusChanged(bool) callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) AllowAttendeeTalk(userid) → {Number}

Description:
  • The attendee is permitted to use the audio device. If the function succeeds, the user will receive the onAllowAttendeeChatNotification() callback event. Available only for the host.
Source:
Parameters:
Name Type Description
userid Number Specifies the permitted user ID.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) AllowAttendeeTalk(userid) → {Number}

Description:
  • The attendee is permitted to use the audio device. If the function succeeds, the user will receive the onAllowAttendeeChatNotification() callback event. Available only for the host.
Source:
Parameters:
Name Type Description
userid Number Specifies the permitted user ID.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) AllowAttendeeViewTheParticipantCount() → {Number}

Description:
  • The attendee is permitted to view the participant count. If the function succeeds, the user will receive the onAllowAttendeeViewTheParticipantCountStatusChanged(bool) callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) AllowAttendeeViewTheParticipantCount() → {Number}

Description:
  • The attendee is permitted to view the participant count. If the function succeeds, the user will receive the onAllowAttendeeViewTheParticipantCountStatusChanged(bool) callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) AllowPanelistStartVideo() → {Number}

Description:
  • The panelist is permitted to start the video. If the function succeeds, the user will receive the onAllowPanelistStartVideoNotification() callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) AllowPanelistStartVideo() → {Number}

Description:
  • The panelist is permitted to start the video. If the function succeeds, the user will receive the onAllowPanelistStartVideoNotification() callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) AllowWebinarEmojiReaction() → {Number}

Description:
  • Permitted to use emoji reactions. If the function succeeds, the user will receive the onAllowWebinarReactionStatusChanged(bool) callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) AllowWebinarEmojiReaction() → {Number}

Description:
  • Permitted to use emoji reactions. If the function succeeds, the user will receive the onAllowWebinarReactionStatusChanged(bool) callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) DepromptPanelist2Attendee(userid) → {Number}

Description:
  • Demote the panelist to attendee. Available only for the host. If the function succeeds, the user will receive the onDepromptPanelist2AttendeeResult() callback event.
Source:
Parameters:
Name Type Description
userid Number Specifies the user ID to demote.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) DepromptPanelist2Attendee(userid) → {Number}

Description:
  • Demote the panelist to attendee. Available only for the host. If the function succeeds, the user will receive the onDepromptPanelist2AttendeeResult() callback event.
Source:
Parameters:
Name Type Description
userid Number Specifies the user ID to demote.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) DisallowAttendeeRaiseHand() → {Number}

Description:
  • Forbid the attendee to use the raise hand. If the function succeeds, the user will receive the onAllowAttendeeRaiseHandStatusChanged(bool) callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) DisallowAttendeeRaiseHand() → {Number}

Description:
  • Forbid the attendee to use the raise hand. If the function succeeds, the user will receive the onAllowAttendeeRaiseHandStatusChanged(bool) callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) DisallowAttendeeTalk(userid) → {Number}

Description:
  • Forbid the attendee to use the audio device. If the function succeeds, the user will receive the onDisallowAttendeeChatNotification() callback event. Available only for the host.
Source:
Parameters:
Name Type Description
userid Number Specifies the forbidden user ID.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) DisallowAttendeeTalk(userid) → {Number}

Description:
  • Forbid the attendee to use the audio device. If the function succeeds, the user will receive the onDisallowAttendeeChatNotification() callback event. Available only for the host.
Source:
Parameters:
Name Type Description
userid Number Specifies the forbidden user ID.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) DisallowAttendeeViewTheParticipantCount() → {Number}

Description:
  • Forbid the attendee to view the participant count. If the function succeeds, the user will receive the onAllowAttendeeViewTheParticipantCountStatusChanged(bool) callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) DisallowAttendeeViewTheParticipantCount() → {Number}

Description:
  • Forbid the attendee to view the participant count. If the function succeeds, the user will receive the onAllowAttendeeViewTheParticipantCountStatusChanged(bool) callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) DisallowPanelistStartVideo() → {Number}

Description:
  • Forbid the panelist to start video. If the function succeeds, the user will receive the onDisallowPanelistStartVideoNotification() callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) DisallowPanelistStartVideo() → {Number}

Description:
  • Forbid the panelist to start video. If the function succeeds, the user will receive the onDisallowPanelistStartVideoNotification() callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) DisallowWebinarEmojiReaction() → {Number}

Description:
  • Forbid to use emoji reactions. If the function succeeds, the user will receive the onAllowWebinarReactionStatusChanged(bool) callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) DisallowWebinarEmojiReaction() → {Number}

Description:
  • Forbid to use emoji reactions. If the function succeeds, the user will receive the onAllowWebinarReactionStatusChanged(bool) callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) GetAttendeeViewMode() → {Number}

Description:
  • Get the view mode of the attendee.Available only for zoom ui.
Source:
Returns:
If the function succeeds, it will return the attendee's view mode, Defined in: SDKAttendeeViewMode
Type
Number

(inner) GetAttendeeViewMode() → {Number}

Description:
  • Get the view mode of the attendee.Available only for zoom ui.
Source:
Returns:
If the function succeeds, it will return the attendee's view mode, Defined in: SDKAttendeeViewMode
Type
Number

(inner) GetPanelistChatPrivilege() → {Number}

Description:
  • Get the chat privilege of the panelist.
Source:
Returns:
The chat privilege of the panelist, Defined in: SDKPanelistChatPrivilege
Type
Number

(inner) GetPanelistChatPrivilege() → {Number}

Description:
  • Get the chat privilege of the panelist.
Source:
Returns:
The chat privilege of the panelist, Defined in: SDKPanelistChatPrivilege
Type
Number

(inner) GetParticipantCount() → {Number}

Description:
  • Get the participant count.
Source:
Returns:
The count of participant.
Type
Number

(inner) GetParticipantCount() → {Number}

Description:
  • Get the participant count.
Source:
Returns:
The count of participant.
Type
Number

(inner) GetWebinarLegalNoticesExplained() → {Object}

Description:
  • Get the webinar legal notices explained.
Source:
Returns:
The webinar legal notices explained.
Type
Object

(inner) GetWebinarLegalNoticesExplained() → {Object}

Description:
  • Get the webinar legal notices explained.
Source:
Returns:
The webinar legal notices explained.
Type
Object

(inner) GetWebinarLegalNoticesPrompt() → {String}

Description:
  • Get the webinar legal notices prompt.
Source:
Returns:
The webinar legal notices prompt.
Type
String

(inner) GetWebinarLegalNoticesPrompt() → {String}

Description:
  • Get the webinar legal notices prompt.
Source:
Returns:
The webinar legal notices prompt.
Type
String

(inner) GetWebinarMeetingStatus() → {Object}

Description:
  • Get the webinar status.
Source:
Returns:
The status of webinar.
Type
Object

(inner) GetWebinarMeetingStatus() → {Object}

Description:
  • Get the webinar status.
Source:
Returns:
The status of webinar.
Type
Object

(inner) IsSupportAttendeeTalk() → {Number}

Description:
  • Query if the webinar supports the user to use the audio device.
Source:
Deprecated:
  • This interface is marked as deprecated.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) IsSupportAttendeeTalk() → {Number}

Description:
  • Query if the webinar supports the user to use the audio device.
Source:
Deprecated:
  • This interface is marked as deprecated.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) IsWebinarEmojiReactionSupported() → {Boolean}

Description:
  • Determine if current webinar support emoji reaction.
Source:
Returns:
True means the current webinar supports emoji reactions. Otherwise false.
Type
Boolean

(inner) IsWebinarEmojiReactionSupported() → {Boolean}

Description:
  • Determine if current webinar support emoji reaction.
Source:
Returns:
True means the current webinar supports emoji reactions. Otherwise false.
Type
Boolean

(inner) PromptAttendee2Panelist(userid) → {Number}

Description:
  • Promote the attendee to panelist. Available only for the meeting host. If the function succeeds, the user will receive the onPromptAttendee2PanelistResult() callback event.
Source:
Parameters:
Name Type Description
userid Number Specifies the user ID to promote.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) PromptAttendee2Panelist(userid) → {Number}

Description:
  • Promote the attendee to panelist. Available only for the meeting host. If the function succeeds, the user will receive the onPromptAttendee2PanelistResult() callback event.
Source:
Parameters:
Name Type Description
userid Number Specifies the user ID to promote.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) SetAttendeeViewMode(mode) → {Number}

Description:
  • Set the view mode of the attendee. Available only for zoom ui.
Source:
Parameters:
Name Type Description
mode Number The view mode of the attendee, Defined in: SDKAttendeeViewMode
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) SetAttendeeViewMode(mode) → {Number}

Description:
  • Set the view mode of the attendee. Available only for zoom ui.
Source:
Parameters:
Name Type Description
mode Number The view mode of the attendee, Defined in: SDKAttendeeViewMode
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) SetOnAllowAttendeeChatNotificationCB(onAllowAttendeeChatNotification) → {Boolean}

Description:
  • Set callback to enable the attendees to chat. Available only for the host and the co-host.
Source:
Parameters:
Name Type Description
onAllowAttendeeChatNotification function
Returns:
Type
Boolean

(inner) SetOnAllowAttendeeChatNotificationCB(onAllowAttendeeChatNotification) → {Boolean}

Description:
  • Set callback to enable the attendees to chat. Available only for the host and the co-host.
Source:
Parameters:
Name Type Description
onAllowAttendeeChatNotification function
Returns:
Type
Boolean

(inner) SetOnAllowAttendeeRaiseHandStatusChangedCB(onAllowAttendeeRaiseHandStatusChanged) → {Boolean}

Description:
  • Set callback to attendee raise hand Status Changed.
Source:
Parameters:
Name Type Description
onAllowAttendeeRaiseHandStatusChanged function
Returns:
Type
Boolean

(inner) SetOnAllowAttendeeRaiseHandStatusChangedCB(onAllowAttendeeRaiseHandStatusChanged) → {Boolean}

Description:
  • Set callback to attendee raise hand Status Changed.
Source:
Parameters:
Name Type Description
onAllowAttendeeRaiseHandStatusChanged function
Returns:
Type
Boolean

(inner) SetOnAllowAttendeeViewTheParticipantCountStatusChangedCB(onAllowAttendeeViewTheParticipantCountStatusChanged) → {Boolean}

Description:
  • Set callback to attendee view the participant count status Changed.
Source:
Parameters:
Name Type Description
onAllowAttendeeViewTheParticipantCountStatusChanged function
Returns:
Type
Boolean

(inner) SetOnAllowAttendeeViewTheParticipantCountStatusChangedCB(onAllowAttendeeViewTheParticipantCountStatusChanged) → {Boolean}

Description:
  • Set callback to attendee view the participant count status Changed.
Source:
Parameters:
Name Type Description
onAllowAttendeeViewTheParticipantCountStatusChanged function
Returns:
Type
Boolean

(inner) SetOnAllowPanelistStartVideoNotificationCB(onAllowPanelistStartVideoNotification) → {Boolean}

Description:
  • Set callback to enable the panelist to start the video.
Source:
Parameters:
Name Type Description
onAllowPanelistStartVideoNotification function
Returns:
Type
Boolean

(inner) SetOnAllowPanelistStartVideoNotificationCB(onAllowPanelistStartVideoNotification) → {Boolean}

Description:
  • Set callback to enable the panelist to start the video.
Source:
Parameters:
Name Type Description
onAllowPanelistStartVideoNotification function
Returns:
Type
Boolean

(inner) SetOnAllowWebinarReactionStatusChangedCB(onAllowWebinarReactionStatusChanged) → {Boolean}

Description:
  • Set callback to emoji Reactions Status Changed.
Source:
Parameters:
Name Type Description
onAllowWebinarReactionStatusChanged function
Returns:
Type
Boolean

(inner) SetOnAllowWebinarReactionStatusChangedCB(onAllowWebinarReactionStatusChanged) → {Boolean}

Description:
  • Set callback to emoji Reactions Status Changed.
Source:
Parameters:
Name Type Description
onAllowWebinarReactionStatusChanged function
Returns:
Type
Boolean

(inner) SetOnAttendeeAudioStatusNotificationCB(onAttendeeAudioStatusNotification) → {Boolean}

Description:
  • Set attendee will receive this callback if his audio status changes callback.
Source:
Parameters:
Name Type Description
onAttendeeAudioStatusNotification function
Returns:
Type
Boolean

(inner) SetOnAttendeeAudioStatusNotificationCB(onAttendeeAudioStatusNotification) → {Boolean}

Description:
  • Set attendee will receive this callback if his audio status changes callback.
Source:
Parameters:
Name Type Description
onAttendeeAudioStatusNotification function
Returns:
Type
Boolean

(inner) SetOnAttendeePromoteConfirmResultCB(onAttendeePromoteConfirmResult) → {Boolean}

Description:
  • Set when attendee agree or decline the promote invitation, host will receive this callback.
Source:
Parameters:
Name Type Description
onAttendeePromoteConfirmResult function
Returns:
Type
Boolean

(inner) SetOnAttendeePromoteConfirmResultCB(onAttendeePromoteConfirmResult) → {Boolean}

Description:
  • Set when attendee agree or decline the promote invitation, host will receive this callback.
Source:
Parameters:
Name Type Description
onAttendeePromoteConfirmResult function
Returns:
Type
Boolean

(inner) SetOnDepromptPanelist2AttendeeResultCB(onDepromptPanelist2AttendeeResult) → {Boolean}

Description:
  • Set callback to demote attendees to panelist.
Source:
Parameters:
Name Type Description
onDepromptPanelist2AttendeeResult function
Returns:
Type
Boolean

(inner) SetOnDepromptPanelist2AttendeeResultCB(onDepromptPanelist2AttendeeResult) → {Boolean}

Description:
  • Set callback to demote attendees to panelist.
Source:
Parameters:
Name Type Description
onDepromptPanelist2AttendeeResult function
Returns:
Type
Boolean

(inner) SetOnDisallowAttendeeChatNotificationCB(onDisallowAttendeeChatNotification) → {Boolean}

Description:
  • Set callback to disable the attendees to chat. Available only for the host and the co-host.
Source:
Parameters:
Name Type Description
onDisallowAttendeeChatNotification function
Returns:
Type
Boolean

(inner) SetOnDisallowAttendeeChatNotificationCB(onDisallowAttendeeChatNotification) → {Boolean}

Description:
  • Set callback to disable the attendees to chat. Available only for the host and the co-host.
Source:
Parameters:
Name Type Description
onDisallowAttendeeChatNotification function
Returns:
Type
Boolean

(inner) SetOnDisallowPanelistStartVideoNotificationCB(onDisallowPanelistStartVideoNotification) → {Boolean}

Description:
  • Set callback to disable the panelist to start the video.
Source:
Parameters:
Name Type Description
onDisallowPanelistStartVideoNotification function
Returns:
Type
Boolean

(inner) SetOnDisallowPanelistStartVideoNotificationCB(onDisallowPanelistStartVideoNotification) → {Boolean}

Description:
  • Set callback to disable the panelist to start the video.
Source:
Parameters:
Name Type Description
onDisallowPanelistStartVideoNotification function
Returns:
Type
Boolean

(inner) SetOnPromptAttendee2PanelistResultCB(onPromptAttendee2PanelistResult) → {Boolean}

Description:
  • Set callback to promote attendees to panelist.
Source:
Parameters:
Name Type Description
onPromptAttendee2PanelistResult function
Returns:
Type
Boolean

(inner) SetOnPromptAttendee2PanelistResultCB(onPromptAttendee2PanelistResult) → {Boolean}

Description:
  • Set callback to promote attendees to panelist.
Source:
Parameters:
Name Type Description
onPromptAttendee2PanelistResult function
Returns:
Type
Boolean

(inner) SetOnSelfAllowTalkNotificationCB(onSelfAllowTalkNotification) → {Boolean}

Description:
  • Set callback event that attendees are required to enable the mic in the view-only mode of webinar.
Source:
Parameters:
Name Type Description
onSelfAllowTalkNotification function
Returns:
Type
Boolean

(inner) SetOnSelfAllowTalkNotificationCB(onSelfAllowTalkNotification) → {Boolean}

Description:
  • Set callback event that attendees are required to enable the mic in the view-only mode of webinar.
Source:
Parameters:
Name Type Description
onSelfAllowTalkNotification function
Returns:
Type
Boolean

(inner) SetOnSelfDisallowTalkNotificationCB(onSelfDisallowTalkNotification) → {Boolean}

Description:
  • Set callback event that attendees are required to turn off the mic in the view-only mode of webinar.
Source:
Parameters:
Name Type Description
onSelfDisallowTalkNotification function
Returns:
Type
Boolean

(inner) SetOnSelfDisallowTalkNotificationCB(onSelfDisallowTalkNotification) → {Boolean}

Description:
  • Set callback event that attendees are required to turn off the mic in the view-only mode of webinar.
Source:
Parameters:
Name Type Description
onSelfDisallowTalkNotification function
Returns:
Type
Boolean

(inner) SetPanelistChatPrivilege(privilege) → {Number}

Description:
  • Set the chat privilege of the panelist.
Source:
Parameters:
Name Type Description
privilege Number The chat privilege of the panelist, Defined in: SDKPanelistChatPrivilege
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) SetPanelistChatPrivilege(privilege) → {Number}

Description:
  • Set the chat privilege of the panelist.
Source:
Parameters:
Name Type Description
privilege Number The chat privilege of the panelist, Defined in: SDKPanelistChatPrivilege
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

Events

onAllowAttendeeChatNotification

Description:
  • Callback to enable the attendees to chat. Available only for the host and the co-host.
Source:

onAllowAttendeeChatNotification

Description:
  • Callback to enable the attendees to chat. Available only for the host and the co-host.
Source:

onAllowAttendeeRaiseHandStatusChanged

Description:
  • Callback to attendee raise hand Status Changed.
Source:
Parameters:
Name Type Description
can_raiseHand Boolean If the raise hand is allow, the result is true, False not.

onAllowAttendeeRaiseHandStatusChanged

Description:
  • Callback to attendee raise hand Status Changed.
Source:
Parameters:
Name Type Description
can_raiseHand Boolean If the raise hand is allow, the result is true, False not.

onAllowAttendeeViewTheParticipantCountStatusChanged

Description:
  • Callback to attendee view the participant count status Changed.
Source:
Parameters:
Name Type Description
can_viewParticipantCount Boolean If attendee view the participant count is allow, the result is true, False not.

onAllowAttendeeViewTheParticipantCountStatusChanged

Description:
  • Callback to attendee view the participant count status Changed.
Source:
Parameters:
Name Type Description
can_viewParticipantCount Boolean If attendee view the participant count is allow, the result is true, False not.

onAllowPanelistStartVideoNotification

Description:
  • Callback to enable the panelist to start the video.
Source:

onAllowPanelistStartVideoNotification

Description:
  • Callback to enable the panelist to start the video.
Source:

onAllowWebinarReactionStatusChanged

Description:
  • Callback to emoji Reactions Status Changed.
Source:
Parameters:
Name Type Description
can_reaction Boolean If the Reaction is allow, the result is true, False not.

onAllowWebinarReactionStatusChanged

Description:
  • Callback to emoji Reactions Status Changed.
Source:
Parameters:
Name Type Description
can_reaction Boolean If the Reaction is allow, the result is true, False not.

onAttendeeAudioStatusNotification

Description:
  • Attendee will receive this callback if his audio status changes.
Source:
Parameters:
Name Type Description
userid Number The ID of the user whose audio status changes.
can_talk Boolean True indicates that it is able to use the audio. False not.
is_muted Boolean TRUE indicates muted, FALSE not. This parameter works only when the value of can_talk is TRUE.

onAttendeeAudioStatusNotification

Description:
  • Attendee will receive this callback if his audio status changes.
Source:
Parameters:
Name Type Description
userid Number The ID of the user whose audio status changes.
can_talk Boolean True indicates that it is able to use the audio. False not.
is_muted Boolean TRUE indicates muted, FALSE not. This parameter works only when the value of can_talk is TRUE.

onAttendeePromoteConfirmResult

Description:
  • When attendee agree or decline the promote invitation, host will receive this callback.
Source:
Parameters:
Name Type Description
agree Boolean if attendee agree return true, otherwise false.
userid Number The attendee user id.

onAttendeePromoteConfirmResult

Description:
  • When attendee agree or decline the promote invitation, host will receive this callback.
Source:
Parameters:
Name Type Description
agree Boolean if attendee agree return true, otherwise false.
userid Number The attendee user id.

onDepromptPanelist2AttendeeResult

Description:
  • Callback to demote attendees to panelist.
Source:
Parameters:
Name Type Description
result Number If the demotion is successful, the result is zero(0), otherwise an error code.

onDepromptPanelist2AttendeeResult

Description:
  • Callback to demote attendees to panelist.
Source:
Parameters:
Name Type Description
result Number If the demotion is successful, the result is zero(0), otherwise an error code.

onDisallowAttendeeChatNotification

Description:
  • Callback to disable the attendees to chat. Available only for the host and the co-host.
Source:

onDisallowAttendeeChatNotification

Description:
  • Callback to disable the attendees to chat. Available only for the host and the co-host.
Source:

onDisallowPanelistStartVideoNotification

Description:
  • Callback to disable the panelist to start the video.
Source:

onDisallowPanelistStartVideoNotification

Description:
  • Callback to disable the panelist to start the video.
Source:

onPromptAttendee2PanelistResult

Description:
  • Callback to promote attendees to panelist.
Source:
Parameters:
Name Type Description
result Number If the promotion is successful, the result is zero(0). Otherwise it is an error code.

onPromptAttendee2PanelistResult

Description:
  • Callback to promote attendees to panelist.
Source:
Parameters:
Name Type Description
result Number If the promotion is successful, the result is zero(0). Otherwise it is an error code.

onSelfAllowTalkNotification

Description:
  • Callback event that attendees are required to enable the mic in the view-only mode of webinar.
Source:

onSelfAllowTalkNotification

Description:
  • Callback event that attendees are required to enable the mic in the view-only mode of webinar.
Source:

onSelfDisallowTalkNotification

Description:
  • Callback event that attendees are required to turn off the mic in the view-only mode of webinar.
Source:

onSelfDisallowTalkNotification

Description:
  • Callback event that attendees are required to turn off the mic in the view-only mode of webinar.
Source:
Zoom Meeting Webinar
Description:
  • Zoom Meeting Webinar
Source:
Parameters:
Name Type Description
onPromptAttendee2PanelistResult function Callback to promote attendees to panelist.
onDepromptPanelist2AttendeeResult function Callback to demote attendees to panelist.
onAllowPanelistStartVideoNotification function Callback to enable the panelist to start the video.
onDisallowPanelistStartVideoNotification function Callback to disable the panelist to start the video.
onSelfAllowTalkNotification function Callback event that attendees are required to enable the mic in the view-only mode of webinar.
onSelfDisallowTalkNotification function Callback event that attendees are required to turn off the mic in the view-only mode of webinar.
onAllowAttendeeChatNotification function Callback to enable the attendees to chat. Available only for the host and the co-host.
onDisallowAttendeeChatNotification function Callback to disable the attendees to chat. Available only for the host and the co-host.
onAllowWebinarReactionStatusChanged function Callback to emoji Reactions Status Changed.
onAllowAttendeeRaiseHandStatusChanged function Callback to attendee raise hand Status Changed.
onAllowAttendeeViewTheParticipantCountStatusChanged function Callback to attendee view the participant count status Changed.
onAttendeeAudioStatusNotification function Attendee will receive this callback if his audio status changes.
onAttendeePromoteConfirmResult function When attendee agree or decline the promote invitation, host will receive this callback.
Returns:
Type
ZoomMeetingWebinar
Description:
  • Zoom Meeting Webinar
Source:
Parameters:
Name Type Description
onPromptAttendee2PanelistResult function Callback to promote attendees to panelist.
onDepromptPanelist2AttendeeResult function Callback to demote attendees to panelist.
onAllowPanelistStartVideoNotification function Callback to enable the panelist to start the video.
onDisallowPanelistStartVideoNotification function Callback to disable the panelist to start the video.
onSelfAllowTalkNotification function Callback event that attendees are required to enable the mic in the view-only mode of webinar.
onSelfDisallowTalkNotification function Callback event that attendees are required to turn off the mic in the view-only mode of webinar.
onAllowAttendeeChatNotification function Callback to enable the attendees to chat. Available only for the host and the co-host.
onDisallowAttendeeChatNotification function Callback to disable the attendees to chat. Available only for the host and the co-host.
onAllowWebinarReactionStatusChanged function Callback to emoji Reactions Status Changed.
onAllowAttendeeRaiseHandStatusChanged function Callback to attendee raise hand Status Changed.
onAllowAttendeeViewTheParticipantCountStatusChanged function Callback to attendee view the participant count status Changed.
onAttendeeAudioStatusNotification function Attendee will receive this callback if his audio status changes.
onAttendeePromoteConfirmResult function When attendee agree or decline the promote invitation, host will receive this callback.
Returns:
Type
ZoomMeetingWebinar

Methods

(inner) AllowAttendeeRaiseHand() → {Number}

Description:
  • The attendee is permitted to use the raise hand. If the function succeeds, the user will receive the onAllowAttendeeRaiseHandStatusChanged(bool) callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) AllowAttendeeRaiseHand() → {Number}

Description:
  • The attendee is permitted to use the raise hand. If the function succeeds, the user will receive the onAllowAttendeeRaiseHandStatusChanged(bool) callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) AllowAttendeeTalk(userid) → {Number}

Description:
  • The attendee is permitted to use the audio device. If the function succeeds, the user will receive the onAllowAttendeeChatNotification() callback event. Available only for the host.
Source:
Parameters:
Name Type Description
userid Number Specifies the permitted user ID.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) AllowAttendeeTalk(userid) → {Number}

Description:
  • The attendee is permitted to use the audio device. If the function succeeds, the user will receive the onAllowAttendeeChatNotification() callback event. Available only for the host.
Source:
Parameters:
Name Type Description
userid Number Specifies the permitted user ID.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) AllowAttendeeViewTheParticipantCount() → {Number}

Description:
  • The attendee is permitted to view the participant count. If the function succeeds, the user will receive the onAllowAttendeeViewTheParticipantCountStatusChanged(bool) callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) AllowAttendeeViewTheParticipantCount() → {Number}

Description:
  • The attendee is permitted to view the participant count. If the function succeeds, the user will receive the onAllowAttendeeViewTheParticipantCountStatusChanged(bool) callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) AllowPanelistStartVideo() → {Number}

Description:
  • The panelist is permitted to start the video. If the function succeeds, the user will receive the onAllowPanelistStartVideoNotification() callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) AllowPanelistStartVideo() → {Number}

Description:
  • The panelist is permitted to start the video. If the function succeeds, the user will receive the onAllowPanelistStartVideoNotification() callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) AllowWebinarEmojiReaction() → {Number}

Description:
  • Permitted to use emoji reactions. If the function succeeds, the user will receive the onAllowWebinarReactionStatusChanged(bool) callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) AllowWebinarEmojiReaction() → {Number}

Description:
  • Permitted to use emoji reactions. If the function succeeds, the user will receive the onAllowWebinarReactionStatusChanged(bool) callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) DepromptPanelist2Attendee(userid) → {Number}

Description:
  • Demote the panelist to attendee. Available only for the host. If the function succeeds, the user will receive the onDepromptPanelist2AttendeeResult() callback event.
Source:
Parameters:
Name Type Description
userid Number Specifies the user ID to demote.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) DepromptPanelist2Attendee(userid) → {Number}

Description:
  • Demote the panelist to attendee. Available only for the host. If the function succeeds, the user will receive the onDepromptPanelist2AttendeeResult() callback event.
Source:
Parameters:
Name Type Description
userid Number Specifies the user ID to demote.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) DisallowAttendeeRaiseHand() → {Number}

Description:
  • Forbid the attendee to use the raise hand. If the function succeeds, the user will receive the onAllowAttendeeRaiseHandStatusChanged(bool) callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) DisallowAttendeeRaiseHand() → {Number}

Description:
  • Forbid the attendee to use the raise hand. If the function succeeds, the user will receive the onAllowAttendeeRaiseHandStatusChanged(bool) callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) DisallowAttendeeTalk(userid) → {Number}

Description:
  • Forbid the attendee to use the audio device. If the function succeeds, the user will receive the onDisallowAttendeeChatNotification() callback event. Available only for the host.
Source:
Parameters:
Name Type Description
userid Number Specifies the forbidden user ID.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) DisallowAttendeeTalk(userid) → {Number}

Description:
  • Forbid the attendee to use the audio device. If the function succeeds, the user will receive the onDisallowAttendeeChatNotification() callback event. Available only for the host.
Source:
Parameters:
Name Type Description
userid Number Specifies the forbidden user ID.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) DisallowAttendeeViewTheParticipantCount() → {Number}

Description:
  • Forbid the attendee to view the participant count. If the function succeeds, the user will receive the onAllowAttendeeViewTheParticipantCountStatusChanged(bool) callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) DisallowAttendeeViewTheParticipantCount() → {Number}

Description:
  • Forbid the attendee to view the participant count. If the function succeeds, the user will receive the onAllowAttendeeViewTheParticipantCountStatusChanged(bool) callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) DisallowPanelistStartVideo() → {Number}

Description:
  • Forbid the panelist to start video. If the function succeeds, the user will receive the onDisallowPanelistStartVideoNotification() callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) DisallowPanelistStartVideo() → {Number}

Description:
  • Forbid the panelist to start video. If the function succeeds, the user will receive the onDisallowPanelistStartVideoNotification() callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) DisallowWebinarEmojiReaction() → {Number}

Description:
  • Forbid to use emoji reactions. If the function succeeds, the user will receive the onAllowWebinarReactionStatusChanged(bool) callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) DisallowWebinarEmojiReaction() → {Number}

Description:
  • Forbid to use emoji reactions. If the function succeeds, the user will receive the onAllowWebinarReactionStatusChanged(bool) callback event. Available only for the host.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) GetAttendeeViewMode() → {Number}

Description:
  • Get the view mode of the attendee.Available only for zoom ui.
Source:
Returns:
If the function succeeds, it will return the attendee's view mode, Defined in: SDKAttendeeViewMode
Type
Number

(inner) GetAttendeeViewMode() → {Number}

Description:
  • Get the view mode of the attendee.Available only for zoom ui.
Source:
Returns:
If the function succeeds, it will return the attendee's view mode, Defined in: SDKAttendeeViewMode
Type
Number

(inner) GetPanelistChatPrivilege() → {Number}

Description:
  • Get the chat privilege of the panelist.
Source:
Returns:
The chat privilege of the panelist, Defined in: SDKPanelistChatPrivilege
Type
Number

(inner) GetPanelistChatPrivilege() → {Number}

Description:
  • Get the chat privilege of the panelist.
Source:
Returns:
The chat privilege of the panelist, Defined in: SDKPanelistChatPrivilege
Type
Number

(inner) GetParticipantCount() → {Number}

Description:
  • Get the participant count.
Source:
Returns:
The count of participant.
Type
Number

(inner) GetParticipantCount() → {Number}

Description:
  • Get the participant count.
Source:
Returns:
The count of participant.
Type
Number

(inner) GetWebinarLegalNoticesExplained() → {Object}

Description:
  • Get the webinar legal notices explained.
Source:
Returns:
The webinar legal notices explained.
Type
Object

(inner) GetWebinarLegalNoticesExplained() → {Object}

Description:
  • Get the webinar legal notices explained.
Source:
Returns:
The webinar legal notices explained.
Type
Object

(inner) GetWebinarLegalNoticesPrompt() → {String}

Description:
  • Get the webinar legal notices prompt.
Source:
Returns:
The webinar legal notices prompt.
Type
String

(inner) GetWebinarLegalNoticesPrompt() → {String}

Description:
  • Get the webinar legal notices prompt.
Source:
Returns:
The webinar legal notices prompt.
Type
String

(inner) GetWebinarMeetingStatus() → {Object}

Description:
  • Get the webinar status.
Source:
Returns:
The status of webinar.
Type
Object

(inner) GetWebinarMeetingStatus() → {Object}

Description:
  • Get the webinar status.
Source:
Returns:
The status of webinar.
Type
Object

(inner) IsSupportAttendeeTalk() → {Number}

Description:
  • Query if the webinar supports the user to use the audio device.
Source:
Deprecated:
  • This interface is marked as deprecated.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) IsSupportAttendeeTalk() → {Number}

Description:
  • Query if the webinar supports the user to use the audio device.
Source:
Deprecated:
  • This interface is marked as deprecated.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) IsWebinarEmojiReactionSupported() → {Boolean}

Description:
  • Determine if current webinar support emoji reaction.
Source:
Returns:
True means the current webinar supports emoji reactions. Otherwise false.
Type
Boolean

(inner) IsWebinarEmojiReactionSupported() → {Boolean}

Description:
  • Determine if current webinar support emoji reaction.
Source:
Returns:
True means the current webinar supports emoji reactions. Otherwise false.
Type
Boolean

(inner) PromptAttendee2Panelist(userid) → {Number}

Description:
  • Promote the attendee to panelist. Available only for the meeting host. If the function succeeds, the user will receive the onPromptAttendee2PanelistResult() callback event.
Source:
Parameters:
Name Type Description
userid Number Specifies the user ID to promote.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) PromptAttendee2Panelist(userid) → {Number}

Description:
  • Promote the attendee to panelist. Available only for the meeting host. If the function succeeds, the user will receive the onPromptAttendee2PanelistResult() callback event.
Source:
Parameters:
Name Type Description
userid Number Specifies the user ID to promote.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) SetAttendeeViewMode(mode) → {Number}

Description:
  • Set the view mode of the attendee. Available only for zoom ui.
Source:
Parameters:
Name Type Description
mode Number The view mode of the attendee, Defined in: SDKAttendeeViewMode
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) SetAttendeeViewMode(mode) → {Number}

Description:
  • Set the view mode of the attendee. Available only for zoom ui.
Source:
Parameters:
Name Type Description
mode Number The view mode of the attendee, Defined in: SDKAttendeeViewMode
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) SetOnAllowAttendeeChatNotificationCB(onAllowAttendeeChatNotification) → {Boolean}

Description:
  • Set callback to enable the attendees to chat. Available only for the host and the co-host.
Source:
Parameters:
Name Type Description
onAllowAttendeeChatNotification function
Returns:
Type
Boolean

(inner) SetOnAllowAttendeeChatNotificationCB(onAllowAttendeeChatNotification) → {Boolean}

Description:
  • Set callback to enable the attendees to chat. Available only for the host and the co-host.
Source:
Parameters:
Name Type Description
onAllowAttendeeChatNotification function
Returns:
Type
Boolean

(inner) SetOnAllowAttendeeRaiseHandStatusChangedCB(onAllowAttendeeRaiseHandStatusChanged) → {Boolean}

Description:
  • Set callback to attendee raise hand Status Changed.
Source:
Parameters:
Name Type Description
onAllowAttendeeRaiseHandStatusChanged function
Returns:
Type
Boolean

(inner) SetOnAllowAttendeeRaiseHandStatusChangedCB(onAllowAttendeeRaiseHandStatusChanged) → {Boolean}

Description:
  • Set callback to attendee raise hand Status Changed.
Source:
Parameters:
Name Type Description
onAllowAttendeeRaiseHandStatusChanged function
Returns:
Type
Boolean

(inner) SetOnAllowAttendeeViewTheParticipantCountStatusChangedCB(onAllowAttendeeViewTheParticipantCountStatusChanged) → {Boolean}

Description:
  • Set callback to attendee view the participant count status Changed.
Source:
Parameters:
Name Type Description
onAllowAttendeeViewTheParticipantCountStatusChanged function
Returns:
Type
Boolean

(inner) SetOnAllowAttendeeViewTheParticipantCountStatusChangedCB(onAllowAttendeeViewTheParticipantCountStatusChanged) → {Boolean}

Description:
  • Set callback to attendee view the participant count status Changed.
Source:
Parameters:
Name Type Description
onAllowAttendeeViewTheParticipantCountStatusChanged function
Returns:
Type
Boolean

(inner) SetOnAllowPanelistStartVideoNotificationCB(onAllowPanelistStartVideoNotification) → {Boolean}

Description:
  • Set callback to enable the panelist to start the video.
Source:
Parameters:
Name Type Description
onAllowPanelistStartVideoNotification function
Returns:
Type
Boolean

(inner) SetOnAllowPanelistStartVideoNotificationCB(onAllowPanelistStartVideoNotification) → {Boolean}

Description:
  • Set callback to enable the panelist to start the video.
Source:
Parameters:
Name Type Description
onAllowPanelistStartVideoNotification function
Returns:
Type
Boolean

(inner) SetOnAllowWebinarReactionStatusChangedCB(onAllowWebinarReactionStatusChanged) → {Boolean}

Description:
  • Set callback to emoji Reactions Status Changed.
Source:
Parameters:
Name Type Description
onAllowWebinarReactionStatusChanged function
Returns:
Type
Boolean

(inner) SetOnAllowWebinarReactionStatusChangedCB(onAllowWebinarReactionStatusChanged) → {Boolean}

Description:
  • Set callback to emoji Reactions Status Changed.
Source:
Parameters:
Name Type Description
onAllowWebinarReactionStatusChanged function
Returns:
Type
Boolean

(inner) SetOnAttendeeAudioStatusNotificationCB(onAttendeeAudioStatusNotification) → {Boolean}

Description:
  • Set attendee will receive this callback if his audio status changes callback.
Source:
Parameters:
Name Type Description
onAttendeeAudioStatusNotification function
Returns:
Type
Boolean

(inner) SetOnAttendeeAudioStatusNotificationCB(onAttendeeAudioStatusNotification) → {Boolean}

Description:
  • Set attendee will receive this callback if his audio status changes callback.
Source:
Parameters:
Name Type Description
onAttendeeAudioStatusNotification function
Returns:
Type
Boolean

(inner) SetOnAttendeePromoteConfirmResultCB(onAttendeePromoteConfirmResult) → {Boolean}

Description:
  • Set when attendee agree or decline the promote invitation, host will receive this callback.
Source:
Parameters:
Name Type Description
onAttendeePromoteConfirmResult function
Returns:
Type
Boolean

(inner) SetOnAttendeePromoteConfirmResultCB(onAttendeePromoteConfirmResult) → {Boolean}

Description:
  • Set when attendee agree or decline the promote invitation, host will receive this callback.
Source:
Parameters:
Name Type Description
onAttendeePromoteConfirmResult function
Returns:
Type
Boolean

(inner) SetOnDepromptPanelist2AttendeeResultCB(onDepromptPanelist2AttendeeResult) → {Boolean}

Description:
  • Set callback to demote attendees to panelist.
Source:
Parameters:
Name Type Description
onDepromptPanelist2AttendeeResult function
Returns:
Type
Boolean

(inner) SetOnDepromptPanelist2AttendeeResultCB(onDepromptPanelist2AttendeeResult) → {Boolean}

Description:
  • Set callback to demote attendees to panelist.
Source:
Parameters:
Name Type Description
onDepromptPanelist2AttendeeResult function
Returns:
Type
Boolean

(inner) SetOnDisallowAttendeeChatNotificationCB(onDisallowAttendeeChatNotification) → {Boolean}

Description:
  • Set callback to disable the attendees to chat. Available only for the host and the co-host.
Source:
Parameters:
Name Type Description
onDisallowAttendeeChatNotification function
Returns:
Type
Boolean

(inner) SetOnDisallowAttendeeChatNotificationCB(onDisallowAttendeeChatNotification) → {Boolean}

Description:
  • Set callback to disable the attendees to chat. Available only for the host and the co-host.
Source:
Parameters:
Name Type Description
onDisallowAttendeeChatNotification function
Returns:
Type
Boolean

(inner) SetOnDisallowPanelistStartVideoNotificationCB(onDisallowPanelistStartVideoNotification) → {Boolean}

Description:
  • Set callback to disable the panelist to start the video.
Source:
Parameters:
Name Type Description
onDisallowPanelistStartVideoNotification function
Returns:
Type
Boolean

(inner) SetOnDisallowPanelistStartVideoNotificationCB(onDisallowPanelistStartVideoNotification) → {Boolean}

Description:
  • Set callback to disable the panelist to start the video.
Source:
Parameters:
Name Type Description
onDisallowPanelistStartVideoNotification function
Returns:
Type
Boolean

(inner) SetOnPromptAttendee2PanelistResultCB(onPromptAttendee2PanelistResult) → {Boolean}

Description:
  • Set callback to promote attendees to panelist.
Source:
Parameters:
Name Type Description
onPromptAttendee2PanelistResult function
Returns:
Type
Boolean

(inner) SetOnPromptAttendee2PanelistResultCB(onPromptAttendee2PanelistResult) → {Boolean}

Description:
  • Set callback to promote attendees to panelist.
Source:
Parameters:
Name Type Description
onPromptAttendee2PanelistResult function
Returns:
Type
Boolean

(inner) SetOnSelfAllowTalkNotificationCB(onSelfAllowTalkNotification) → {Boolean}

Description:
  • Set callback event that attendees are required to enable the mic in the view-only mode of webinar.
Source:
Parameters:
Name Type Description
onSelfAllowTalkNotification function
Returns:
Type
Boolean

(inner) SetOnSelfAllowTalkNotificationCB(onSelfAllowTalkNotification) → {Boolean}

Description:
  • Set callback event that attendees are required to enable the mic in the view-only mode of webinar.
Source:
Parameters:
Name Type Description
onSelfAllowTalkNotification function
Returns:
Type
Boolean

(inner) SetOnSelfDisallowTalkNotificationCB(onSelfDisallowTalkNotification) → {Boolean}

Description:
  • Set callback event that attendees are required to turn off the mic in the view-only mode of webinar.
Source:
Parameters:
Name Type Description
onSelfDisallowTalkNotification function
Returns:
Type
Boolean

(inner) SetOnSelfDisallowTalkNotificationCB(onSelfDisallowTalkNotification) → {Boolean}

Description:
  • Set callback event that attendees are required to turn off the mic in the view-only mode of webinar.
Source:
Parameters:
Name Type Description
onSelfDisallowTalkNotification function
Returns:
Type
Boolean

(inner) SetPanelistChatPrivilege(privilege) → {Number}

Description:
  • Set the chat privilege of the panelist.
Source:
Parameters:
Name Type Description
privilege Number The chat privilege of the panelist, Defined in: SDKPanelistChatPrivilege
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) SetPanelistChatPrivilege(privilege) → {Number}

Description:
  • Set the chat privilege of the panelist.
Source:
Parameters:
Name Type Description
privilege Number The chat privilege of the panelist, Defined in: SDKPanelistChatPrivilege
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

Events

onAllowAttendeeChatNotification

Description:
  • Callback to enable the attendees to chat. Available only for the host and the co-host.
Source:

onAllowAttendeeChatNotification

Description:
  • Callback to enable the attendees to chat. Available only for the host and the co-host.
Source:

onAllowAttendeeRaiseHandStatusChanged

Description:
  • Callback to attendee raise hand Status Changed.
Source:
Parameters:
Name Type Description
can_raiseHand Boolean If the raise hand is allow, the result is true, False not.

onAllowAttendeeRaiseHandStatusChanged

Description:
  • Callback to attendee raise hand Status Changed.
Source:
Parameters:
Name Type Description
can_raiseHand Boolean If the raise hand is allow, the result is true, False not.

onAllowAttendeeViewTheParticipantCountStatusChanged

Description:
  • Callback to attendee view the participant count status Changed.
Source:
Parameters:
Name Type Description
can_viewParticipantCount Boolean If attendee view the participant count is allow, the result is true, False not.

onAllowAttendeeViewTheParticipantCountStatusChanged

Description:
  • Callback to attendee view the participant count status Changed.
Source:
Parameters:
Name Type Description
can_viewParticipantCount Boolean If attendee view the participant count is allow, the result is true, False not.

onAllowPanelistStartVideoNotification

Description:
  • Callback to enable the panelist to start the video.
Source:

onAllowPanelistStartVideoNotification

Description:
  • Callback to enable the panelist to start the video.
Source:

onAllowWebinarReactionStatusChanged

Description:
  • Callback to emoji Reactions Status Changed.
Source:
Parameters:
Name Type Description
can_reaction Boolean If the Reaction is allow, the result is true, False not.

onAllowWebinarReactionStatusChanged

Description:
  • Callback to emoji Reactions Status Changed.
Source:
Parameters:
Name Type Description
can_reaction Boolean If the Reaction is allow, the result is true, False not.

onAttendeeAudioStatusNotification

Description:
  • Attendee will receive this callback if his audio status changes.
Source:
Parameters:
Name Type Description
userid Number The ID of the user whose audio status changes.
can_talk Boolean True indicates that it is able to use the audio. False not.
is_muted Boolean TRUE indicates muted, FALSE not. This parameter works only when the value of can_talk is TRUE.

onAttendeeAudioStatusNotification

Description:
  • Attendee will receive this callback if his audio status changes.
Source:
Parameters:
Name Type Description
userid Number The ID of the user whose audio status changes.
can_talk Boolean True indicates that it is able to use the audio. False not.
is_muted Boolean TRUE indicates muted, FALSE not. This parameter works only when the value of can_talk is TRUE.

onAttendeePromoteConfirmResult

Description:
  • When attendee agree or decline the promote invitation, host will receive this callback.
Source:
Parameters:
Name Type Description
agree Boolean if attendee agree return true, otherwise false.
userid Number The attendee user id.

onAttendeePromoteConfirmResult

Description:
  • When attendee agree or decline the promote invitation, host will receive this callback.
Source:
Parameters:
Name Type Description
agree Boolean if attendee agree return true, otherwise false.
userid Number The attendee user id.

onDepromptPanelist2AttendeeResult

Description:
  • Callback to demote attendees to panelist.
Source:
Parameters:
Name Type Description
result Number If the demotion is successful, the result is zero(0), otherwise an error code.

onDepromptPanelist2AttendeeResult

Description:
  • Callback to demote attendees to panelist.
Source:
Parameters:
Name Type Description
result Number If the demotion is successful, the result is zero(0), otherwise an error code.

onDisallowAttendeeChatNotification

Description:
  • Callback to disable the attendees to chat. Available only for the host and the co-host.
Source:

onDisallowAttendeeChatNotification

Description:
  • Callback to disable the attendees to chat. Available only for the host and the co-host.
Source:

onDisallowPanelistStartVideoNotification

Description:
  • Callback to disable the panelist to start the video.
Source:

onDisallowPanelistStartVideoNotification

Description:
  • Callback to disable the panelist to start the video.
Source:

onPromptAttendee2PanelistResult

Description:
  • Callback to promote attendees to panelist.
Source:
Parameters:
Name Type Description
result Number If the promotion is successful, the result is zero(0). Otherwise it is an error code.

onPromptAttendee2PanelistResult

Description:
  • Callback to promote attendees to panelist.
Source:
Parameters:
Name Type Description
result Number If the promotion is successful, the result is zero(0). Otherwise it is an error code.

onSelfAllowTalkNotification

Description:
  • Callback event that attendees are required to enable the mic in the view-only mode of webinar.
Source:

onSelfAllowTalkNotification

Description:
  • Callback event that attendees are required to enable the mic in the view-only mode of webinar.
Source:

onSelfDisallowTalkNotification

Description:
  • Callback event that attendees are required to turn off the mic in the view-only mode of webinar.
Source:

onSelfDisallowTalkNotification

Description:
  • Callback event that attendees are required to turn off the mic in the view-only mode of webinar.
Source: