Options
All
  • Public
  • Public/Protected
  • All
Menu

Event used when a SyncMediaPlayer encounters an error.

Hierarchy

Index

Properties

Readonly approximateElapsedTimeMs

approximateElapsedTimeMs: number

The approximate elapsed time from timeline start in milliseconds

Readonly cancelable

cancelable: boolean

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

Readonly defaultPrevented

defaultPrevented: boolean

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

Readonly error

error: unknown

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

Readonly errorMessage

errorMessage: string

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

Readonly errorType

The type of error that occurred.

Readonly immediatePropagationStopped

immediatePropagationStopped: boolean

True if stopImmediatePropagation() was called on this event.

Readonly isTrusted

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".

Readonly paused

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.

Readonly propagationStopped

propagationStopped: boolean

True if stopPropagation() was called on this event.

Readonly readerView

readerView: IReaderView

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

Readonly segmentIndex

segmentIndex: number

The index of the segment related with the error.

Readonly syncMediaPlayer

syncMediaPlayer: ISyncMediaPlayer

The media player related with this event.

Readonly timelinePosition

timelinePosition: ISyncMediaTimelinePosition

The current player timeline position.

Readonly type

The type of event.

Methods

preventDefault

  • preventDefault(): void

stopImmediatePropagation

  • stopImmediatePropagation(): void

stopPropagation

  • 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

toJSON

Generated using TypeDoc