The command channel. More...

#include <zoom_video_sdk_cmd_channel_interface.h>

Public Member Functions
virtual	~IZoomVideoSDKCmdChannel ()
virtual ZoomVideoSDKErrors	sendCommand (IZoomVideoSDKUser receiver, const zchar_t strCmd)=0
	Send custom commands or data to other users in the current session. This API is rate-limited; overly frequent calls return ZoomVideoSDKErrors_Call_Too_Frequently.
virtual ZoomVideoSDKErrors	sendCommandToSubSessionUser (ISubSessionUser subSessionUser, const zchar_t strCmd)=0
	Send a command to a subsession user. Supports cross-session delivery between the main session and subsessions (breakout rooms).

Detailed Description

The command channel.

Note: 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 20 of file zoom_video_sdk_cmd_channel_interface.h.

Constructor & Destructor Documentation

◆ ~IZoomVideoSDKCmdChannel()

virtual IZoomVideoSDKCmdChannel::~IZoomVideoSDKCmdChannel ( )

inlinevirtual

Definition at line 23 of file zoom_video_sdk_cmd_channel_interface.h.

23{}

Member Function Documentation

◆ sendCommand()

virtual ZoomVideoSDKErrors IZoomVideoSDKCmdChannel::sendCommand	(	IZoomVideoSDKUser *	receiver,
		const zchar_t *	strCmd )

pure virtual

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

Parameters

receiver	The user who receives the command, if receiver is set to nullptr, the command is broadcast to all users.
strCmd	The custom commands or data.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ sendCommandToSubSessionUser()

virtual ZoomVideoSDKErrors IZoomVideoSDKCmdChannel::sendCommandToSubSessionUser	(	ISubSessionUser *	subSessionUser,
		const zchar_t *	strCmd )