Meeting SDK for Linux API Reference
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
meeting_webinar_interface.h
Go to the documentation of this file.
1
7#ifndef _MEETING_WEBINAR_INTERFACE_H_
8#define _MEETING_WEBINAR_INTERFACE_H_
9#include "zoom_sdk_def.h"
11
15{
16public:
18
21 virtual void onPromptAttendee2PanelistResult(int result) = 0;
22
25 virtual void onDepromptPanelist2AttendeeResult(int result) = 0;
26
29
32
34 virtual void onSelfAllowTalkNotification() = 0;
35
38
41
44
47 virtual void onAllowWebinarReactionStatusChanged(bool can_reaction) = 0;
48
51 virtual void onAllowAttendeeRaiseHandStatusChanged(bool can_raiseHand) = 0;
52
55 virtual void onAllowAttendeeViewTheParticipantCountStatusChanged(bool can_viewParticipantCount) = 0;
56
61 virtual void onAttendeeAudioStatusNotification(unsigned int userid, bool can_talk, bool is_muted) = 0;
62
66 virtual void onAttendeePromoteConfirmResult(bool agree, unsigned int userid) = 0;
67};
68
94
103#if defined(WIN32)
107enum SDKAttendeeViewMode
108{
109 SDKAttendeeViewMode_None,
110 SDKAttendeeViewMode_FollowHost,
111 SDKAttendeeViewMode_Speaker,
112 SDKAttendeeViewMode_Gallery,
113 SDKAttendeeViewMode_Standard,
114 SDKAttendeeViewMode_SidebysideSpeaker,
115 SDKAttendeeViewMode_SidebysideGallery
116};
117
122typedef struct tagWebinarLegalNoticesExplainedInfo
123{
124 const zchar_t* explained_content;
125 const zchar_t* url_register_account_owner;
126 const zchar_t* url_register_terms;
127 const zchar_t* url_register_privacy_policy;
128 tagWebinarLegalNoticesExplainedInfo()
129 {
130 Reset();
131 }
132
133 void Reset()
134 {
135 explained_content = nullptr;
136 url_register_account_owner = nullptr;
137 url_register_terms = nullptr;
138 url_register_privacy_policy = nullptr;
139 }
140}WebinarLegalNoticesExplainedInfo;
141#endif
145{
146public:
152
158 virtual SDKError PromptAttendee2Panelist(unsigned int userid) = 0;
159
165 virtual SDKError DepromptPanelist2Attendee(unsigned int userid) = 0;
166
172
178 virtual SDKError AllowAttendeeTalk(unsigned int userid) = 0;
179
185 virtual SDKError DisallowAttendeeTalk(unsigned int userid) = 0;
186
192
198
204
210
214
220
226
232
238
241 virtual int GetParticipantCount() = 0;
242
246
252
258
259#if defined(WIN32)
264 virtual SDKError SetAttendeeViewMode(SDKAttendeeViewMode mode) = 0;
265
268 virtual SDKAttendeeViewMode GetAttendeeViewMode() = 0;
269
272 virtual const zchar_t* getWebinarLegalNoticesPrompt() = 0;
273
276 virtual bool getWebinarLegalNoticesExplained(WebinarLegalNoticesExplainedInfo& explained_info) = 0;
277#endif
278};
279
281#endif
Webinar controller interface.
virtual SDKError DisallowAttendeeRaiseHand()=0
Forbid the attendee to use the raise hand.
virtual SDKError IsSupportAttendeeTalk()=0
Query if the webinar supports the user to use the audio device.
virtual SDKError SetPanelistChatPrivilege(SDKPanelistChatPrivilege privilege)=0
Set the chat privilege of the panelist.
virtual SDKError AllowAttendeeRaiseHand()=0
The attendee is permitted to use the raise hand.
virtual int GetParticipantCount()=0
Get the participant count.
virtual SDKError AllowAttendeeTalk(unsigned int userid)=0
The attendee is permitted to use the audio device.
virtual SDKError DepromptPanelist2Attendee(unsigned int userid)=0
Demote the panelist to attendee. Available only for the host.
virtual SDKError AllowWebinarEmojiReaction()=0
Permitted to use emoji reactions.
virtual SDKError PromptAttendee2Panelist(unsigned int userid)=0
Promote the attendee to panelist. Available only for the meeting host.
virtual SDKError GetPanelistChatPrivilege(SDKPanelistChatPrivilege &privilege)=0
Get the chat privilege of the panelist.
virtual bool IsWebinarEmojiReactionSupported()=0
Determine if current webinar support emoji reaction.
virtual SDKError DisallowPanelistStartVideo()=0
Forbid the panelist to start video.
virtual SDKError DisallowAttendeeTalk(unsigned int userid)=0
Forbid the attendee to use the audio device.
virtual SDKError DisallowWebinarEmojiReaction()=0
Forbid to use emoji reactions.
virtual SDKError SetEvent(IMeetingWebinarCtrlEvent *pEvent)=0
Set webinar controller callback event handler.
virtual SDKError AllowPanelistStartVideo()=0
The panelist is permitted to start the video.
virtual WebinarMeetingStatus * GetWebinarMeetingStatus()=0
Get the webinar status.
virtual SDKError AllowAttendeeViewTheParticipantCount()=0
The attendee is permitted to view the participant count.
virtual SDKError DisallowAttendeeViewTheParticipantCount()=0
Forbid the attendee to view the participant count.
virtual void onPromptAttendee2PanelistResult(int result)=0
Callback to promote attendees to panelist.
virtual void onAllowAttendeeViewTheParticipantCountStatusChanged(bool can_viewParticipantCount)=0
Callback to attendee view the participant count status Changed.
virtual void onAttendeePromoteConfirmResult(bool agree, unsigned int userid)=0
When attendee agree or decline the promote invitation, host will receive this callback.
virtual void onAttendeeAudioStatusNotification(unsigned int userid, bool can_talk, bool is_muted)=0
Attendee will receive this callback if his audio status changes.
virtual void onAllowPanelistStartVideoNotification()=0
Callback to enable the panelist to start the video.
virtual void onDisallowAttendeeChatNotification()=0
Callback to disable the attendees to chat. Available only for the host and the co-host.
virtual void onDepromptPanelist2AttendeeResult(int result)=0
Callback to demote attendees to panelist.
virtual void onDisallowPanelistStartVideoNotification()=0
Callback to disable the panelist to start the video.
virtual void onAllowAttendeeRaiseHandStatusChanged(bool can_raiseHand)=0
Callback to attendee raise hand Status Changed.
virtual void onSelfAllowTalkNotification()=0
Callback event that attendees are required to enable the mic in the view-only mode of webinar.
virtual void onSelfDisallowTalkNotification()=0
Callback event that attendees are required to turn off the mic in the view-only mode of webinar.
virtual void onAllowWebinarReactionStatusChanged(bool can_reaction)=0
Callback to emoji Reactions Status Changed.
virtual void onAllowAttendeeChatNotification()=0
Callback to enable the attendees to chat. Available only for the host and the co-host.
struct tagWebinarMeetingStatus WebinarMeetingStatus
SDKPanelistChatPrivilege
Enumerations of the panelist chat privilege.
@ SDKPanelistChatPrivilege_PanelistOnly
Allow panelists only to chat with each other.
@ SDKPanelistChatPrivilege_All
Allow panelist to chat with everyone.
Webinar Meeting Status. Here are more detailed structural descriptions.
bool allow_emoji_reaction
TRUE indicates that the attendee is able to emojireaction. FALSE not.
bool allow_attendee_raise_hand
TRUE indicates that the attendee is able to raise hand. FALSE not.
bool allow_attendee_view_participant_count
TRUE indicates that the attendee is able to view participant count. FALSE not.
bool allow_attendee_chat
TRUE indicates that the attendee is able to chat. FALSE not.
bool allow_panellist_start_video
TRUE indicates that the panelist is able to turn on the video. FALSE not.
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
#define BEGIN_ZOOM_SDK_NAMESPACE
char zchar_t
SDKError
SDK error types. Here are more detailed structural descriptions.