Zoom Rooms Controller SDK Reference 6.5.0
Loading...
Searching...
No Matches
Public Member Functions
IZoomRoomsService Class Referenceabstract

ZoomRooms Service Interface. More...

#include <IZoomRoomsService.h>

Public Member Functions

virtual ~IZoomRoomsService ()
 
virtual ZRCSDKError RegisterSink (IZoomRoomsServiceSink *pSink)=0
 Register ZoomRooms service callback sink.
 
virtual ZRCSDKError DeregisterSink (IZoomRoomsServiceSink *pSink)=0
 Deregister ZoomRooms service callback sink.
 
virtual ZRCSDKError PairRoomWithActivationCode (const std::string &activationCode)=0
 Pair Zoom Room with activation code.
 
virtual ZRCSDKError UnpairRoom ()=0
 Unpair SDK with current paired Zoom Room.
 
virtual ZRCSDKError RetryToPairRoom ()=0
 Retry to pair room without activation code.
 
virtual ZRCSDKError CanRetryToPairLastRoom (bool &canRetryToPair)=0
 Query if can retry to pair last room.
 
virtual ZRCSDKError GetLastZoomRoomInfo (ZoomRoomInfo &roomInfo)=0
 Get last paired Zoom Room's information.
 
virtual ISettingService * GetSettingService ()=0
 Get the setting service.
 
virtual IPreMeetingService * GetPreMeetingService ()=0
 Get the premeeting service.
 
virtual IMeetingService * GetMeetingService ()=0
 Get the meeting service.
 
virtual IPhoneCallService * GetPhoneCallService ()=0
 Get the phone call service.
 
virtual IProAVService * GetProAVService ()=0
 Get the Pro/AV service.
 

Detailed Description

ZoomRooms Service Interface.

Definition at line 61 of file IZoomRoomsService.h.

Constructor & Destructor Documentation

◆ ~IZoomRoomsService()

virtual IZoomRoomsService::~IZoomRoomsService ( )
inlinevirtual

Definition at line 64 of file IZoomRoomsService.h.

64{}

Member Function Documentation

◆ CanRetryToPairLastRoom()

virtual ZRCSDKError IZoomRoomsService::CanRetryToPairLastRoom ( bool &  canRetryToPair)
pure virtual

Query if can retry to pair last room.

Since
6.3.0
Zoom Rooms minimum version
6.0.0
Parameters
[out]canRetryToPairTRUE indicates can retry to pair last room. Otherwise not.
Returns
If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ DeregisterSink()

virtual ZRCSDKError IZoomRoomsService::DeregisterSink ( IZoomRoomsServiceSink *  pSink)
pure virtual

Deregister ZoomRooms service callback sink.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
pSinkA pointer to the IZoomRoomsServiceSink that receives the ZoomRooms service callback.
Returns
If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GetLastZoomRoomInfo()

virtual ZRCSDKError IZoomRoomsService::GetLastZoomRoomInfo ( ZoomRoomInfo &  roomInfo)
pure virtual

Get last paired Zoom Room's information.

Since
6.2.0
Zoom Rooms minimum version
6.0.0
Parameters
[out]roomInfoZoom Room's information.
Returns
If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GetMeetingService()

virtual IMeetingService * IZoomRoomsService::GetMeetingService ( )
pure virtual

Get the meeting service.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Returns
If the function succeeds, the return value is a pointer to IMeetingService. Otherwise the function returns NULL.

◆ GetPhoneCallService()

virtual IPhoneCallService * IZoomRoomsService::GetPhoneCallService ( )
pure virtual

Get the phone call service.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Returns
If the function succeeds, the return value is a pointer to IPhoneCallService. Otherwise the function returns NULL.

◆ GetPreMeetingService()

virtual IPreMeetingService * IZoomRoomsService::GetPreMeetingService ( )
pure virtual

Get the premeeting service.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Returns
If the function succeeds, the return value is a pointer to IPreMeetingService. Otherwise the function returns NULL.

◆ GetProAVService()

virtual IProAVService * IZoomRoomsService::GetProAVService ( )
pure virtual

Get the Pro/AV service.

Since
6.1.0
Zoom Rooms minimum version
6.1.0
Returns
If the function succeeds, the return value is a pointer to IProAVService. Otherwise the function returns NULL.

◆ GetSettingService()

virtual ISettingService * IZoomRoomsService::GetSettingService ( )
pure virtual

Get the setting service.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Returns
If the function succeeds, the return value is a pointer to ISettingService. Otherwise the function returns NULL.

◆ PairRoomWithActivationCode()

virtual ZRCSDKError IZoomRoomsService::PairRoomWithActivationCode ( const std::string &  activationCode)
pure virtual

Pair Zoom Room with activation code.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
activationCodeSpecify the Zoom Room's activation code.
Returns
If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ RegisterSink()

virtual ZRCSDKError IZoomRoomsService::RegisterSink ( IZoomRoomsServiceSink *  pSink)
pure virtual

Register ZoomRooms service callback sink.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
pSinkA pointer to the IZoomRoomsServiceSink that receives the ZoomRooms service callback.
Returns
If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ RetryToPairRoom()

virtual ZRCSDKError IZoomRoomsService::RetryToPairRoom ( )
pure virtual

Retry to pair room without activation code.

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.

◆ UnpairRoom()

virtual ZRCSDKError IZoomRoomsService::UnpairRoom ( )
pure virtual

Unpair SDK with current paired Zoom Room.

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.