Class ProgressiveService

This service is a api layer that handles the communication with the video element regarding playback.

Note This service is created by the HlsPlayer on startup and should never be instantiated elsewhere.

Hierarchy

  • Service
    • ProgressiveService

Constructors

constructor

Properties

plugin

Accessors

ended isLooping isSeeking loaded master maximumPlaybackRate minimumPlaybackRate muted playbackRateIncrements

Methods

cancelLoop decreasePlaybackRate destroy getActiveFile getCurrentTime getDuration getStatus increasePlaybackRate listPlugins loadVideoFile loadVideoFiles loop mute muteMuxed onPlayerStatusChanged pause play seek setFrameOffset setPlaybackRate setVolume setVolumeController switchVideoFile toggleMute toggleMuteMuxed togglePlay unmute unmuteMuxed updateVideoFile useDropFrame

Constructors

constructor

  • new ProgressiveService(master, eventCallback, internalEventBus, settings?): ProgressiveService

  • Note Should only be used from within the player.

    Parameters

    • master: HTMLVideoElement

      The video element.

    • eventCallback: (<T>(event) => void)

      Callback to control internal event handling.

        • <T>(event): void

        • Type Parameters

          • T extends PlayerEvent

          Parameters

          • event: T

          Returns void

    • internalEventBus: EventMixin

      Event bus for internal communication.

    • Optional settings: PlayerSettings

      Basic settings controlling the behavior.

    Returns ProgressiveService

Properties

plugin

plugin: PluginApi

An object containing all currently registered plugins. Access a specific plugin using the Plugins static property Name.

Example

const hotkeyPlugin = player.api.plugin[HotkeyPlugin.Name];

Accessors

ended

  • get ended(): boolean

  • Returns true if the video playback has ended, false otherwise

    Returns boolean

    See

    PlayerEventType.Ended

isLooping

isSeeking

  • get isSeeking(): boolean

  • Returns true if a seek is in progress, false otherwise

    Returns boolean

loaded

master

  • get master(): HTMLMediaElement

  • The video element used for playback.

    Returns HTMLMediaElement

maximumPlaybackRate

minimumPlaybackRate

muted

playbackRateIncrements

Methods

cancelLoop

decreasePlaybackRate

destroy

  • destroy(): Promise<void>

  • Destroys the service, should only be called from within the player.

    Returns Promise<void>

getActiveFile

  • getActiveFile(): VideoFile

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

    Returns VideoFile

getCurrentTime

  • getCurrentTime(format): number

  • Parameters

    • format: Frame

    Returns number

  • getCurrentTime(format): number

  • Parameters

    • format: Milliseconds

    Returns number

  • getCurrentTime(format): number

  • Parameters

    • format: Percent

    Returns number

  • getCurrentTime(format): number

  • Parameters

    • format: Seconds

    Returns number

  • getCurrentTime(format): string

  • Parameters

    • format: Time

    Returns string

  • getCurrentTime(format): string

  • Parameters

    • format: Timecode

    Returns string

  • getCurrentTime(format): string | number

  • Parameters

    • format: TimeFormat

    Returns string | number

  • getCurrentTime(): number

  • Returns number

getDuration

  • getDuration(format): number

  • Parameters

    • format: Frame

    Returns number

  • getDuration(format): number

  • Parameters

    • format: Milliseconds

    Returns number

  • getDuration(format): number

  • Parameters

    • format: Percent

    Returns number

  • getDuration(format): number

  • Parameters

    • format: Seconds

    Returns number

  • getDuration(format): string

  • Parameters

    • format: Time

    Returns string

  • getDuration(format): string

  • Parameters

    • format: Timecode

    Returns string

  • getDuration(format): string | number

  • Parameters

    • format: TimeFormat

    Returns string | number

  • getDuration(): number

  • Returns number

getStatus

  • getStatus(): PlayerStatus

  • Returns PlayerStatus

increasePlaybackRate

listPlugins

loadVideoFile

  • loadVideoFile(videoFile): void

  • Parameters

    • videoFile: VideoFile

    Returns void

loadVideoFiles

  • loadVideoFiles(files): void

  • Load videoFiles i.e multiple representations of the same video.

    Parameters

    • files: VideoFile[]

      The files to be loaded.

    Returns void

loop

mute

muteMuxed

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(pauseOn?, userPause?): Promise<void>

  • Pauses playback and makes sure that the player is stopped at an exact frame.

    Parameters

    • Optional pauseOn: SeekEvent

      (Optional) Seek to specific time when pausing.

    • Optional userPause: boolean

    Returns Promise<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, roundingMode?): Promise<void>

  • Parameters

    • event: SeekEvent
    • Optional roundingMode: RoundingMode

    Returns Promise<void>

setFrameOffset

  • setFrameOffset(offset): void

  • Update frameOffset value for all loaded videoFiles. Equivalent to load videoFile with a specific frameOffset.

    Parameters

    • offset: number

      Frame offset to set.

    Returns void

    See

    PlayerEventType.FrameOffsetChanged

setPlaybackRate

setVolume

  • setVolume(volume): void

  • Set the volume of the player.

    Parameters

    • volume: number

      A number between 0 and 1.

    Returns void

    See

setVolumeController

  • setVolumeController(volumeController): void

  • Sets the default controller for the volume

    Parameters

    • volumeController: VolumeController

      the volume controller

    Returns void

switchVideoFile

  • switchVideoFile(file): void

  • Switch between already loaded video files i.e representations of the same video. The file must be with the 'loadVideoFiles' method.

    Parameters

    • file: VideoFile

      The desired representation.

    Returns void

toggleMute

toggleMuteMuxed

togglePlay

  • togglePlay(): Promise<void>

  • Toggles playback.

    Returns Promise<void>

unmute

unmuteMuxed

updateVideoFile

  • updateVideoFile(videoFile): void

  • Parameters

    • videoFile: VideoFile

    Returns void

useDropFrame

  • useDropFrame(dropFrame): void

  • Update the dropFrame value for all loaded videoFiles. Equivalent to load videoFile with dropFrame property set.

    Parameters

    • dropFrame: boolean

      Drop frame value to set.

    Returns void

    See

    PlayerEventType.DropFrameChanged

Settings

Member Visibility

Theme

On This Page

constructorpluginendedisLoopingisSeekingloadedmastermaximumPlaybackRateminimumPlaybackRatemutedplaybackRateIncrementscancelLoopdecreasePlaybackRatedestroygetActiveFilegetCurrentTimegetDurationgetStatusincreasePlaybackRatelistPluginsloadVideoFileloadVideoFilesloopmutemuteMuxedonPlayerStatusChangedpauseplayseeksetFrameOffsetsetPlaybackRatesetVolumesetVolumeControllerswitchVideoFiletoggleMutetoggleMuteMuxedtogglePlayunmuteunmuteMuxedupdateVideoFileuseDropFrame