2020 API AWARDS WINNER - BEST IN MEDIA APIs LEARN MORE

CommandService

The CommandService allows the application to send custom text commands to all other participants of a specific conference. The service also emits an event to inform the application about received messages.


Events

received

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

Emitted when a message is received.

example

VoxeetSDK.command.on(
  "received",
  (participant: Participant, message: Object) => {}
)

Parameters:

NameType
participantParticipant
messageObject

Returns: void

Methods

send

send(message: string): Promise‹any›

Sends a message (basic string) to all other participants of a specific conference

Parameters:

NameTypeDescription
messagestringThe message to send

Returns: Promise‹any›