Class AbrService

Hierarchy

  • Service
    • AbrService

Constructors

constructor

Properties

playbackRates plugin

Accessors

ended isLooping isSeeking loaded master maximumPlaybackRate minimumPlaybackRate muted playbackRateIncrements shakaInstance

Methods

abrEnabled cancelLoop clearAllRequestFilters clearAllResponseFilters configureShaka decreasePlaybackRate destroy getActiveAudioId getActiveFile getActiveSubtitleId getActiveVideoRepresentationId getAudioTracks getCurrentTime getDuration getStatus getSubtitles getVideoRepresentations increasePlaybackRate listPlugins loadVideoFile loop mute muteMuxed onPlayerStatusChanged pause play registerRequestFilter registerResponseFilter seek setAudioTrack setFrameOffset setPlaybackRate setSubtitleTrack setVideoRepresentation setVolume setVolumeController toggleMute toggleMuteMuxed togglePlay unmute unmuteMuxed updateVideoFile useDropFrame

Constructors

constructor

  • Note Should only be used from within the player.

    Parameters

    • master: HTMLVideoElement

      The video element.

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

      Callback to control internal event handling.

        • <T>(event: T): void

        • Type Parameters

          • T extends PlayerEvent

          Parameters

          • event: T

          Returns void

    • internalEventBus: EventMixin

      Event bus for internal communication.

    • settings: AbrPlayerSettings

      Basic settings controlling the behavior.

    Returns AbrService

Properties

Readonly playbackRates

playbackRates: number[]

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

ended

  • get ended(): boolean

  • Returns boolean

isLooping

  • get isLooping(): boolean

  • Returns boolean

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

master

  • get master(): HTMLMediaElement

  • Returns HTMLMediaElement

maximumPlaybackRate

  • get maximumPlaybackRate(): number

  • The maximum acceptable value for playback rate.

    Returns

    The maximum value.

    Returns number

minimumPlaybackRate

  • get minimumPlaybackRate(): number

  • The minimum acceptable value for playback rate.

    Returns

    The minimum value.

    Returns number

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[]

shakaInstance

Methods

abrEnabled

  • Check if the abr-manager (automatic switch) is enabled.

    Returns

    True if enabled.

    Returns boolean

cancelLoop

  • Cancels loop playback.

    Returns void

clearAllRequestFilters

  • Reset all registered request interceptors.

    Returns void

clearAllResponseFilters

  • Reset all registered response interceptors.

    Returns void

configureShaka

decreasePlaybackRate

  • Decreases the current playback rate based on predefined steps.

    Returns void

destroy

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

    Returns Promise<void>

getActiveAudioId

  • Returns the current playing audios id. The id corresponds to the currently playing audio track

    Returns number

getActiveFile

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

    Returns VideoFile

getActiveSubtitleId

  • Returns number

getActiveVideoRepresentationId

  • Returns the id of the active video representation, or -1 if set to auto.

    Returns number

getAudioTracks

getCurrentTime

  • Returns the current time of the player in the requested format.

    Parameters

    • format: Frame

      The format to return the current time in.

    Returns number

  • Parameters

    • format: Milliseconds

    Returns number

  • Parameters

    • format: Percent

    Returns number

  • Parameters

    • format: Seconds

    Returns number

  • Parameters

    • format: Timecode

    Returns string

  • Parameters

    • format: Time

    Returns string

  • Parameters

    • format: TimeFormat

    Returns string | number

  • Returns number

getDuration

  • Returns the duration of the current media in the requested format.

    Parameters

    • format: Frame

      The format to return the duration in.

    Returns number

  • Parameters

    • format: Milliseconds

    Returns number

  • Parameters

    • format: Percent

    Returns number

  • Parameters

    • format: Seconds

    Returns number

  • Parameters

    • format: Time

    Returns string

  • Parameters

    • format: Timecode

    Returns string

  • Parameters

    • format: TimeFormat

    Returns string | number

  • Returns number

getStatus

  • Returns the current status of the active media.

    Returns PlayerStatus

getSubtitles

getVideoRepresentations

  • Returns all available video representations.

    Returns VideoRepresentation[]

increasePlaybackRate

  • 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.

    Throws

    Throws error originated from shaka-player if load fails.

    Parameters

    • videoFile: VideoFile

      The video file to load.

    Returns void

loop

  • Loop section of loaded Video.

    Parameters

    • inFrame: number

      inclusive

    • outFrame: number

      exclusive

    Returns void

mute

  • Mutes the player.

    Returns void

muteMuxed

  • Mutes the muxed audio

    Returns void

onPlayerStatusChanged

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

    Returns void

pause

  • 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

  • Starts playback. Queues requests if the player is seeking or loading to achieve autoplay behavior.

    Returns Promise<void>

registerRequestFilter

registerResponseFilter

seek

  • Seeks to a specific time in the current media.

    Parameters

    • event: SeekEvent

      Specifies where to seek to within the media.

    • Optional roundingMode: RoundingMode
    • Optional userSeek: boolean

    Returns Promise<void>

setAudioTrack

  • Set the audio track.

    Parameters

    • id: number

      of the audio track.

    Returns void

setFrameOffset

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

    Parameters

    • offset: number

      Frame offset to set.

    Returns void

setPlaybackRate

  • Sets the playback rate. Limited to predefined min- and max values.

    Parameters

    • rate: number

      The new playback rate

    Returns number

setSubtitleTrack

  • Sets a subtitle track.

    Parameters

    • id: number

      of the subtitle track.

    Returns void

setVideoRepresentation

  • Set the desired video representation using id. -1 will enable auto switch.

    Parameters

    • id: number

      The id of the desired representation.

    Returns void

setVolume

  • Set the volume of the player.

    Parameters

    • volume: number

      A number between 0 and 1.

    Returns void

setVolumeController

  • Sets the default controller for the volume

    Parameters

    • volumeController: VolumeController

      the volume controller

    Returns void

toggleMute

  • Toggles mute.

    Returns void

toggleMuteMuxed

  • Toggles mute on the muxed audio

    Returns void

togglePlay

  • Toggles playback.

    Returns Promise<void>

unmute

  • Unmutes the player.

    Returns void

unmuteMuxed

  • Unmutes the muxed audio

    Returns void

updateVideoFile

  • Parameters

    • videoFile: VideoFile

    Returns void

useDropFrame

  • 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

Settings

Member Visibility

Theme