Class: CaptionReceivedEvent

Defines an event object for the captionReceived event dispatched by the Subscriber object. The Subscriber object dispatches a captionReceived event when the subscriber receives a caption from the transcription service.

Properties

Name Type Description
caption String The transcribed text.
streamId String The stream ID.
isFinal Boolean Whether a caption is finished being transcribed. This value is only relevant when using partial captions.
See:

Methods

Name Description
isDefaultPrevented() → {Boolean} Whether the default event behavior has been prevented via a call to preventDefault() (true) or not (false).
preventDefault() Prevents the default behavior associated with the event from taking place.

isDefaultPrevented() → {Boolean}

Whether the default event behavior has been prevented via a call to preventDefault() (true) or not (false). See preventDefault().
Returns:

preventDefault()

Prevents the default behavior associated with the event from taking place.

To see whether an event has a default behavior, check the cancelable property of the event object.

Call the preventDefault() method in the callback function for the event.

The following events have default behaviors: