Smooth Time Update Plugin

This plugin is used to get more frequent time update events than the native video element can provide.

How to use

const player = new ProgressivePlayer(...);
const smoothTimeUpdatePlugin = new SmoothTimeUpdatePlugin(player);

// Add event listener to perform frequent updates.
smoothTimeUpdatePlugin.on(
SmoothTimeUpdateEventType.TimeUpdate,
(event: SmoothTimeUpdateEvent) => {
// Update some visual element using the current frame value
this.timeDisplay.setCurrentFrame(event.currentFrame);
}
);

Disclaimer: The SmoothTimeUpdateEventType.TimeUpdate event is fired for each frame, but it is not guaranteed to be emitted at the exact time of the frame. So calling player.api.getCurrentTime(TimeFormat.Frame) might report a different frame than event.currentFrame.

Hierarchy (view full)

Constructors

Properties

frameChangeObserver: FrameChangeObserver
name: string
Name: string = SMOOTH_TIME_UPDATE_PLUGIN_NAME

Accessors

  • get loaded(): boolean
  • Property that states whether this plugin considers itself ready for continued playback based on internal logic. Triggers internal event of type PlayerInternalEventType.LoadedChanged if property value was changed.

    Returns boolean

  • set loaded(loaded): void
  • Parameters

    • loaded: boolean

    Returns void

  • get muted(): boolean
  • Property that states whether this plugin considers itself muted based on internal logic. Triggers internal event of type PlayerInternalEventType.MutedChanged if property value was changed.

    Returns boolean

  • set muted(muted): void
  • Parameters

    • muted: boolean

    Returns void

  • get version(): string
  • Property describing the plugin name and version.

    Returns string

Methods

  • Adds an event listener for a specific event.

    Parameters

    • type: string

      Event type.

    • callback: Listener

      Listener callback function.

    Returns void

  • Unregisters itself with the player and removes all internal and external event listeners.

    Returns void

  • Plugin actions are optional and by default a plugin does not contain any actions.

    Returns PluginAction[]

  • Alias method for removeEventListener.

    Parameters

    • type: string

      Event type.

    • callback: Listener

      Listener callback function.

    Returns void

  • Alias method for addEventListener.

    Parameters

    • type: string

      Event type.

    • callback: Listener

      Listener callback function.

    Returns void

  • Removes an event listener for a specific event.

    Parameters

    • type: string

      Event type.

    • callback: Listener

      Listener callback function.

    Returns void