IWaitingRoomHelper Class Reference

Waiting Room helper interface. More...

#include <IWaitingRoomHelper.h>

Public Member Functions
virtual	~IWaitingRoomHelper ()
virtual ZRCSDKError	RegisterSink (IWaitingRoomHelperSink *pSink)=0
	Register waiting room helper callback sink.
virtual ZRCSDKError	DeregisterSink (IWaitingRoomHelperSink *pSink)=0
	Deregister waiting room helper callback sink.
virtual ZRCSDKError	PutUsersIntoMeeting (std::vector< int32_t > userIDs)=0
	Put users into meeting.
virtual ZRCSDKError	PutUsersIntoWaitingRoom (std::vector< int32_t > userIDs)=0
	Put users into waiting room.
virtual ZRCSDKError	PutAllUsersIntoMeeting ()=0
	Put all the waiting room users into meeting.
virtual ZRCSDKError	IsWaitingRoomLocked (bool &locked)=0
	Query if enable waiting room setting is locked.
virtual ZRCSDKError	EnableWaitingRoomOnEntry (bool enable)=0
	Enable waiting room on entry.
virtual ZRCSDKError	IsWaitingRoomOnEntry (bool &onEntry)=0
	Query if is waiting room on entry.

Detailed Description

Waiting Room helper interface.

Definition at line 62 of file IWaitingRoomHelper.h.

Constructor & Destructor Documentation

~IWaitingRoomHelper()

virtual IWaitingRoomHelper::~IWaitingRoomHelper ( )

inlinevirtual

Definition at line 65 of file IWaitingRoomHelper.h.

{}

Member Function Documentation

DeregisterSink()

virtual ZRCSDKError IWaitingRoomHelper::DeregisterSink ( IWaitingRoomHelperSink *  pSink )

pure virtual

Deregister waiting room helper callback sink.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

pSink

A pointer to the IWaitingRoomHelperSink that receives the waiting room helper callback.

Returns

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

EnableWaitingRoomOnEntry()

virtual ZRCSDKError IWaitingRoomHelper::EnableWaitingRoomOnEntry ( bool  enable )

pure virtual

Enable waiting room on entry.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

enable

TRUE indicates users will enter in waiting room when joined the meeting.

Returns

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

IsWaitingRoomLocked()

virtual ZRCSDKError IWaitingRoomHelper::IsWaitingRoomLocked ( bool &  locked )

pure virtual

Query if enable waiting room setting is locked.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

[out]

locked

TRUE indicates enable waiting room setting is locked.

Returns

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

IsWaitingRoomOnEntry()

virtual ZRCSDKError IWaitingRoomHelper::IsWaitingRoomOnEntry ( bool &  onEntry )

pure virtual

Query if is waiting room on entry.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

[out]

onEntry

TRUE indicates users will enter in waiting room when joined the meeting.

Returns

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

PutAllUsersIntoMeeting()

virtual ZRCSDKError IWaitingRoomHelper::PutAllUsersIntoMeeting ( )

pure virtual

Put all the waiting room users into meeting.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Returns

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

PutUsersIntoMeeting()

virtual ZRCSDKError IWaitingRoomHelper::PutUsersIntoMeeting ( std::vector< int32_t >  userIDs )

pure virtual

Put users into meeting.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

userIDs

Assigned user list to be put into meeting.

Returns

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

PutUsersIntoWaitingRoom()

virtual ZRCSDKError IWaitingRoomHelper::PutUsersIntoWaitingRoom ( std::vector< int32_t >  userIDs )

pure virtual

Put users into waiting room.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

userIDs

Assigned user list to be put into waiting room.

Returns

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

RegisterSink()

virtual ZRCSDKError IWaitingRoomHelper::RegisterSink ( IWaitingRoomHelperSink *  pSink )

pure virtual

Register waiting room helper callback sink.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

pSink

A pointer to the IWaitingRoomHelperSink that receives the waiting room helper callback.

Returns

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