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

The command channel allows users to send commands or data (such as plain text or a binary encoded into string) to other users in the same session. See [ZoomVideoSDK.h#getCmdChannel]. More...

#include <ZoomVideoSDKCmdChannel.h>

Inherits NSObject.

Instance Methods

(ZoomVideoSDKError- sendCommand:receiveUser:
 Send custom commands or data to other users in the current session. Limit: up to 60 custom commands per second.
 

Detailed Description

The command channel allows users to send commands or data (such as plain text or a binary encoded into string) to other users in the same session. See [ZoomVideoSDK.h#getCmdChannel].

Definition at line 16 of file ZoomVideoSDKCmdChannel.h.

Method Documentation

◆ sendCommand:receiveUser:

- (ZoomVideoSDKError) sendCommand: (NSString *_Nullable) commandContent
receiveUser: (ZoomVideoSDKUser *_Nullable) user 

Send custom commands or data to other users in the current session. Limit: up to 60 custom commands per second.

Parameters
commandContentthe custom commands or data, represented in string format.
userAn instance of ZoomVideoSDKUser associated with the user who receives the command. See [ZoomVideoSDKUser] If receiver is set to nil, the command is broadcast to all users.
Returns
Errors_Success if the command sends successfully. Otherwise, the send command request fails. See error codes defined in [ZoomVideoSDKError].