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:
	Sends custom commands or data to other users in the current session. This API is rate-limited; overly frequent calls return Errors_Call_Too_Frequently.
(ZoomVideoSDKError)	- sendCommandToSubSessionUser:subSessionUser:
	Sends a command to a subsession user. Supports cross-session delivery between the main session and subsessions (breakout rooms).

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 14 of file ZoomVideoSDKCmdChannel.h.

Method Documentation

sendCommand:receiveUser:

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

Sends custom commands or data to other users in the current session. This API is rate-limited; overly frequent calls return Errors_Call_Too_Frequently.

Parameters

commandContent	The custom commands or data, represented in string format.
user	An instance of ZoomVideoSDKUser associated with the user who receives the command. If receiver is set to nil, the command is broadcast to all users.

Returns

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

sendCommandToSubSessionUser:subSessionUser:

- (ZoomVideoSDKError) sendCommandToSubSessionUser:		(NSString *_Nullable)	commandContent
subSessionUser:		(ZoomVideoSDKSubSessionUser *_Nullable)	subSessionUser

Sends a command to a subsession user. Supports cross-session delivery between the main session and subsessions (breakout rooms).

Parameters

commandContent	The custom command or data.
subSessionUser	The target subsession user. Obtain it from getSubSessionUserList (ZoomVideoSDKSubSessionKit).

Returns

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