Video SDK for MacOS API Reference
Loading...
Searching...
No Matches
ZMVideoSDKCmdChannel 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. More...

#include <ZMVideoSDKCmdChannel.h>

Inherits NSObject.

Instance Methods

(ZMVideoSDKErrors- sendCommand:receiveUser:
 Send custom commands or data to other users in the current session.
 

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.

Definition at line 16 of file ZMVideoSDKCmdChannel.h.

Method Documentation

◆ sendCommand:receiveUser:

- (ZMVideoSDKErrors) sendCommand: (NSString *) commandContent
receiveUser: (nullable ZMVideoSDKUser *) user 

Send custom commands or data to other users in the current session.

Parameters
commandContentthe custom commands or data, represented in string format.
userThe target user to receive the command. If nil, the command is broadcast to all users.
Returns
If the function succeeds, it will return ZMVideoSDKErrors_Success, otherwise failed.
Note
Limit up to 60 custom commands per second.