Options
All
  • Public
  • Public/Protected
  • All
Menu

Event used when a SyncMediaPlayer encounters an error.

Hierarchy

Index

Properties

approximateElapsedTimeMs: number

The approximate elapsed time from timeline start in milliseconds

cancelable: boolean

If this event's default action is cancelable. See respective engine event for its definition of default action.

defaultPrevented: boolean

If this event's default action has been canceled/prevented by a call to preventDefault()

error: unknown

The error that occurred. This should on most cases be an Error object or ColibrioError object but may be of another type.

errorMessage: string

If errorData was an instance of Error, it is set to errorData.message, otherwise it is set to null.

The type of error that occurred.

immediatePropagationStopped: boolean

True if stopImmediatePropagation() was called on this event.

isTrusted: boolean

If this event runs in a "trusted" context, i.e. the event callback is executed during a user-generated event such as "click" or "pointerdown".

paused: boolean

If the player has paused due to the error. If true, a "paused" event will also be fired right after this event was fired.

propagationStopped: boolean

True if stopPropagation() was called on this event.

readerView: IReaderView

The ReaderView instance this event is related to, if any.

segmentIndex: number

The index of the segment related with the error.

syncMediaPlayer: ISyncMediaPlayer

The media player related with this event.

timelinePosition: ISyncMediaTimelinePosition

The current player timeline position.

The type of event.

Methods

  • preventDefault(): void
  • stopImmediatePropagation(): void
  • stopPropagation(): void
  • Stops this event from propagating to listeners on the ReadingSystemEngine instance, if called from a listener added to a ReaderView instance. If the event has already propagated to the ReadingSystemEngine instance, calling this method has no effect.

    Returns void

Generated using TypeDoc