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 or co-host.
(ZMVideoSDKErrors- cancelCallCRCDevice
 Cancels the call to the CRC device. Only available for the host or co-host.
(NSString *_Nullable) - getSessionSIPAddress
 Gets 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 or co-host.

Parameters
addressThe CRC device's IP address.
callProtocolThe CRC device's protocol.
Returns
If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ cancelCallCRCDevice

- (ZMVideoSDKErrors) cancelCallCRCDevice

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

Returns
If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

References cancelCallCRCDevice.

Referenced by cancelCallCRCDevice.

◆ getSessionSIPAddress

- (NSString *_Nullable) getSessionSIPAddress

Gets 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.

References getSessionSIPAddress.

Referenced by getSessionSIPAddress.

◆ isCRCEnabled

- (BOOL) isCRCEnabled

Queries if the CRC feature is enabled.

Returns
YES if the CRC is enabled. Otherwise, NO.
Warning
Only get the correct value after joining the session.

References isCRCEnabled.

Referenced by isCRCEnabled.