Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Adapter
    • ProgressiveAdapter

Index

Constructors

constructor

  • new ProgressiveAdapter(master: HTMLMediaElement, eventCallback: <T>(event: T) => void, internalEventBus: EventMixin, settings?: PlayerSettings): ProgressiveAdapter
  • Parameters

    • master: HTMLMediaElement
    • eventCallback: <T>(event: T) => void
        • <T>(event: T): void
        • Type parameters

          • T: PlayerEvent

          Parameters

          • event: T

          Returns void

    • internalEventBus: EventMixin
    • Optional settings: PlayerSettings

    Returns ProgressiveAdapter

Properties

master

master: HTMLMediaElement

muted

muted: boolean

videoFiles

videoFiles: VideoFile[]

Accessors

currentTime

  • get currentTime(): number
  • Returns number

currentVideoFile

  • get currentVideoFile(): VideoFile
  • Gets the current videoFile based on the enabled property. Always defaults to the first if only one videoFile is defined.

    Returns VideoFile

duration

  • get duration(): number
  • Returns number

frameRate

  • get frameRate(): number
  • Returns number

loaded

  • get loaded(): boolean
  • set loaded(loaded: boolean): any
  • Indicates that the adapter is ready for continued playback. Triggers internal action PlayerActionType.UpdateLoaded when changed.

    Returns boolean

  • Indicates that the adapter is ready for continued playback. Triggers internal action PlayerActionType.UpdateLoaded when changed.

    Parameters

    • loaded: boolean

    Returns any

paused

  • get paused(): boolean
  • Returns boolean

playbackRate

  • get playbackRate(): number
  • Returns number

seeking

  • get seeking(): boolean
  • Returns boolean

Methods

assignFileToMaster

  • assignFileToMaster(file: VideoFile, playOnLoaded?: boolean, syncTime?: boolean, emitWhenLoaded?: boolean): void
  • Parameters

    • file: VideoFile
    • playOnLoaded: boolean = false
    • syncTime: boolean = false
    • emitWhenLoaded: boolean = true

    Returns void

destroy

  • destroy(): Promise<void>
  • Returns Promise<void>

getPlayerStatus

  • getPlayerStatus(): PlayerStatus
  • Returns the status of the Player. This status will have the same value as the callback returns in the registerStatusListener method.

    Returns PlayerStatus

    The status of the player including MediaStatus, audioTracks, subtitles and videoFiles.

getStatus

  • getStatus(): MediaStatus
  • Gets the status of the player.

    Returns MediaStatus

    The MediaStatus.

getVolume

  • getVolume(): number
  • Returns the volume.

    Returns number

isMuted

  • isMuted(): boolean
  • Returns boolean

isMutedMuxed

  • isMutedMuxed(): boolean
  • Returns boolean

loadVideoFile

  • loadVideoFile(file: VideoFile, playOnLoaded?: boolean, syncTime?: boolean): void
  • Parameters

    • file: VideoFile
    • playOnLoaded: boolean = false
    • syncTime: boolean = false

    Returns void

mute

  • mute(): void
  • Mute.

    Returns void

muteMuxed

  • muteMuxed(): void
  • Returns void

pause

  • pause(): void
  • Pause

    Returns void

play

  • play(): Promise<void>
  • Play

    Returns Promise<void>

setCurrentTime

  • setCurrentTime(time: number): void
  • Sets the currentTime.

    Parameters

    • time: number

      Time to set.

    Returns void

setDropFrame

  • setDropFrame(dropFrame: boolean): void
  • Set drop frame value for all loaded video files.

    Parameters

    • dropFrame: boolean

      Value to be set.

    Returns void

setFrameOffset

  • setFrameOffset(frameOffset: number): void
  • Set frame offset value for all loaded video files.

    Parameters

    • frameOffset: number

      Offset to be set.

    Returns void

setPlaybackRate

  • setPlaybackRate(rate: number): void
  • Sets the playback rate.

    Parameters

    • rate: number

      The new playback rate.

    Returns void

setVolume

  • setVolume(volume: number): void
  • Sets the audio volume.

    Parameters

    • volume: number

      The new volume value.

    Returns void

setVolumeController

  • setVolumeController(volumeController: VolumeController): void
  • Sets the default controller for the volume

    Parameters

    • volumeController: VolumeController

      the volume controller

    Returns void

toggleMute

  • toggleMute(): void
  • Toggle mute/unmute.

    Returns void

toggleMuteMuxed

  • toggleMuteMuxed(): void
  • Returns void

unmute

  • unmute(): void
  • Unmute.

    Returns void

unmuteMuxed

  • unmuteMuxed(): void
  • Returns void

updateVideoFile

  • updateVideoFile(update: VideoFile): void
  • Updates the given video file with new data

    Parameters

    • update: VideoFile

      the updated video file data

    Returns void