ZOOM Windows SDK  5.2.41727.0928
Public Member Functions | List of all members
IMeetingWebinarController Class Referenceabstract

Webinar controller interface. More...

#include <meeting_webinar_interface.h>

Public Member Functions

virtual SDKError SetEvent (IMeetingWebinarCtrlEvent *pEvent)=0
 Set webinar controller callback event handler. More...
 
virtual SDKError PromptAttendee2Panelist (unsigned int userid)=0
 Promote the attendee to panelist. Available only for the meeting host. More...
 
virtual SDKError DepromptPanelist2Attendee (unsigned int userid)=0
 Demote the panelist to attendee. Available only for the host. More...
 
virtual SDKError IsSupportAttendeeTalk ()=0
 Query if the webinar supports the user to use the audio device. More...
 
virtual SDKError AllowAttendeeTalk (unsigned int userid)=0
 The attendee is permitted to use the audio device. More...
 
virtual SDKError DisallowAttendeeTalk (unsigned int userid)=0
 Forbid the attendee to use the audio device. More...
 
virtual SDKError AllowPanelistStartVideo ()=0
 The panelist is permitted to start the video. More...
 
virtual SDKError DisallowPanelistStartVideo ()=0
 Forbid the panelist to start video. More...
 
virtual WebinarMeetingStatusGetWebinarMeetingStatus ()=0
 Get the webinar status. More...
 

Detailed Description

Webinar controller interface.

Member Function Documentation

◆ AllowAttendeeTalk()

virtual SDKError IMeetingWebinarController::AllowAttendeeTalk ( unsigned int  userid)
pure virtual

The attendee is permitted to use the audio device.

Parameters
useridSpecifies the permitted user ID.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
If the function succeeds, the user will receive the IMeetingWebinarCtrlEvent::onAllowAttendeeChatNotification() callback event. Available only for the host.

◆ AllowPanelistStartVideo()

virtual SDKError IMeetingWebinarController::AllowPanelistStartVideo ( )
pure virtual

The panelist is permitted to start the video.

Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
If the function succeeds, the user will receive the IMeetingWebinarCtrlEvent::onAllowPanelistStartVideoNotification() callback event. Available only for the host.

◆ DepromptPanelist2Attendee()

virtual SDKError IMeetingWebinarController::DepromptPanelist2Attendee ( unsigned int  userid)
pure virtual

Demote the panelist to attendee. Available only for the host.

Parameters
useridSpecifies the user ID to demote.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
If the function succeeds, the user will receive the IMeetingWebinarCtrlEvent::onDepromptPanelist2AttendeeResult() callback event.

◆ DisallowAttendeeTalk()

virtual SDKError IMeetingWebinarController::DisallowAttendeeTalk ( unsigned int  userid)
pure virtual

Forbid the attendee to use the audio device.

Parameters
useridSpecifies the forbidden user ID.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
If the function succeeds, the user will receive the IMeetingWebinarCtrlEvent::onDisallowAttendeeChatNotification() callback event. Available only for the host.

◆ DisallowPanelistStartVideo()

virtual SDKError IMeetingWebinarController::DisallowPanelistStartVideo ( )
pure virtual

Forbid the panelist to start video.

Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
If the function succeeds, the user will receive the IMeetingWebinarCtrlEvent::onDisallowPanelistStartVideoNotification() callback event. Available only for the host.

◆ GetWebinarMeetingStatus()

virtual WebinarMeetingStatus* IMeetingWebinarController::GetWebinarMeetingStatus ( )
pure virtual

Get the webinar status.

Returns
The status of webinar. For more details, see WebinarMeetingStatus.

◆ IsSupportAttendeeTalk()

virtual SDKError IMeetingWebinarController::IsSupportAttendeeTalk ( )
pure virtual

Query if the webinar supports the user to use the audio device.

Returns
If it supports, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ PromptAttendee2Panelist()

virtual SDKError IMeetingWebinarController::PromptAttendee2Panelist ( unsigned int  userid)
pure virtual

Promote the attendee to panelist. Available only for the meeting host.

Parameters
useridSpecifies the user ID to promote.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
If the function succeeds, the user will receive the IMeetingWebinarCtrlEvent::onPromptAttendee2PanelistResult() callback event.

◆ SetEvent()

virtual SDKError IMeetingWebinarController::SetEvent ( IMeetingWebinarCtrlEvent pEvent)
pure virtual

Set webinar controller callback event handler.

Parameters
pEventA pointer to the IMeetingWebinarCtrlEvent that receives the webinar callback event.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

The documentation for this class was generated from the following file: