Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Service

Service layer serves as the api of a player. It should provide high level function and use the adapter to accomplish the tasks.

Hierarchy

  • Service

Index

Constructors

constructor

  • Parameters

    • master: HTMLVideoElement
    • eventCallback: function
        • <T>(event: T): void
        • Type parameters

          Parameters

          • event: T

          Returns void

    • _internalEventBus: EventMixin
    • settings: PlayerSettings

    Returns Service

Properties

playbackRates

playbackRates: number[] = [0.25, 0.5, 1, 2, 4, 8, 16]

plugin

plugin: PluginApi

An object containing all currently registered plugins. Access a specific plugin using the Plugins static property Name, i.e. plugin[Plugin.Name].

Accessors

isSeeking

  • get isSeeking(): boolean
  • Returns true if a seek is in progress, false otherwise

    Returns boolean

loaded

  • get loaded(): boolean
  • Player and plugins, if any, are ready for continued playback.

    Returns boolean

maximumPlaybackRate

  • get maximumPlaybackRate(): number
  • The maximum acceptable value for playback rate.

    Returns number

    The maximum value.

minimumPlaybackRate

  • get minimumPlaybackRate(): number
  • The minimum acceptable value for playback rate.

    Returns number

    The minimum value.

muted

  • get muted(): boolean
  • Player and plugins, if any, are all muted.

    Returns boolean

playbackRateIncrements

  • get playbackRateIncrements(): number[]
  • Returns a list of playback rates that are used when increasing or decreasing playback rate.

    Returns number[]

Methods

decreasePlaybackRate

  • decreasePlaybackRate(): void
  • Decreases the current playback rate based on predefined steps.

    Returns void

destroy

  • destroy(): void
  • Destroys the service, should only be called from within the player.

    Returns void

getActiveFile

  • Returns the active video file or undefined if no video file is loaded.

    Returns VideoFile | undefined

getCurrentTime

  • getCurrentTime(format?: TimeFormat): number | string
  • Returns the current time of the player in the requested format.

    Parameters

    • Default value format: TimeFormat = TimeFormat.Seconds

      The format to return the current time in.

    Returns number | string

getDuration

  • getDuration(format?: TimeFormat): number | string
  • Returns the duration of the current media in the requested format.

    Parameters

    • Default value format: TimeFormat = TimeFormat.Seconds

      The format to return the duration in.

    Returns number | string

getStatus

  • Returns the current status of the active media.

    Returns PlayerStatus

increasePlaybackRate

  • increasePlaybackRate(): void
  • Increases the current playback rate based on predefined steps.

    Returns void

listPlugins

  • Returns a list of all registered plugins.

    Returns Plugin[]

loadVideoFile

  • Load a specific video file.

    Parameters

    • videoFile: VideoFile

      The video file to load.

    Returns void

mute

  • mute(): void
  • Mutes the player.

    Returns void

onPlayerStatusChanged

  • onPlayerStatusChanged(): void
  • Helper method to make sure that playback is resumed correctly. Should only be used from within the player.

    Returns void

pause

  • pause(): void
  • Pauses playback and makes sure that the player is stopped at an exact frame.

    Returns void

play

  • play(): Promise<void>
  • Starts playback. Queues requests if the player is seeking or loading to achieve autoplay behavior.

    Returns Promise<void>

seek

  • seek(event: SeekEvent, roundingMode?: RoundingMode): Promise<void>
  • Seeks to a specific time in the current media.

    Parameters

    • event: SeekEvent

      Specifies where to seek to within the media.

    • Optional roundingMode: RoundingMode

    Returns Promise<void>

setPlaybackRate

  • setPlaybackRate(rate: number): number
  • Sets the playback rate. Limited to predefined min- and max values.

    Parameters

    • rate: number

      The new playback rate

    Returns number

setVolume

  • setVolume(volume: number): void
  • Set the volume of the player.

    Parameters

    • volume: number

      A number between 0 and 1.

    Returns void

toggleMute

  • toggleMute(): void
  • Toggles mute.

    Returns void

togglePlay

  • togglePlay(): void
  • Toggles playback.

    Returns void

unmute

  • unmute(): void
  • Unmutes the player.

    Returns void