IMeetingProductionStudioController Class Reference

Production studio controller interface. More...

#include <meeting_production_studio_ctrl_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IMeetingProductionStudioCtrlEvent *pEvent)=0
	Configure the meeting production studio controller callback event handler.
virtual bool	IsSupportPSMode ()=0
virtual bool	CanStartPSMode ()=0
	Determine whether you have permission to start production studio. Only host or co-host can start production studio mode.
virtual SDKError	StartPSMode (PSVideoSourceCapability capability)=0
	Start production studio mode.
virtual SDKError	StopPSMode ()=0
	Stop production studio mode.
virtual unsigned int	GetPSUserID ()=0
	Get the user ID of current production studio user.
virtual bool	IsPSModeStarted ()=0

Detailed Description

Production studio controller interface.

Definition at line 68 of file meeting_production_studio_ctrl_interface.h.

Member Function Documentation

CanStartPSMode()

virtual bool IMeetingProductionStudioController::CanStartPSMode ( )

pure virtual

Determine whether you have permission to start production studio. Only host or co-host can start production studio mode.

Returns

True indicates you can start production studio mode.

GetPSUserID()

virtual unsigned int IMeetingProductionStudioController::GetPSUserID ( )

pure virtual

Get the user ID of current production studio user.

IsPSModeStarted()

virtual bool IMeetingProductionStudioController::IsPSModeStarted ( )

pure virtual

Returns

True indicates to started.

IsSupportPSMode()

virtual bool IMeetingProductionStudioController::IsSupportPSMode ( )

pure virtual

Returns

True indicates to support.

SetEvent()

virtual SDKError IMeetingProductionStudioController::SetEvent ( IMeetingProductionStudioCtrlEvent * pEvent )

pure virtual

Configure the meeting production studio controller callback event handler.

Parameters

pEvent

An object pointer to the IMeetingProductionStudioCtrlEvent that receives the meeting production studio callback event. For more details, see IMeetingProductionStudioCtrlEvent.

Returns

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

Remarks

The SDK use pEvent to transmit the callback event to the user's application. If the function is not called or fails, the user's application is unable to retrieve the callback event.

StartPSMode()

virtual SDKError IMeetingProductionStudioController::StartPSMode ( PSVideoSourceCapability capability )

pure virtual

Start production studio mode.

Parameters

capability

Specify the format description of the video data send. For more details, see PSVideoSourceCapability enum.

Returns

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

StopPSMode()

virtual SDKError IMeetingProductionStudioController::StopPSMode ( )

pure virtual

Stop production studio mode.

Returns

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