Video SDK for Linux API Reference
Loading...
Searching...
No Matches
IZoomVideoSDKCmdChannel Class Referenceabstract

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 <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. 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.

Definition at line 16 of file zoom_video_sdk_cmd_channel_interface.h.

Constructor & Destructor Documentation

◆ ~IZoomVideoSDKCmdChannel()

virtual IZoomVideoSDKCmdChannel::~IZoomVideoSDKCmdChannel ( )
inlinevirtual

Definition at line 19 of file zoom_video_sdk_cmd_channel_interface.h.

19{}

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. Limit: up to 60 custom commands per second.

Parameters
receiverThe user who receives the command, if receiver is set to nullptr, the command is broadcast to all users. see IZoomVideoSDKUser.
strCmdThe custom commands or data.
Returns
If the command sends successfully, the return value is ZoomVideoSDKErrors_Success. Otherwise the send command request fails. To get extended error information, see ZoomVideoSDKErrors enum.