Camera Control helper interface. More...

#include <ICameraControlHelper.h>

Public Member Functions
virtual	~ICameraControlHelper ()

virtual ZRCSDKError	RegisterSink (ICameraControlHelperSink *pSink)=0
	Register camera control helper callback sink.

virtual ZRCSDKError	DeregisterSink (ICameraControlHelperSink *pSink)=0
	Deregister camera control helper callback sink.

virtual ZRCSDKError	EnableCompanionZRCamera (bool enable, bool isManuallySet, const std::string &companionZRID)=0
	Enable companion ZR camera.

virtual ZRCSDKError	ControlLocalCamera (const std::string &deviceID, CameraControlAction action, CameraControlType type, const std::string &companionZRID="")=0
	Control local camera.

virtual ZRCSDKError	ControlShareCamera (const std::string &deviceID, CameraControlAction action, CameraControlType type)=0
	Control shared camera.

virtual ZRCSDKError	ControlUserCamera (int32_t userID, CameraControlAction action, CameraControlType type)=0
	Control meeting user's camera.

virtual ZRCSDKError	RespondRemoteCameraControlFromUser (int32_t userID, bool accept)=0
	Respond remote camera control request from user.

virtual ZRCSDKError	UpdateLocalCameraPanTilt (uint32_t speedPercentage, const std::string &deviceID, const std::string &companionZRID="")=0
	Update local camera pan tilt.

virtual ZRCSDKError	UpdateShareCameraPanTilt (uint32_t speedPercentage, const std::string &deviceID)=0
	Update share camera pan tilt.

virtual ZRCSDKError	MirrorLocalVideo (bool mirrored, const std::string &deviceID, const std::string &companionZRID="")=0
	Mirror local video.

virtual ZRCSDKError	MirrorShareVideo (bool mirrored, const std::string &deviceID)=0
	Mirror share video.

virtual ZRCSDKError	SetCameraPreset (uint32_t index, const std::string &deviceID, const std::string &companionZRID="")=0
	Set camera preset in Zoom meeting, Integration Meeting and BYOD mode.

virtual ZRCSDKError	GoToCameraPreset (uint32_t index, const std::string &deviceID, const std::string &companionZRID="")=0
	Go to camera preset in Zoom meeting, Integration Meeting and BYOD mode.

virtual ZRCSDKError	NameCameraPreset (uint32_t index, const std::string &name, const std::string &deviceID, const std::string &companionZRID="")=0
	Naming camera preset in Zoom meeting, Integration Meeting and BYOD mode.

virtual ZRCSDKError	SetCameraDefaultPosition (uint32_t index, const std::string &deviceID, const std::string &companionZRID="")=0
	Set camera default position in Zoom meeting, Integration Meeting and BYOD mode.

virtual ZRCSDKError	CancelCameraDefaultPosition (uint32_t index, const std::string &deviceID, const std::string &companionZRID="")=0
	Cancel set camera default position in Zoom meeting, Integration Meeting and BYOD mode.

virtual ZRCSDKError	EnableSpeakerSwitching (bool enable)=0
	Enable speaker switching.

virtual ZRCSDKError	SwitchCamera ()=0
	Switch to use another camera when only connected two cameras.

virtual ZRCSDKError	SwitchToCamera (const Device &camera)=0
	Switch to use another camera.

virtual ZRCSDKError	SwitchUserCamera (int32_t userID)=0
	Switch meeting user's camera to another.

virtual ZRCSDKError	GetCameraIntelligentStatus (const std::string &companionZRID="")=0
	Get camera intelligent status. You can get the camera intelligent status from ICameraControlHelperSink::OnUpdateCameraIntelligentZoomNotification sink.

virtual ZRCSDKError	ChangeSmartCameraMode (SmartCameraMask mask, const std::string &deviceID, const std::string &companionZRID="")=0
	Change smart camera mode in meeting and BYOD mode.

virtual ZRCSDKError	CanEnableCameraBoundaryInCurrentSmartCameraMode (bool &canEnable)=0
	Check if can enable camera boundary in current smart camera mode.

virtual ZRCSDKError	EnableCameraBoundaryInCurrentSmartCameraMode (bool isEnable)=0
	Enable camera boundary in current smart camera mode.

virtual ZRCSDKError	OpenMultipleCamera (const std::string &deviceID, bool open, const std::string &companionZRID="")=0
	Open multiple camera in meeting.

Detailed Description

Camera Control helper interface.

Definition at line 217 of file ICameraControlHelper.h.

Constructor & Destructor Documentation

◆ ~ICameraControlHelper()

virtual ICameraControlHelper::~ICameraControlHelper ( )

inlinevirtual

Definition at line 220 of file ICameraControlHelper.h.

220{}

Member Function Documentation

◆ CancelCameraDefaultPosition()

virtual ZRCSDKError ICameraControlHelper::CancelCameraDefaultPosition	(	uint32_t	index,
		const std::string &	deviceID,
		const std::string &	companionZRID = `""`
	)

pure virtual

Cancel set camera default position in Zoom meeting, Integration Meeting and BYOD mode.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

index	Camera preset index.The index range is [0, 1, 2].
deviceID	Camera device id.
companionZRID	Specify the CZR ID if controlling CZR's camera.

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

Changelog

6.3.0: Added the ability to cancel set camera default position in BYOD mode.

◆ CanEnableCameraBoundaryInCurrentSmartCameraMode()

virtual ZRCSDKError ICameraControlHelper::CanEnableCameraBoundaryInCurrentSmartCameraMode ( bool & canEnable )

pure virtual

Check if can enable camera boundary in current smart camera mode.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

canEnable TRUE indicates can enable camera boundary in current smart camera mode. Otherwise not.

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

◆ ChangeSmartCameraMode()

virtual ZRCSDKError ICameraControlHelper::ChangeSmartCameraMode	(	SmartCameraMask	mask,
		const std::string &	deviceID,
		const std::string &	companionZRID = `""`
	)

pure virtual

Change smart camera mode in meeting and BYOD mode.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

mask	The new smart camera mode, see SmartCameraMask enum.
deviceID	Controlled camera device ID.
companionZRID	Specify the CZR ID if controlling CZR's camera.

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

Changelog

6.3.0: Added the ability to change smart camera mode in BYOD mode.

◆ ControlLocalCamera()

virtual ZRCSDKError ICameraControlHelper::ControlLocalCamera	(	const std::string &	deviceID,
		CameraControlAction	action,
		CameraControlType	type,
		const std::string &	companionZRID = `""`
	)

pure virtual

Control local camera.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

deviceID	Device ID of the camera to be controlled.
action	Camera control action, see CameraControlAction enum.
type	Camera control type, see CameraControlType enum.
companionZRID	Specify the CZR ID if controlling CZR's camera.

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

◆ ControlShareCamera()

virtual ZRCSDKError ICameraControlHelper::ControlShareCamera	(	const std::string &	deviceID,
		CameraControlAction	action,
		CameraControlType	type
	)

pure virtual

Control shared camera.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

deviceID	Device ID of the camera to be controlled.
action	Camera control action, see CameraControlAction enum.
type	Camera control type. Share camera only supports CameraControlTypeStart, CameraControlTypeContinue, CameraControlTypeStop, see CameraControlType enum.

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

◆ ControlUserCamera()

virtual ZRCSDKError ICameraControlHelper::ControlUserCamera	(	int32_t	userID,
		CameraControlAction	action,
		CameraControlType	type
	)

pure virtual

Control meeting user's camera.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

When you start to control user camera, first call with userId and CameraControlTypeControlOpenCtrlRemotePanel, then do other camera control action.

Parameters

userID	Meeting user ID to be controlled camera.
action	Camera control action, see CameraControlAction enum.
type	Camera control type, see CameraControlType enum.

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

◆ DeregisterSink()

virtual ZRCSDKError ICameraControlHelper::DeregisterSink ( ICameraControlHelperSink * pSink )

pure virtual

Deregister camera control helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the ICameraControlHelperSink that receives the camera control helper callback.

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

◆ EnableCameraBoundaryInCurrentSmartCameraMode()

virtual ZRCSDKError ICameraControlHelper::EnableCameraBoundaryInCurrentSmartCameraMode ( bool isEnable )

pure virtual

Enable camera boundary in current smart camera mode.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

isEnable TRUE indicates enable camera boundary in the current smart camera mode. Otherwise not.

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

◆ EnableCompanionZRCamera()

virtual ZRCSDKError ICameraControlHelper::EnableCompanionZRCamera	(	bool	enable,
		bool	isManuallySet,
		const std::string &	companionZRID
	)

pure virtual

Enable companion ZR camera.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

enable	TRUE indicates enable CZR camera. Otherwise disable.
isManuallySet	TRUE indicates manually set. False indicates the action is temporary, and not valid after the current meeting ends. You should use False when in meeting.
companionZRID	The CZR ID.

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

◆ EnableSpeakerSwitching()

virtual ZRCSDKError ICameraControlHelper::EnableSpeakerSwitching ( bool enable )

pure virtual

Enable speaker switching.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

enable TRUE indicates enable. Otherwise disable.

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

◆ GetCameraIntelligentStatus()

virtual ZRCSDKError ICameraControlHelper::GetCameraIntelligentStatus ( const std::string & companionZRID = "" )

pure virtual

Get camera intelligent status. You can get the camera intelligent status from ICameraControlHelperSink::OnUpdateCameraIntelligentZoomNotification sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

companionZRID Specify the CZR ID if controlling CZR's camera.

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

◆ GoToCameraPreset()

virtual ZRCSDKError ICameraControlHelper::GoToCameraPreset	(	uint32_t	index,
		const std::string &	deviceID,
		const std::string &	companionZRID = `""`
	)

pure virtual

Go to camera preset in Zoom meeting, Integration Meeting and BYOD mode.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

index	Camera preset index. The index range is [0, 1, 2].
deviceID	Camera device id.
companionZRID	Specify the CZR ID if controlling CZR's camera.

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

Changelog

6.3.0: Added the ability to go to camera preset in BYOD mode.

◆ MirrorLocalVideo()

virtual ZRCSDKError ICameraControlHelper::MirrorLocalVideo	(	bool	mirrored,
		const std::string &	deviceID,
		const std::string &	companionZRID = `""`
	)

pure virtual

Mirror local video.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

mirrored	TRUE indicates mirror local video. Otherwise not mirrored.
deviceID	The camera device ID. If empty, will control main camera.
companionZRID	Specify the CZR ID if controlling CZR's camera.

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

◆ MirrorShareVideo()

virtual ZRCSDKError ICameraControlHelper::MirrorShareVideo	(	bool	mirrored,
		const std::string &	deviceID
	)

pure virtual

Mirror share video.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

mirrored	TRUE indicates mirror share video. Otherwise not mirrored.
deviceID	The sharing camera device ID. See CameraSharingStatus struct.

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

◆ NameCameraPreset()

virtual ZRCSDKError ICameraControlHelper::NameCameraPreset	(	uint32_t	index,
		const std::string &	name,
		const std::string &	deviceID,
		const std::string &	companionZRID = `""`
	)

pure virtual

Naming camera preset in Zoom meeting, Integration Meeting and BYOD mode.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

index	Camera preset index. The index range is [0, 1, 2].
name	Camera preset name.
deviceID	Camera device id.
companionZRID	Specify the CZR ID if controlling CZR's camera.

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

Changelog

6.3.0: Added the ability to name camera preset in BYOD mode.

◆ OpenMultipleCamera()

virtual ZRCSDKError ICameraControlHelper::OpenMultipleCamera	(	const std::string &	deviceID,
		bool	open,
		const std::string &	companionZRID = `""`
	)

pure virtual

Open multiple camera in meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

deviceID	Specify the camera device ID to control.
open	TRUE indicates open multiple camera.
companionZRID	Specify the CZR ID if controlling CZR's camera.

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

◆ RegisterSink()

virtual ZRCSDKError ICameraControlHelper::RegisterSink ( ICameraControlHelperSink * pSink )

pure virtual

Register camera control helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the ICameraControlHelperSink that receives the camera control helper callback.

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

◆ RespondRemoteCameraControlFromUser()

virtual ZRCSDKError ICameraControlHelper::RespondRemoteCameraControlFromUser	(	int32_t	userID,
		bool	accept
	)

pure virtual

Respond remote camera control request from user.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userID	Specify the user ID who request camera control to respond
accept	TRUE indicates to accept remote camera control.

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

◆ SetCameraDefaultPosition()

virtual ZRCSDKError ICameraControlHelper::SetCameraDefaultPosition	(	uint32_t	index,
		const std::string &	deviceID,
		const std::string &	companionZRID = `""`
	)

pure virtual

Set camera default position in Zoom meeting, Integration Meeting and BYOD mode.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

index	Camera preset index. The index range is [0, 1, 2].
deviceID	Camera device id.
companionZRID	Specify the CZR ID if controlling CZR's camera.

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

Changelog

6.3.0: Added the ability to set camera default position in BYOD mode.

◆ SetCameraPreset()

virtual ZRCSDKError ICameraControlHelper::SetCameraPreset	(	uint32_t	index,
		const std::string &	deviceID,
		const std::string &	companionZRID = `""`
	)

pure virtual

Set camera preset in Zoom meeting, Integration Meeting and BYOD mode.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

index	Camera preset index. The index range is [0, 1, 2].
deviceID	Camera device id.
companionZRID	Specify the CZR ID if controlling CZR's camera.

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

Changelog

6.3.0: Added the ability to set camera preset in BYOD mode.

◆ SwitchCamera()

virtual ZRCSDKError ICameraControlHelper::SwitchCamera ( )

pure virtual

Switch to use another camera when only connected two cameras.

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.

◆ SwitchToCamera()

virtual ZRCSDKError ICameraControlHelper::SwitchToCamera ( const Device & camera )

pure virtual

Switch to use another camera.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

camera Chosen camera to use.

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

◆ SwitchUserCamera()

virtual ZRCSDKError ICameraControlHelper::SwitchUserCamera ( int32_t userID )

pure virtual

Switch meeting user's camera to another.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userID Specify user ID to switch camera.

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

◆ UpdateLocalCameraPanTilt()

virtual ZRCSDKError ICameraControlHelper::UpdateLocalCameraPanTilt	(	uint32_t	speedPercentage,
		const std::string &	deviceID,
		const std::string &	companionZRID = `""`
	)

pure virtual

Update local camera pan tilt.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

speedPercentage	Camera pan tilt speed, must be larger than 0.
deviceID	Device ID of the camera to be controlled.
companionZRID	Specify the CZR ID if controlling CZR's camera.

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

◆ UpdateShareCameraPanTilt()

virtual ZRCSDKError ICameraControlHelper::UpdateShareCameraPanTilt	(	uint32_t	speedPercentage,
		const std::string &	deviceID
	)

pure virtual

Update share camera pan tilt.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

speedPercentage	Camera pan tilt speed, must be larger than 0.
deviceID	Device ID of share camera to be controlled.

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~ICameraControlHelper()

Member Function Documentation

◆ CancelCameraDefaultPosition()

◆ CanEnableCameraBoundaryInCurrentSmartCameraMode()

◆ ChangeSmartCameraMode()

◆ ControlLocalCamera()

◆ ControlShareCamera()

◆ ControlUserCamera()

◆ DeregisterSink()

◆ EnableCameraBoundaryInCurrentSmartCameraMode()

◆ EnableCompanionZRCamera()

◆ EnableSpeakerSwitching()

◆ GetCameraIntelligentStatus()

◆ GoToCameraPreset()

◆ MirrorLocalVideo()

◆ MirrorShareVideo()

◆ NameCameraPreset()

◆ OpenMultipleCamera()

◆ RegisterSink()

◆ RespondRemoteCameraControlFromUser()

◆ SetCameraDefaultPosition()

◆ SetCameraPreset()

◆ SwitchCamera()

◆ SwitchToCamera()

◆ SwitchUserCamera()

◆ UpdateLocalCameraPanTilt()

◆ UpdateShareCameraPanTilt()