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

PreMeeting service interface. More...

#include <IPreMeetingService.h>

Public Member Functions

virtual ~IPreMeetingService ()
 
virtual ZRCSDKError RegisterSink (IPreMeetingServiceSink *pSink)=0
 Register premeeting service callback sink.
 
virtual ZRCSDKError DeregisterSink (IPreMeetingServiceSink *pSink)=0
 Deregister premeeting service callback sink.
 
virtual ZRCSDKError GetConnectionState (ConnectionState &state)=0
 Query connection state with Zoom Room.
 
virtual ZRCSDKError NotifyZoomRoomsSendProblemReport (const std::string &subject, const std::string &body, LogType logType)=0
 Notify ZR to send problem report to Zoom.
 
virtual ZRCSDKError IsZoomRoomSupportRestartOS (bool &support)=0
 Query if ZR support restart OS.
 
virtual ZRCSDKError RestartZoomRoomOS ()=0
 Restart current room displays, scheduling displays and controllers.
 
virtual ZRCSDKError LogoutZoomRoomDevice ()=0
 Logout room and other paired devices.
 
virtual ZRCSDKError WakeZoomRoomUp ()=0
 Wake Zoom Room up.
 
virtual IContactHelper * GetContactHelper ()=0
 Get the contact helper.
 
virtual IBYODHelper * GetBYODHelper ()=0
 Get the BYOD helper.
 
virtual IControlSystemHelper * GetControlSystemHelper ()=0
 Get the control system helper.
 

Detailed Description

PreMeeting service interface.

Definition at line 63 of file IPreMeetingService.h.

Constructor & Destructor Documentation

◆ ~IPreMeetingService()

virtual IPreMeetingService::~IPreMeetingService ( )
inlinevirtual

Definition at line 66 of file IPreMeetingService.h.

66{}

Member Function Documentation

◆ DeregisterSink()

virtual ZRCSDKError IPreMeetingService::DeregisterSink ( IPreMeetingServiceSink *  pSink)
pure virtual

Deregister premeeting service callback sink.

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

◆ GetBYODHelper()

virtual IBYODHelper * IPreMeetingService::GetBYODHelper ( )
pure virtual

Get the BYOD helper.

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

◆ GetConnectionState()

virtual ZRCSDKError IPreMeetingService::GetConnectionState ( ConnectionState &  state)
pure virtual

Query connection state with Zoom Room.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
[out]stateConnection state, see ConnectionState enum.
Returns
If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GetContactHelper()

virtual IContactHelper * IPreMeetingService::GetContactHelper ( )
pure virtual

Get the contact helper.

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

◆ GetControlSystemHelper()

virtual IControlSystemHelper * IPreMeetingService::GetControlSystemHelper ( )
pure virtual

Get the control system helper.

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

◆ IsZoomRoomSupportRestartOS()

virtual ZRCSDKError IPreMeetingService::IsZoomRoomSupportRestartOS ( bool &  support)
pure virtual

Query if ZR support restart OS.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
[out]supportTRUE indicates ZR supports restart os.
Returns
If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ LogoutZoomRoomDevice()

virtual ZRCSDKError IPreMeetingService::LogoutZoomRoomDevice ( )
pure virtual

Logout room and other paired devices.

Since
6.1.0
Zoom Rooms minimum version
6.1.0
Returns
If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ NotifyZoomRoomsSendProblemReport()

virtual ZRCSDKError IPreMeetingService::NotifyZoomRoomsSendProblemReport ( const std::string &  subject,
const std::string &  body,
LogType  logType 
)
pure virtual

Notify ZR to send problem report to Zoom.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
subjectProblem report email subject.
bodyProblem report email body.
logTypeSend log type, see LogType enum.
Returns
If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ RegisterSink()

virtual ZRCSDKError IPreMeetingService::RegisterSink ( IPreMeetingServiceSink *  pSink)
pure virtual

Register premeeting service callback sink.

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

◆ RestartZoomRoomOS()

virtual ZRCSDKError IPreMeetingService::RestartZoomRoomOS ( )
pure virtual

Restart current room displays, scheduling displays and controllers.

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.

◆ WakeZoomRoomUp()

virtual ZRCSDKError IPreMeetingService::WakeZoomRoomUp ( )
pure virtual

Wake Zoom Room up.

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.