colibrio-reader-framework/com.colibrio.readingsystem.base/SyncMediaErrorEngineEventData

SyncMediaErrorEngineEventData

class SyncMediaErrorEngineEventData(val objectType: EngineEventDataObjectType = EngineEventDataObjectType.SYNC_MEDIA_ERROR_ENGINE_EVENT, val type: EngineEventDataType, val approximateElapsedTimeMs: Int, val syncMediaTimelinePosition: SyncMediaTimelinePositionData, val error: String, val errorMessage: String?, val errorType: SyncMediaPlayerErrorType, val paused: Boolean, val segmentIndex: Int) : SyncMediaEngineEventData

Event used when a SyncMediaPlayer encounters an error.

Constructors

SyncMediaErrorEngineEventData

constructor(objectType: EngineEventDataObjectType = EngineEventDataObjectType.SYNC_MEDIA_ERROR_ENGINE_EVENT, type: EngineEventDataType, approximateElapsedTimeMs: Int, syncMediaTimelinePosition: SyncMediaTimelinePositionData, error: String, errorMessage: String?, errorType: SyncMediaPlayerErrorType, paused: Boolean, segmentIndex: Int)

Types

object Companion

Properties

approximateElapsedTimeMs

val approximateElapsedTimeMs: Int

The approximate elapsed time from timeline start in milliseconds

val error: String

The error object serialized as a string.

val errorMessage: String?

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

val errorType: SyncMediaPlayerErrorType

The type of error that occurred.

val objectType: EngineEventDataObjectType

The type of engine event object this JSON structure represents.

val paused: Boolean

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

val segmentIndex: Int

The index of the segment related with the error.

syncMediaTimelinePosition

val syncMediaTimelinePosition: SyncMediaTimelinePositionData

The current player timeline position.

val type: EngineEventDataType

The type of event.

Functions

open override fun serialize(generator: JsonGenerator)