IMeetingCameraHelper Class Reference

Meeting camera helper interface. More...

#include <meeting_video_interface.h>

Public Member Functions
virtual	~IMeetingCameraHelper ()
virtual unsigned int	GetUserId ()=0
	Gets the current controlled user ID.
virtual bool	CanControlCamera ()=0
	Whether the camera can be controlled or not.
virtual SDKError	RequestControlRemoteCamera ()=0
	Request to control remote camera.
virtual SDKError	GiveUpControlRemoteCamera ()=0
	Give up control of the remote camera.
virtual SDKError	TurnLeft (unsigned int range=50)=0
	Turn the camera to the left.
virtual SDKError	TurnRight (unsigned int range=50)=0
	Turn the camera to the right.
virtual SDKError	TurnUp (unsigned int range=50)=0
	Turn the camera up.
virtual SDKError	TurnDown (unsigned int range=50)=0
	Turn the camera down.
virtual SDKError	ZoomIn (unsigned int range=50)=0
	Zoom the camera in.
virtual SDKError	ZoomOut (unsigned int range=50)=0
	Zoom the camera out.

Detailed Description

Meeting camera helper interface.

Definition at line 249 of file meeting_video_interface.h.

Constructor & Destructor Documentation

~IMeetingCameraHelper()

virtual IMeetingCameraHelper::~IMeetingCameraHelper ( )

inlinevirtual

Definition at line 252 of file meeting_video_interface.h.

{}

Member Function Documentation

CanControlCamera()

virtual bool IMeetingCameraHelper::CanControlCamera ( )

pure virtual

Whether the camera can be controlled or not.

Returns

true if the user can control camera, false if they can't.

GetUserId()

virtual unsigned int IMeetingCameraHelper::GetUserId ( )

pure virtual

Gets the current controlled user ID.

Returns

If the function succeeds, the return value is the user ID. Otherwise, this returns 0.

GiveUpControlRemoteCamera()

virtual SDKError IMeetingCameraHelper::GiveUpControlRemoteCamera ( )

pure virtual

Give up control of the remote camera.

Returns

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

RequestControlRemoteCamera()

virtual SDKError IMeetingCameraHelper::RequestControlRemoteCamera ( )

pure virtual

Request to control remote camera.

Returns

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

TurnDown()

virtual SDKError IMeetingCameraHelper::TurnDown ( unsigned int range = 50 )

pure virtual

Turn the camera down.

Parameters

range

Rotation range, 10 <= range <= 100.

Returns

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

TurnLeft()

virtual SDKError IMeetingCameraHelper::TurnLeft ( unsigned int range = 50 )

pure virtual

Turn the camera to the left.

Parameters

range

Rotation range, 10 <= range <= 100.

Returns

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

TurnRight()

virtual SDKError IMeetingCameraHelper::TurnRight ( unsigned int range = 50 )

pure virtual

Turn the camera to the right.

Parameters

range

Rotation range, 10 <= range <= 100.

Returns

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

TurnUp()

virtual SDKError IMeetingCameraHelper::TurnUp ( unsigned int range = 50 )

pure virtual

Turn the camera up.

Parameters

range

Rotation range, 10 <= range <= 100.

Returns

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

ZoomIn()

virtual SDKError IMeetingCameraHelper::ZoomIn ( unsigned int range = 50 )

pure virtual

Zoom the camera in.

Parameters

range

Rotation range, 10 <= range <= 100.

Returns

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

ZoomOut()

virtual SDKError IMeetingCameraHelper::ZoomOut ( unsigned int range = 50 )

pure virtual

Zoom the camera out.

Parameters

range

Rotation range, 10 <= range <= 100.

Returns

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