IMeetingWaitingRoomController Class Reference

Meeting waiting room controller interface. More...

#include <meeting_waiting_room_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IMeetingWaitingRoomEvent *pEvent)=0
	Sets meeting waiting room callback event handler.
virtual bool	IsSupportWaitingRoom ()=0
	Determines whether the current meeting supports the waiting room or not.
virtual bool	IsWaitingRoomOnEntryFlagOn ()=0
	Determines if the attendee is enabled to enter the waiting room when joining the meeting.
virtual SDKError	EnableWaitingRoomOnEntry (bool bEnable)=0
	Sets to enable the attendee to enter the waiting room when joining the meeting.
virtual IList< unsigned int > *	GetWaitingRoomLst ()=0
	Gets the list of attendees who are in the waiting room.
virtual IUserInfo *	GetWaitingRoomUserInfoByID (unsigned int userid)=0
	Gets the attendee information in the waiting room via user ID.
virtual SDKError	AdmitToMeeting (unsigned int userid)=0
	Permit the specified user to join the meeting.
virtual SDKError	AdmitAllToMeeting ()=0
	Permit all of the users currently in the waiting room to join the meeting.
virtual SDKError	PutInWaitingRoom (unsigned int userid)=0
	Enables the specified user to enter the waiting room.
virtual bool	IsAudioEnabledInWaitingRoom ()=0
	Determines if the attendee is enabled to turn on audio when joining the meeting.
virtual bool	IsVideoEnabledInWaitingRoom ()=0
	Determines if the attendee is enabled to turn on video when joining the meeting.
virtual SDKError	PresetAudioInWaitingRoom (bool bMute)=0
	Pre-set audio mute or unmute status in waiting room.
virtual bool	IsPresetAudioUnmuteInWaitingRoom ()=0
	Gets the audio pre-set mute or unmute status in waiting room.
virtual SDKError	PresetVideoInWaitingRoom (bool bMute)=0
	Pre-set video mute or unmute status in waiting room.
virtual bool	IsPresetVideoUnmuteInWaitingRoom ()=0
	Gets the video pre-set mute or unmute status in waiting room.
virtual SDKError	RequestCustomWaitingRoomData ()=0
	Gets the WaitingRoom CustomizeData information in the waiting room.
virtual SDKError	CanRenameUser (bool &bIsCan)=0
	Determines if the host or cohost can rename users in the waiting room.
virtual SDKError	RenameUser (unsigned userid, const zchar_t *newName)=0
	Change a user's screen name in the waiting room.
virtual SDKError	CanExpelUser (bool &bIsCan)=0
	Determines if a host or cohost can expel user(s) in the waiting room.
virtual SDKError	ExpelUser (unsigned int userid)=0
	Remove a specified user from the waiting room.
virtual bool	IsWaitingRoomOnEntryLocked ()=0
	Determines if the enable waiting room on entry feature is locked, see EnableWaitingRoomOnEntry.

Detailed Description

Meeting waiting room controller interface.

Definition at line 166 of file meeting_waiting_room_interface.h.

Member Function Documentation

AdmitAllToMeeting()

virtual SDKError IMeetingWaitingRoomController::AdmitAllToMeeting ( )

pure virtual

Permit all of the users currently in the waiting room to join the meeting.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

AdmitToMeeting()

virtual SDKError IMeetingWaitingRoomController::AdmitToMeeting ( unsigned int userid )

pure virtual

Permit the specified user to join the meeting.

Parameters

userid

Specifies the user ID.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

CanExpelUser()

virtual SDKError IMeetingWaitingRoomController::CanExpelUser ( bool & bIsCan )

pure virtual

Determines if a host or cohost can expel user(s) in the waiting room.

Parameters

[out]

bIsCan

true indicates that a host or cohost can expel user(s) in the waiting room. Otherwise they may not

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

CanRenameUser()

virtual SDKError IMeetingWaitingRoomController::CanRenameUser ( bool & bIsCan )

pure virtual

Determines if the host or cohost can rename users in the waiting room.

Parameters

[out]

bIsCan

true indicates the host or cohost can rename users in the waiting room. Otherwise they can't.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

EnableWaitingRoomOnEntry()

virtual SDKError IMeetingWaitingRoomController::EnableWaitingRoomOnEntry ( bool bEnable )

pure virtual

Sets to enable the attendee to enter the waiting room when joining the meeting.

Parameters

bEnable

true indicates to enable to enter. false not.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

ExpelUser()

virtual SDKError IMeetingWaitingRoomController::ExpelUser ( unsigned int userid )

pure virtual

Remove a specified user from the waiting room.

Parameters

userid

The ID of the user removed from the waiting room by a host or cohost.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

GetWaitingRoomLst()

virtual IList< unsigned int > * IMeetingWaitingRoomController::GetWaitingRoomLst ( )

pure virtual

Gets the list of attendees who are in the waiting room.

Returns

If the function succeeds, the return value is the list of attendees. Otherwise, this function returns nullptr.

GetWaitingRoomUserInfoByID()

virtual IUserInfo * IMeetingWaitingRoomController::GetWaitingRoomUserInfoByID ( unsigned int userid )

pure virtual

Gets the attendee information in the waiting room via user ID.

Parameters

userid

Specifies the user ID.

Returns

If the function succeeds, the return value is a pointer to IUserInfo. Otherwise, this function returns nullptr.

IsAudioEnabledInWaitingRoom()

virtual bool IMeetingWaitingRoomController::IsAudioEnabledInWaitingRoom ( )

pure virtual

Determines if the attendee is enabled to turn on audio when joining the meeting.

Returns

true indicates to enable to turn on.

IsPresetAudioUnmuteInWaitingRoom()

virtual bool IMeetingWaitingRoomController::IsPresetAudioUnmuteInWaitingRoom ( )

pure virtual

Gets the audio pre-set mute or unmute status in waiting room.

Returns

If pre-set audio unmuted, the return value is true, other the return value is false and pre set audio muted.

IsPresetVideoUnmuteInWaitingRoom()

virtual bool IMeetingWaitingRoomController::IsPresetVideoUnmuteInWaitingRoom ( )

pure virtual

Gets the video pre-set mute or unmute status in waiting room.

Returns

true indicates pre-set unmute, false means pre-set mute.

IsSupportWaitingRoom()

virtual bool IMeetingWaitingRoomController::IsSupportWaitingRoom ( )

pure virtual

Determines whether the current meeting supports the waiting room or not.

Returns

true indicates to support.

IsVideoEnabledInWaitingRoom()

virtual bool IMeetingWaitingRoomController::IsVideoEnabledInWaitingRoom ( )

pure virtual

Determines if the attendee is enabled to turn on video when joining the meeting.

Returns

true indicates to enable to turn on.

IsWaitingRoomOnEntryFlagOn()

virtual bool IMeetingWaitingRoomController::IsWaitingRoomOnEntryFlagOn ( )

pure virtual

Determines if the attendee is enabled to enter the waiting room when joining the meeting.

Returns

true indicates to enable to enter.

IsWaitingRoomOnEntryLocked()

virtual bool IMeetingWaitingRoomController::IsWaitingRoomOnEntryLocked ( )

pure virtual

Determines if the enable waiting room on entry feature is locked, see EnableWaitingRoomOnEntry.

Returns

true if locked. Otherwise, false.

PresetAudioInWaitingRoom()

virtual SDKError IMeetingWaitingRoomController::PresetAudioInWaitingRoom ( bool bMute )

pure virtual

Pre-set audio mute or unmute status in waiting room.

Parameters

bMute

Pre-set audio mute or unmute status.

Returns

SDKERR_SUCCESS means the pre-set success, otherwise failed.

PresetVideoInWaitingRoom()

virtual SDKError IMeetingWaitingRoomController::PresetVideoInWaitingRoom ( bool bMute )

pure virtual

Pre-set video mute or unmute status in waiting room.

Parameters

bMute

Pre-set video mute or unmute status.

Returns

SDKERR_SUCCESS means the pre-set success, otherwise failed.

PutInWaitingRoom()

virtual SDKError IMeetingWaitingRoomController::PutInWaitingRoom ( unsigned int userid )

pure virtual

Enables the specified user to enter the waiting room.

Parameters

userid

Specifies the user ID.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

RenameUser()

virtual SDKError IMeetingWaitingRoomController::RenameUser ( unsigned userid, const zchar_t * newName )

pure virtual

Change a user's screen name in the waiting room.

Parameters

userid	The ID of users put into the waiting room by a host or cohost.
userName	The new user name.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

RequestCustomWaitingRoomData()

virtual SDKError IMeetingWaitingRoomController::RequestCustomWaitingRoomData ( )

pure virtual

Gets the WaitingRoom CustomizeData information in the waiting room.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. See onCustomWaitingRoomDataUpdated to access the result data. Otherwise, this function returns an error.

SetEvent()

virtual SDKError IMeetingWaitingRoomController::SetEvent ( IMeetingWaitingRoomEvent * pEvent )

pure virtual

Sets meeting waiting room callback event handler.

Parameters

pEvent

A pointer to the IMeetingWaitingRoomEvent that receives the waiting room event.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.