Meeting SDK for Linux API Reference
Loading...
Searching...
No Matches
meeting_webinar_interface.h
Go to the documentation of this file.
1
6#ifndef _MEETING_WEBINAR_INTERFACE_H_
7#define _MEETING_WEBINAR_INTERFACE_H_
8#include "zoom_sdk_def.h"
10
16{
17public:
19
24 virtual void onPromptAttendee2PanelistResult(int result) = 0;
25
30 virtual void onDepromptPanelist2AttendeeResult(int result) = 0;
31
36
41
45 virtual void onSelfAllowTalkNotification() = 0;
46
51
57
62
67 virtual void onAllowWebinarReactionStatusChanged(bool can_reaction) = 0;
68
73 virtual void onAllowAttendeeRaiseHandStatusChanged(bool can_raiseHand) = 0;
74
79 virtual void onAllowAttendeeViewTheParticipantCountStatusChanged(bool can_viewParticipantCount) = 0;
80
87 virtual void onAttendeeAudioStatusNotification(unsigned int userid, bool can_talk, bool is_muted) = 0;
88
94 virtual void onAttendeePromoteConfirmResult(bool agree, unsigned int userid) = 0;
95};
96
127
138#if defined(WIN32)
142enum SDKAttendeeViewMode
143{
145 SDKAttendeeViewMode_None,
147 SDKAttendeeViewMode_FollowHost,
149 SDKAttendeeViewMode_Speaker,
151 SDKAttendeeViewMode_Gallery,
153 SDKAttendeeViewMode_Standard,
155 SDKAttendeeViewMode_SidebysideSpeaker,
157 SDKAttendeeViewMode_SidebysideGallery
158};
159
164typedef struct tagWebinarLegalNoticesExplainedInfo
165{
166 const zchar_t* explained_content;
167 const zchar_t* url_register_account_owner;
168 const zchar_t* url_register_terms;
169 const zchar_t* url_register_privacy_policy;
170 tagWebinarLegalNoticesExplainedInfo()
171 {
172 Reset();
173 }
174
175 void Reset()
176 {
177 explained_content = nullptr;
178 url_register_account_owner = nullptr;
179 url_register_terms = nullptr;
180 url_register_privacy_policy = nullptr;
181 }
182}WebinarLegalNoticesExplainedInfo;
183#endif
184
190{
191public:
198
205 virtual SDKError PromptAttendee2Panelist(unsigned int userid) = 0;
206
213 virtual SDKError DepromptPanelist2Attendee(unsigned int userid) = 0;
214
221
228 virtual SDKError AllowAttendeeTalk(unsigned int userid) = 0;
229
236 virtual SDKError DisallowAttendeeTalk(unsigned int userid) = 0;
237
244
251
258
265
271
278
285
292
299
304 virtual int GetParticipantCount() = 0;
305
311
318
325
326
327#if defined(WIN32)
333 virtual SDKError SetAttendeeViewMode(SDKAttendeeViewMode mode) = 0;
334
339 virtual SDKAttendeeViewMode GetAttendeeViewMode() = 0;
340
345 virtual const zchar_t* getWebinarLegalNoticesPrompt() = 0;
346
351 virtual bool getWebinarLegalNoticesExplained(WebinarLegalNoticesExplainedInfo& explained_info) = 0;
352#endif
353};
354
356#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
Webinar Meeting Status. Here are more detailed structural descriptions.
SDKPanelistChatPrivilege
Enumerations of the panelist chat privilege.
@ SDKPanelistChatPrivilege_PanelistOnly
@ SDKPanelistChatPrivilege_All
Webinar Meeting Status. Here are more detailed structural descriptions.
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
#define BEGIN_ZOOM_SDK_NAMESPACE
char zchar_t
SDKError
Enumeration of common errors of SDK.