Video SDK for iOS API Reference
Loading...
Searching...
No Matches
ZoomVideoSDKCRCHelper Class Reference

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

#include <ZoomVideoSDKCRCHelper.h>

Inherits NSObject.

Instance Methods

(BOOL) - isCRCEnabled
 Determines whether the CRC feature is enabled.
 
(NSString *_Nullable) - getSessionSIPAddress
 Gets the dial-in SIP address of a live session when CRC is enabled.
 
(ZoomVideoSDKError- callCRCDevice:protocol:
 Calls the CRC device.
 
(ZoomVideoSDKError- cancelCallCRCDevice
 Cancels the call to the CRC device.
 

Detailed Description

Helper interface for Cloud Room Connector (CRC) features.

Definition at line 12 of file ZoomVideoSDKCRCHelper.h.

Method Documentation

◆ callCRCDevice:protocol:

- (ZoomVideoSDKError) callCRCDevice: (NSString *_Nullable) ipAddr
protocol: (ZoomVideoSDKCRCProtocol) protocol 

Calls the CRC device.

Parameters
ipAddrThe CRC device's IP address.
protocolThe protocol of the CRC device.
Returns
If the function succeeds, it returns Errors_Success. Otherwise, this function returns an error.
Warning
Only available for the host or co-host.

◆ cancelCallCRCDevice

- (ZoomVideoSDKError) cancelCallCRCDevice

Cancels the call to the CRC device.

Returns
If the function succeeds, it returns Errors_Success. Otherwise, this function returns an error.
Warning
Only available for the host or co-host.

◆ getSessionSIPAddress

- (NSString *_Nullable) getSessionSIPAddress

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

Returns
If the function succeeds, it returns the live session SIP address. Otherwise, this function fails and returns nil.

◆ isCRCEnabled

- (BOOL) isCRCEnabled

Determines whether the CRC feature is enabled.

Returns
YES if the CRC is enabled. Otherwise, NO.
Warning
Only available after joining the session. Only available for the host or manager.