IMeetingWebinarController Class Reference

Webinar controller interface. More...

#include <meeting_webinar_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IMeetingWebinarCtrlEvent *pEvent)=0
	Set webinar controller callback event handler.
virtual SDKError	PromptAttendee2Panelist (unsigned int userid)=0
	Promote the attendee to panelist. Available only for the meeting host.
virtual SDKError	DepromptPanelist2Attendee (unsigned int userid)=0
	Demote the panelist to attendee. Available only for the host.
virtual SDKError	IsSupportAttendeeTalk ()=0
	Query if the webinar supports the user to use the audio device.
virtual SDKError	AllowAttendeeTalk (unsigned int userid)=0
	The attendee is permitted to use the audio device.
virtual SDKError	DisallowAttendeeTalk (unsigned int userid)=0
	Forbid the attendee to use the audio device.
virtual SDKError	AllowPanelistStartVideo ()=0
	The panelist is permitted to start the video.
virtual SDKError	DisallowPanelistStartVideo ()=0
	Forbid the panelist to start video.
virtual SDKError	AllowWebinarEmojiReaction ()=0
	Permitted to use emoji reactions.
virtual SDKError	DisallowWebinarEmojiReaction ()=0
	Forbid to use emoji reactions.
virtual bool	IsWebinarEmojiReactionSupported ()=0
	Determine if current webinar support emoji reaction.
virtual SDKError	AllowAttendeeRaiseHand ()=0
	The attendee is permitted to use the raise hand.
virtual SDKError	DisallowAttendeeRaiseHand ()=0
	Forbid the attendee to use the raise hand.
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 int	GetParticipantCount ()=0
	Get the participant count.
virtual WebinarMeetingStatus *	GetWebinarMeetingStatus ()=0
	Get the webinar status.
virtual SDKError	SetPanelistChatPrivilege (SDKPanelistChatPrivilege privilege)=0
	Set the chat privilege of the panelist.
virtual SDKError	GetPanelistChatPrivilege (SDKPanelistChatPrivilege &privilege)=0
	Get the chat privilege of the panelist.

Detailed Description

Webinar controller interface.

Definition at line 144 of file meeting_webinar_interface.h.

Member Function Documentation

AllowAttendeeRaiseHand()

virtual SDKError IMeetingWebinarController::AllowAttendeeRaiseHand ( )

pure virtual

The attendee is permitted to use the raise hand.

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::onAllowAttendeeRaiseHandStatusChanged(bool) callback event. Available only for the host.

AllowAttendeeTalk()

virtual SDKError IMeetingWebinarController::AllowAttendeeTalk ( unsigned int userid )

pure virtual

The attendee is permitted to use the audio device.

Parameters

userid

Specifies 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.

AllowAttendeeViewTheParticipantCount()

virtual SDKError IMeetingWebinarController::AllowAttendeeViewTheParticipantCount ( )

pure virtual

The attendee is permitted to view the participant count.

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::onAllowAttendeeViewTheParticipantCountStatusChanged(bool) 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.

AllowWebinarEmojiReaction()

virtual SDKError IMeetingWebinarController::AllowWebinarEmojiReaction ( )

pure virtual

Permitted to use emoji reactions.

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::onAllowWebinarReactionStatusChanged(bool) 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

userid

Specifies 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.

DisallowAttendeeRaiseHand()

virtual SDKError IMeetingWebinarController::DisallowAttendeeRaiseHand ( )

pure virtual

Forbid the attendee to use the raise hand.

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::onAllowAttendeeRaiseHandStatusChanged(bool) callback event. Available only for the host.

DisallowAttendeeTalk()

virtual SDKError IMeetingWebinarController::DisallowAttendeeTalk ( unsigned int userid )

pure virtual

Forbid the attendee to use the audio device.

Parameters

userid

Specifies 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.

DisallowAttendeeViewTheParticipantCount()

virtual SDKError IMeetingWebinarController::DisallowAttendeeViewTheParticipantCount ( )

pure virtual

Forbid the attendee to view the participant count.

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::onAllowAttendeeViewTheParticipantCountStatusChanged(bool) 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.

DisallowWebinarEmojiReaction()

virtual SDKError IMeetingWebinarController::DisallowWebinarEmojiReaction ( )

pure virtual

Forbid to use emoji reactions.

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::onAllowWebinarReactionStatusChanged(bool) callback event. Available only for the host.

GetPanelistChatPrivilege()

virtual SDKError IMeetingWebinarController::GetPanelistChatPrivilege ( SDKPanelistChatPrivilege & privilege )

pure virtual

Get the chat privilege of the panelist.

Parameters

privilege

The chat priviledge of the panelist. It validates only when the return value is SDKErr_Success.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, see SDKError enum.

GetParticipantCount()

virtual int IMeetingWebinarController::GetParticipantCount ( )

pure virtual

Get the participant count.

Returns

The count of participant.

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.

Deprecated

This interface is marked as deprecated.

IsWebinarEmojiReactionSupported()

virtual bool IMeetingWebinarController::IsWebinarEmojiReactionSupported ( )

pure virtual

Determine if current webinar support emoji reaction.

Returns

True means the current webinar supports emoji reactions. Otherwise false.

PromptAttendee2Panelist()

virtual SDKError IMeetingWebinarController::PromptAttendee2Panelist ( unsigned int userid )

pure virtual

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

Parameters

userid

Specifies 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

pEvent

A 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.

SetPanelistChatPrivilege()

virtual SDKError IMeetingWebinarController::SetPanelistChatPrivilege ( SDKPanelistChatPrivilege privilege )

pure virtual

Set the chat privilege of the panelist.

Parameters

privilege

The chat priviledge of the panelist.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, see SDKError enum.