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

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: VTParticipant, message: String)

Emitted when a participant receives a message.

Parameters:

NameTypeDescription
participantVTParticipantThe participant who sent the message.
messageStringThe received message.

Accessors

delegate

delegate: VTCommandDelegate

Delegate, a means of communication between objects in the command service.

Returns: VTCommandDelegate

Methods

send

send(message: String, completion: ((_ error: NSError?) -> Void)?)

Sends a message, in the form of a basic stream, to all conference participants.

Parameters:

NameTypeDefaultDescription
messageString-The message to send.
completion((_ error: NSError?) -> Void)?nilThe block to execute when the query completes.

Did this page help you?