CommandService

The CommandService allows the application to send text messages or notifications to all conference participants. The service also emits an received event to inform the application about received messages.

Events

received

received(participant: Participant, message: String): void

Emitted when a participant receives a message.

example

VoxeetSDK.command.on("received", (participant, message) => {});

Parameters:

NameTypeDescription
participantParticipantThe participant who sent the message.
messagestringThe received message.

Returns: void

Methods

send

send(message: string): Promise‹any›

Sends a message, in the form of a string, to all conference participants. Message size is limited to 16KB.

This method is not available for Real-time Streaming viewers and triggers the UnsupportedError.

Parameters:

NameTypeDescription
messagestringThe message to send.

Returns: Promise‹any›