Webinar backstage controller interface. More...

#include <meeting_backstage_interface.h>

Public Member Functions
virtual	~IMeetingBackstageController ()
virtual bool	IsBackstageEnabled ()=0
	Determines if the backstage feature is enabled for the current webinar.
virtual bool	CanJoinBackstage ()=0
	Determines if the local user can enter the backstage.
virtual SDKError	JoinBackstage ()=0
	Makes the local user enter the backstage.
virtual bool	CanLeaveBackstage ()=0
	Determines if the local user can leave the backstage.
virtual SDKError	LeaveBackstage ()=0
	Makes the local user leave the backstage and return to the main session.
virtual bool	CanMoveUserToBackstage (unsigned int userid)=0
	Determines if the specified user can be moved into the backstage.
virtual SDKError	MoveUsersToBackstage (IList< unsigned int > *lstUserID)=0
	Moves the specified users into the backstage.
virtual bool	CanMoveUserToMainSession (unsigned int userid)=0
	Determines if the specified user can be moved back to the main session.
virtual SDKError	MoveUsersToMainSession (IList< unsigned int > *lstUserID)=0
	Moves the specified users from the backstage back to the main session.
virtual bool	CanSetMainSessionAudioVolume ()=0
	Determines if the local user can set the local playback volume of the main session audio.
virtual SDKError	SetMainSessionAudioVolume (FLOAT value)=0
	Sets the local playback volume of the main session audio while in the backstage.
virtual SDKError	GetMainSessionAudioVolume (FLOAT &value)=0
	Gets the local playback volume of the main session audio while in the backstage.

Detailed Description

Webinar backstage controller interface.

Definition at line 39 of file meeting_backstage_interface.h.

Constructor & Destructor Documentation

◆ ~IMeetingBackstageController()

virtual IMeetingBackstageController::~IMeetingBackstageController ( )

inlinevirtual

Definition at line 42 of file meeting_backstage_interface.h.

42{};

Member Function Documentation

◆ CanJoinBackstage()

virtual bool IMeetingBackstageController::CanJoinBackstage ( )

pure virtual

Determines if the local user can enter the backstage.

Returns: true if the local user can enter the backstage. Otherwise false.

Note: Returns false when the local user is a panelist and the host does not allow panelists to switch between the main session and the backstage on their own.

◆ CanLeaveBackstage()

virtual bool IMeetingBackstageController::CanLeaveBackstage ( )

pure virtual

Determines if the local user can leave the backstage.

Returns: true if the local user can leave the backstage. Otherwise false.

◆ CanMoveUserToBackstage()

virtual bool IMeetingBackstageController::CanMoveUserToBackstage ( unsigned int userid )

pure virtual

Determines if the specified user can be moved into the backstage.

Parameters

userid Specifies the user ID to check.

Returns: true if the user can be moved into the backstage. Otherwise false.

Note: Available only for the host and the co-host.

◆ CanMoveUserToMainSession()

virtual bool IMeetingBackstageController::CanMoveUserToMainSession ( unsigned int userid )

pure virtual

Determines if the specified user can be moved back to the main session.

Parameters

userid Specifies the user ID to check.

Returns: true if the user can be moved back to the main session. Otherwise false.

Note: Available only for the host and the co-host. Valid whether or not the local user is currently in the backstage.

◆ CanSetMainSessionAudioVolume()

virtual bool IMeetingBackstageController::CanSetMainSessionAudioVolume ( )

pure virtual

Determines if the local user can set the local playback volume of the main session audio.

Returns: true if the local user is in the backstage. Otherwise false.

Note: When this method returns false, SetMainSessionAudioVolume() returns SDKERR_WRONG_USAGE.

◆ GetMainSessionAudioVolume()

virtual SDKError IMeetingBackstageController::GetMainSessionAudioVolume ( FLOAT & value )

pure virtual

Gets the local playback volume of the main session audio while in the backstage.

Parameters

value The current volume that ranges from 0 to 255.

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

Note: Available only when the local user is in the backstage.

◆ IsBackstageEnabled()

virtual bool IMeetingBackstageController::IsBackstageEnabled ( )

pure virtual

Determines if the backstage feature is enabled for the current webinar.

Returns: true if the backstage feature is enabled. Otherwise false.

◆ JoinBackstage()

virtual SDKError IMeetingBackstageController::JoinBackstage ( )

pure virtual

Makes the local user enter the backstage.

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

Note: If the function succeeds, the user will receive the IMeetingServiceEvent::onMeetingStatusChanged() callback event with MEETING_STATUS_JOIN_BACKSTAGE.

◆ LeaveBackstage()

virtual SDKError IMeetingBackstageController::LeaveBackstage ( )

pure virtual

Makes the local user leave the backstage and return to the main session.

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

Note: If the function succeeds, the user will receive the IMeetingServiceEvent::onMeetingStatusChanged() callback event with MEETING_STATUS_LEAVE_BACKSTAGE. The switch takes effect immediately; the SDK does not apply the countdown used by the Zoom client.

◆ MoveUsersToBackstage()

virtual SDKError IMeetingBackstageController::MoveUsersToBackstage ( IList< unsigned int > * lstUserID )

pure virtual

Moves the specified users into the backstage.

Parameters

lstUserID Specifies the list of user IDs to move. Use IMeetingParticipantsController::GetUserIDListBuilder() to construct it.

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

Note: Available only for the host and the co-host. The return value only indicates that the request was sent. Track the per-user outcome through IMeetingParticipantsCtrlEvent::onUserLeft() and onUserJoin().

◆ MoveUsersToMainSession()

virtual SDKError IMeetingBackstageController::MoveUsersToMainSession ( IList< unsigned int > * lstUserID )

pure virtual

Moves the specified users from the backstage back to the main session.

Parameters

lstUserID Specifies the list of user IDs to move. Use IMeetingParticipantsController::GetUserIDListBuilder() to construct it.

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

Note: Available only for the host and the co-host.

◆ SetMainSessionAudioVolume()

virtual SDKError IMeetingBackstageController::SetMainSessionAudioVolume ( FLOAT value )

pure virtual

Sets the local playback volume of the main session audio while in the backstage.

Parameters

value The volume that ranges from 0 to 255.

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

Note: Available only when the local user is in the backstage. The change is local and does not affect other users.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IMeetingBackstageController()

Member Function Documentation

◆ CanJoinBackstage()

◆ CanLeaveBackstage()

◆ CanMoveUserToBackstage()

◆ CanMoveUserToMainSession()

◆ CanSetMainSessionAudioVolume()

◆ GetMainSessionAudioVolume()

◆ IsBackstageEnabled()

◆ JoinBackstage()

◆ LeaveBackstage()

◆ MoveUsersToBackstage()

◆ MoveUsersToMainSession()

◆ SetMainSessionAudioVolume()