IBYODHelper Class Reference

BYOD helper interface. More...

#include <IBYODHelper.h>

Public Member Functions
virtual	~IBYODHelper ()
virtual ZRCSDKError	RegisterSink (IBYODHelperSink *pSink)=0
	Register BYOD helper callback sink.
virtual ZRCSDKError	DeregisterSink (IBYODHelperSink *pSink)=0
	Deregister BYOD helper callback sink.
virtual ZRCSDKError	ActiveBYODMode ()=0
	Active BYOD mode, you can use ZR's camera, speaker, microphone and screen.
virtual ZRCSDKError	ActiveHDMIShare ()=0
	Active HDMI share, you can only share content on ZR's screen. The API can be called to enter HDMI share when BYOD mode status is plugin.
virtual ZRCSDKError	DeactivateBYOD ()=0
	Deactivate BYOD.
virtual ZRCSDKError	SetBYODCameraControl (CameraControlAction controlAction, CameraControlType controlType)=0
	Control BYOD camera.
virtual ZRCSDKError	SetBYODAutoFramingOn (bool autoFramingOn)=0
	Control BYOD auto framing.
virtual ZRCSDKError	SetBYODMicrophoneMuted (bool muted)=0
	Control BYOD microphone.
virtual ZRCSDKError	SetBYODSpeakerVolume (int32_t volume)=0
	Control BYOD speaker volume.
virtual ZRCSDKError	MakeEmergencyCallInBYODMode ()=0
	Exit BYOD mode for making emergency call in BYOD mode. Call this API will only exit BYOD mode but not make emergency call.

Detailed Description

BYOD helper interface.

Definition at line 175 of file IBYODHelper.h.

Constructor & Destructor Documentation

~IBYODHelper()

virtual IBYODHelper::~IBYODHelper ( )

inlinevirtual

Definition at line 178 of file IBYODHelper.h.

{}

Member Function Documentation

ActiveBYODMode()

virtual ZRCSDKError IBYODHelper::ActiveBYODMode ( )

pure virtual

Active BYOD mode, you can use ZR's camera, speaker, microphone and screen.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

If supportManuallyOperate field in BYODModeInfo struct is true, you can exit BYOD mode by calling ExitBYODMode; otherwise you can only exit BYOD mode by unplugging the personal device.

Returns

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

ActiveHDMIShare()

virtual ZRCSDKError IBYODHelper::ActiveHDMIShare ( )

pure virtual

Active HDMI share, you can only share content on ZR's screen. The API can be called to enter HDMI share when BYOD mode status is plugin.

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.

DeactivateBYOD()

virtual ZRCSDKError IBYODHelper::DeactivateBYOD ( )

pure virtual

Deactivate BYOD.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

You can call this API when the BYOD mode status is plugin and you do not want to enter BYOD mode or HDMI share, or when you want to exit BYOD mode and the supportManuallyOperate field in BYODModeInfo struct is true.

Returns

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

DeregisterSink()

virtual ZRCSDKError IBYODHelper::DeregisterSink ( IBYODHelperSink *  pSink )

pure virtual

Deregister BYOD helper callback sink.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

pSink

A pointer to the IBYODHelperSink that receives the BYOD helper callback.

Returns

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

MakeEmergencyCallInBYODMode()

virtual ZRCSDKError IBYODHelper::MakeEmergencyCallInBYODMode ( )

pure virtual

Exit BYOD mode for making emergency call in BYOD mode. Call this API will only exit BYOD mode but not make emergency call.

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.

RegisterSink()

virtual ZRCSDKError IBYODHelper::RegisterSink ( IBYODHelperSink *  pSink )

pure virtual

Register BYOD helper callback sink.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

pSink

A pointer to the IBYODHelperSink that receives the BYOD helper callback.

Returns

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

SetBYODAutoFramingOn()

virtual ZRCSDKError IBYODHelper::SetBYODAutoFramingOn ( bool  autoFramingOn )

pure virtual

Control BYOD auto framing.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

autoFramingOn

TRUE indicates set BYOD auto framing on.

Returns

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

SetBYODCameraControl()

virtual ZRCSDKError IBYODHelper::SetBYODCameraControl ( CameraControlAction  controlAction, CameraControlType  controlType  )

pure virtual

Control BYOD camera.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

controlAction	Camera control action, see CameraControlAction enum.
controlType	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.

SetBYODMicrophoneMuted()

virtual ZRCSDKError IBYODHelper::SetBYODMicrophoneMuted ( bool  muted )

pure virtual

Control BYOD microphone.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

muted

TRUE indicates set BYOD microphone muted.

Returns

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

SetBYODSpeakerVolume()

virtual ZRCSDKError IBYODHelper::SetBYODSpeakerVolume ( int32_t  volume )

pure virtual

Control BYOD speaker volume.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

volume

Speaker volume [0 - 100].

Returns

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