NEWDolby Interactivity APIs are now the Dolby.io Communications APIs Learn More >
X

CommandService

The CommandService allows the application to send text messages to all other participants of a specific conference and to redistribute these messages across the EventBus. It also emits the BroadcastEvent to inform that the message is broadcasted and the MessageReceived event to inform that the message is received at the specific conference.

Available in the package com.voxeet.sdk.services.CommandService.

Methods

send

send(@NonNull conferenceId: String, @NonNull message: String): Promise<Boolean>

Sends the message to the conference. The message must be in the form of a string or a representation of strings (json or base64).

Parameters

NameTypeDescription
conferenceIdStringnon null ID of the conference to which the message will be send
messageStringnon null content of the message (any possible string)

Returns: @NonNull Promise<Boolean> - the promise to resolve.

Events

ChatMessageEvent

Emitted when the application receives the chat message.

Available in the package com.voxeet.sdk.services.chat.ChatMessageEvent.

participant (Participant)

The instance of the participant who has sent the message.


message (ChatMessage)

The instance of the sent message.

BroadcastEvent

Emitted when the message is broadcasted.

Available in the package com.voxeet.sdk.json.BroadcastEvent.

This object can be accessed through the Websocket.

message (String)

The instance of the message.


participantId (String)

The ID of the participant who has sent the message.

MessageReceived

Emitted when the message from the specific participant is received at the specific conference.

Available in the package com.voxeet.sdk.events.sdk.MessageReceived.

participantId (String)

The ID of the sender.


conferenceId (String)

The conference ID.


message (String)

The corresponding message.


Did this page help you?