Zoom Rooms Controller SDK Reference 6.5.0
Loading...
Searching...
No Matches
ICameraControlHelperSink Class Referenceabstract

Camera Control helper event callback. More...

#include <ICameraControlHelper.h>

Public Member Functions

virtual ~ICameraControlHelperSink ()
 
virtual void OnUpdateSpeakerSwitchingSettingsNotification (const SpeakerSwitchingSettingsInfo &info)=0
 Speaker switching settings changed callback.
 
virtual void OnEnableSpeakerSwitchingResult (int32_t result, bool speakerSwitchingEnabledOnZR)=0
 Enable speaker switching on ZR result.
 
virtual void OnUpdateCameraIntelligentZoomNotification (const CameraIntelligentZoomInfo &info)=0
 Camera intelligent zoom info changed callback.
 
virtual void OnUpdateMultiCameraEnabled (bool isMultiCameraEnabled)=0
 Multi camera enable update notification.
 
virtual void OnUpdateMaxMultiCameraCount (int32_t maxMultiCameraCount)=0
 Max multi camera count update notification.
 
virtual void OnUpdateMainCameraControlInfo (const CameraControlInfo &mainCameraControlInfo)=0
 Main camera control info update notification.
 
virtual void OnUpdateMultiCameraControlInfos (const std::vector< CameraControlInfo > &multiCameraControlInfos)=0
 Max multi camera control info list update notification.
 
virtual void OnCameraPanTiltResult (const CameraPanTiltResult &result)=0
 Camera pan tilt result callback.
 
virtual void OnUpdateMeetingUserCameraControlStatus (int32_t userID, const CameraControlStatus &cameraControlStatus)=0
 Meeting user's camera control status changed callback.
 
virtual void OnFarEndCameraControlNotification (const FarEndCameraControlInfo &cameraControlInfo)=0
 Far end camera control notify callback.
 
virtual void OnFarEndCameraCameraControlResult (int32_t result, CameraControlType type, bool accept)=0
 Far end control camera result callback.
 
virtual void OnTreatedCameraControlRequestNotification (bool accepted, int32_t userID)=0
 Treated camera control request on Zoom Room Touch notify callback.
 
virtual void OnMirrorVideoResult (const MirrorSelfVideoRes &response)=0
 Mirror video response.
 
virtual void OnUpdateCameraPresetInfo (const CameraPresetInfo &info)=0
 Camera preset info update notification.
 

Detailed Description

Camera Control helper event callback.

Definition at line 64 of file ICameraControlHelper.h.

Constructor & Destructor Documentation

◆ ~ICameraControlHelperSink()

virtual ICameraControlHelperSink::~ICameraControlHelperSink ( )
inlinevirtual

Definition at line 67 of file ICameraControlHelper.h.

67{}

Member Function Documentation

◆ OnCameraPanTiltResult()

virtual void ICameraControlHelperSink::OnCameraPanTiltResult ( const CameraPanTiltResult result)
pure virtual

Camera pan tilt result callback.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
resultResult of camera pan tilt.

◆ OnEnableSpeakerSwitchingResult()

virtual void ICameraControlHelperSink::OnEnableSpeakerSwitchingResult ( int32_t  result,
bool  speakerSwitchingEnabledOnZR 
)
pure virtual

Enable speaker switching on ZR result.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
result[0] success else fail.
speakerSwitchingEnabledOnZRTRUE indicates speaker switching enabled on ZR.

◆ OnFarEndCameraCameraControlResult()

virtual void ICameraControlHelperSink::OnFarEndCameraCameraControlResult ( int32_t  result,
CameraControlType  type,
bool  accept 
)
pure virtual

Far end control camera result callback.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
result[0] success else fail.
typeCamera control type.
acceptAccept remote camera control request.

◆ OnFarEndCameraControlNotification()

virtual void ICameraControlHelperSink::OnFarEndCameraControlNotification ( const FarEndCameraControlInfo cameraControlInfo)
pure virtual

Far end camera control notify callback.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
cameraControlInfoFar end camera control info.

◆ OnMirrorVideoResult()

virtual void ICameraControlHelperSink::OnMirrorVideoResult ( const MirrorSelfVideoRes response)
pure virtual

Mirror video response.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
responseThe response.

◆ OnTreatedCameraControlRequestNotification()

virtual void ICameraControlHelperSink::OnTreatedCameraControlRequestNotification ( bool  accepted,
int32_t  userID 
)
pure virtual

Treated camera control request on Zoom Room Touch notify callback.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
acceptedTRUE indicates ZRT accepted far end user's request to control camera. Otherwise not.
userIDFar end meeting user ID.

◆ OnUpdateCameraIntelligentZoomNotification()

virtual void ICameraControlHelperSink::OnUpdateCameraIntelligentZoomNotification ( const CameraIntelligentZoomInfo info)
pure virtual

Camera intelligent zoom info changed callback.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
infoThe updated camera intelligent zoom info.

◆ OnUpdateCameraPresetInfo()

virtual void ICameraControlHelperSink::OnUpdateCameraPresetInfo ( const CameraPresetInfo info)
pure virtual

Camera preset info update notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
infoCamera preset info.

◆ OnUpdateMainCameraControlInfo()

virtual void ICameraControlHelperSink::OnUpdateMainCameraControlInfo ( const CameraControlInfo mainCameraControlInfo)
pure virtual

Main camera control info update notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
mainCameraControlInfoThe main camera control info.

◆ OnUpdateMaxMultiCameraCount()

virtual void ICameraControlHelperSink::OnUpdateMaxMultiCameraCount ( int32_t  maxMultiCameraCount)
pure virtual

Max multi camera count update notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
maxMultiCameraCountMax count.

◆ OnUpdateMeetingUserCameraControlStatus()

virtual void ICameraControlHelperSink::OnUpdateMeetingUserCameraControlStatus ( int32_t  userID,
const CameraControlStatus cameraControlStatus 
)
pure virtual

Meeting user's camera control status changed callback.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
userIDMeeting user ID.
cameraControlStatusThe user's camera control status.

◆ OnUpdateMultiCameraControlInfos()

virtual void ICameraControlHelperSink::OnUpdateMultiCameraControlInfos ( const std::vector< CameraControlInfo > &  multiCameraControlInfos)
pure virtual

Max multi camera control info list update notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
multiCameraControlInfosThe multi camera control infos.

◆ OnUpdateMultiCameraEnabled()

virtual void ICameraControlHelperSink::OnUpdateMultiCameraEnabled ( bool  isMultiCameraEnabled)
pure virtual

Multi camera enable update notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
isMultiCameraEnabledTRUE indicates multi camera is enabled.

◆ OnUpdateSpeakerSwitchingSettingsNotification()

virtual void ICameraControlHelperSink::OnUpdateSpeakerSwitchingSettingsNotification ( const SpeakerSwitchingSettingsInfo info)
pure virtual

Speaker switching settings changed callback.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
infoThe updated speaker switching settings information.