Video SDK for MacOS API Reference
Loading...
Searching...
No Matches
ZMVideoSDKCRCHelper Class Reference

Helper interface for Cloud Room Connector (CRC) features. More...

#include <ZMVideoSDKCRCHelper.h>

Inherits NSObject.

Instance Methods

(BOOL) - isCRCEnabled
 Queries if the CRC feature is enabled.
 
(ZMVideoSDKErrors- callCRCDevice:protocol:
 Calls the CRC device. Only available for the host/co-host.
 
(ZMVideoSDKErrors- cancelCallCRCDevice
 Cancels the call to the CRC device. Only available for the host/co-host.
 
(NSString *_Nullable) - getSessionSIPAddress
 Get the dial-in SIP address of a live session when CRC is enabled.
 

Detailed Description

Helper interface for Cloud Room Connector (CRC) features.

Definition at line 14 of file ZMVideoSDKCRCHelper.h.

Method Documentation

◆ callCRCDevice:protocol:

- (ZMVideoSDKErrors) callCRCDevice: (NSString *) address
protocol: (ZMVideoSDKCRCProtocol) callProtocol 

Calls the CRC device. Only available for the host/co-host.

Parameters
addressThe CRC device's IP address.
callProtocolThe protocol of the CRC device.
Returns
If the function succeeds, it will return ZMVideoSDKErrors_Success.

◆ cancelCallCRCDevice

- (ZMVideoSDKErrors) cancelCallCRCDevice

Cancels the call to the CRC device. Only available for the host/co-host.

Returns
If the function succeeds, it will return ZMVideoSDKErrors_Success.

◆ getSessionSIPAddress

- (NSString *_Nullable) getSessionSIPAddress

Get the dial-in SIP address of a live session when CRC is enabled.

Returns
Return the live session SIP address if the CRC is enabled. Otherwise, return nil.

◆ isCRCEnabled

- (BOOL) isCRCEnabled

Queries if the CRC feature is enabled.

Returns
YES means that the CRC is enabled, otherwise it's disabled.
Warning
Only get the correct value after joining the session.