Interface EventSource

Source object representation the way it appears on event's payloads such as SeekEvent, for example.

This interface only type hints what should be the shape of a Source object inside an event's payload during runtime so it has no direct relation with the Source class present in src/source.ts.

Do not mistake it for a NativeInstance type.

interface EventSource {
    duration: number;
    isActive: boolean;
    isAttachedToPlayer: boolean;
    loadingState: LoadingState;
    metadata?: Record<string, any>;
}

Properties

duration isActive isAttachedToPlayer loadingState metadata?

Properties

duration

duration: number

Event's source duration in seconds.

isActive

isActive: boolean

Whether this event's source is currently active in a player.

isAttachedToPlayer

isAttachedToPlayer: boolean

Whether this event's source is currently attached to a player instance.

loadingState

loadingState: LoadingState

The current LoadingState of the source.

Optional metadata

metadata?: Record<string, any>

Metadata for this event's source.

Settings

Member Visibility

Theme

On This Page

durationisActiveisAttachedToPlayerloadingStatemetadata