Video SDK for iOS API Reference
All Classes Files Functions Enumerations Enumerator Properties
ZoomVideoSDKCRCHelper Class Reference

#include <ZoomVideoSDKCRCHelper.h>

Inherits NSObject.

Instance Methods

(BOOL) - isCRCEnabled
 Queries if the CRC feature is enabled.
 
(NSString *_Nullable) - getSessionSIPAddress
 Get 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

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.
Warning
Only available for the host/co-host.
Returns
If the function succeeds, the return value is Errors_Success. Otherwise the function returns a calling error. For more details, see [ZoomVideoSDKError] enum.

◆ cancelCallCRCDevice

- (ZoomVideoSDKError) cancelCallCRCDevice

Cancels the call to the CRC device.

Warning
Only available for the host/co-host.
Returns
If the function succeeds, the return value is Errors_Success. Otherwise the function returns a calling error. For more details, see [ZoomVideoSDKError] enum.

◆ 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 when 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 available after joining the session. Only available for the host/manager.