ZoomRooms Service Interface.
More...
#include <IZoomRoomsService.h>
ZoomRooms Service Interface.
Definition at line 61 of file IZoomRoomsService.h.
◆ ~IZoomRoomsService()
| virtual IZoomRoomsService::~IZoomRoomsService |
( |
| ) |
|
|
inlinevirtual |
◆ 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
-
- Returns
- If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.
◆ DeregisterSink()
Deregister ZoomRooms service callback sink.
- Since
- 6.0.0
- Zoom Rooms minimum version
- 6.0.0
- Parameters
-
- Returns
- If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.
◆ GetLastZoomRoomInfo()
Get last paired Zoom Room's information.
- Since
- 6.2.0
- Zoom Rooms minimum version
- 6.0.0
- Parameters
-
| [out] | roomInfo | Zoom 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()
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()
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()
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()
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()
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
-
| activationCode | Specify 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()
Register ZoomRooms service callback sink.
- Since
- 6.0.0
- Zoom Rooms minimum version
- 6.0.0
- Parameters
-
- 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
Uses the persisted refresh token from a previous successful pair. Call this after process restart instead of pairing with an activation code again.
- Returns
- If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Success means the retry request was sent; the pairing result is reported by IZoomRoomsServiceSink::OnPairRoomResult. If there is no valid refresh token, the return value is ZRCSDKERR_TOKEN_EXPIRED. That covers both cases: the token is missing (never paired, or unpaired) and the token is locally known to have expired. Pair again with PairRoomWithActivationCode. Otherwise failed. To get extended error information, see ZRCSDKError enum.
- Note
- A synchronous ZRCSDKERR_SUCCESS does not guarantee the server still accepts the token. If the server rejects an expired token, failure is reported asynchronously in OnPairRoomResult.
◆ UnpairRoom()
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.