Class HlsService

This service is a api layer that handles the communication with the video element regarding playback. It provides information about the currently loaded HLS file such as subtitles and audio tracks.

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

Hierarchy

Service
- HlsService

Constructors

constructor

new HlsService(master, eventCallback, internalEventBus, settings): HlsService
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.
- settings: HlsPlayerSettings
  Basic settings controlling the behavior.
Returns HlsService
Overrides Service.constructor

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

Inherited from Service.ended

hlsPlayer

get hlsPlayer(): Hls
Returns the current instance of the hls.js player. It's recommended to use this as little as possible to achieve a consistent behavior.

Returns Hls

isLooping

get isLooping(): boolean
Returns true if the player is currently playing in a loop.

Returns boolean
See
Inherited from Service.isLooping

isSeeking

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

Returns boolean
Inherited from Service.isSeeking

loaded

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

Returns boolean
See
- PlayerEventType.Loading
- PlayerEventType.Loaded
Inherited from Service.loaded

master

get master(): HTMLMediaElement
The video element used for playback.

Returns HTMLMediaElement
Inherited from Service.master

maximumPlaybackRate

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

Returns number
The maximum value.
See
Inherited from Service.maximumPlaybackRate

minimumPlaybackRate

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

Returns number
The minimum value.
See
Inherited from Service.minimumPlaybackRate

muted

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

Returns boolean
See
- PlayerEventType.Muted
- PlayerEventType.Unmuted
Inherited from Service.muted

playbackRateIncrements

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

Returns number[]
See
Inherited from Service.playbackRateIncrements

Methods

abrEnabled

abrEnabled(): boolean
Returns boolean

cancelLoop

cancelLoop(): void
Cancels loop playback.

Returns void
See
Inherited from Service.cancelLoop

decreasePlaybackRate

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

Returns void
See
Inherited from Service.decreasePlaybackRate

destroy

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

Returns Promise<void>
Inherited from Service.destroy

getActiveAudioIndex

getActiveAudioIndex(): number
Returns the id of the active audio track.

Returns number

getActiveFile

getActiveFile(): VideoFile
Returns the active video file or undefined if no video file is loaded.

Returns VideoFile
Inherited from Service.getActiveFile

getActiveSubtitleIndex

getActiveSubtitleIndex(): number
Returns the id of the active subtitle track.

Returns number

getActiveVideoRepresentationIndex

getActiveVideoRepresentationIndex(): number
Returns the index of the active video representation, or -1 if set to auto.

Returns number

getAudioTracks

getAudioTracks(): HlsAudioTrack[]
Returns the audio tracks of the current HLS file.

Returns HlsAudioTrack[]

getCurrentTime

getCurrentTime(format): number
Returns the current time of the player in the requested format.
Parameters
- format: Frame
  The format to return the current time in.
Returns number
See
- TimeFormat
- getDuration
Inherited from Service.getCurrentTime
getCurrentTime(format): number
Parameters
- format: Milliseconds
Returns number
Inherited from Service.getCurrentTime
getCurrentTime(format): number
Parameters
- format: Percent
Returns number
Inherited from Service.getCurrentTime
getCurrentTime(format): number
Parameters
- format: Seconds
Returns number
Inherited from Service.getCurrentTime
getCurrentTime(format): string
Parameters
- format: Timecode
Returns string
Inherited from Service.getCurrentTime
getCurrentTime(format): string
Parameters
- format: Time
Returns string
Inherited from Service.getCurrentTime
getCurrentTime(format): string | number
Parameters
- format: TimeFormat
Returns string | number
Inherited from Service.getCurrentTime
getCurrentTime(): number
Returns number
Inherited from Service.getCurrentTime

getDuration

getDuration(format): number
Returns the duration of the current media in the requested format.
Parameters
- format: Frame
  The format to return the duration in.
Returns number
See
- TimeFormat
- getCurrentTime
Inherited from Service.getDuration
getDuration(format): number
Parameters
- format: Milliseconds
Returns number
Inherited from Service.getDuration
getDuration(format): number
Parameters
- format: Percent
Returns number
Inherited from Service.getDuration
getDuration(format): number
Parameters
- format: Seconds
Returns number
Inherited from Service.getDuration
getDuration(format): string
Parameters
- format: Time
Returns string
Inherited from Service.getDuration
getDuration(format): string
Parameters
- format: Timecode
Returns string
Inherited from Service.getDuration
getDuration(format): string | number
Parameters
- format: TimeFormat
Returns string | number
Inherited from Service.getDuration
getDuration(): number
Returns number
Inherited from Service.getDuration

getStatus

getStatus(): PlayerStatus
Returns the current status of the active media.

Returns PlayerStatus
See
PlayerEventType.StatusChanged

Inherited from Service.getStatus

getSubtitles

getSubtitles(): HlsSubtitleTrack[]
Returns the subtitle tracks of the current HLS file.

Returns HlsSubtitleTrack[]

getVideoRepresentations

getVideoRepresentations(): VideoRepresentation[]
Returns all available video representations for the stream sorted by bandwidth (lowest bandwidth at index 0).

Returns VideoRepresentation[]

increasePlaybackRate

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

Returns void
See
Inherited from Service.increasePlaybackRate

listPlugins

listPlugins(): Plugin[]
Returns a list of all registered plugins.

Returns Plugin[]
See
- PlayerEventType.PluginAdded
- PlayerEventType.PluginRemoved
Inherited from Service.listPlugins

loadVideoFile

loadVideoFile(videoFile): void
Load a specific video file.
Parameters
- videoFile: VideoFile
  The video file to load.
Returns void
See
- PlayerEventType.Loading
- PlayerEventType.Loaded
Inherited from Service.loadVideoFile

loop

loop(inFrame, outFrame): void
Loop section of loaded Video.
Parameters
- inFrame: number
  inclusive
- outFrame: number
  exclusive
Returns void
See
Inherited from Service.loop

mute

mute(): void
Mutes the player.

Returns void
See
Inherited from Service.mute

muteMuxed

muteMuxed(): void
Mutes the muxed audio

Returns void
See
Inherited from Service.muteMuxed

onPlayerStatusChanged

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

Returns void
Inherited from Service.onPlayerStatusChanged

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>
Inherited from Service.pause

play

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

Returns Promise<void>
Inherited from Service.play

seek

seek(event, roundingMode?, userSeek?): 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
- Optional userSeek: boolean
Returns Promise<void>
See
Inherited from Service.seek

setAudioTrack

setAudioTrack(index): void
Activate a audio track.
Parameters
- index: number
  The id of the audio track to activate.
Returns 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

Inherited from Service.setFrameOffset

setPlaybackRate

setPlaybackRate(rate): number
Sets the playback rate. Limited to predefined min- and max values.
Parameters
- rate: number
  The new playback rate
Returns number
See
Inherited from Service.setPlaybackRate

setSubtitleTrack

setSubtitleTrack(index): void
Activate a subtitle track.
Parameters
- index: number
  The id of the subtitle track to activate, or -1 if all subtitles should be deactivated.
Returns void

setVideoRepresentation

setVideoRepresentation(index): void
Set the desired video representation using id. -1 will enable auto switch.
Parameters
- index: number
  The index of the desired representation.
Returns void

setVolume

setVolume(volume): void
Set the volume of the player.
Parameters
- volume: number
  A number between 0 and 1.
Returns void
See
- getStatus
- PlayerEventType.StatusChanged
Inherited from Service.setVolume

setVolumeController

setVolumeController(volumeController): void
Sets the default controller for the volume
Parameters
- volumeController: VolumeController
  the volume controller
Returns void
Inherited from Service.setVolumeController

toggleMute

toggleMute(): void
Toggles mute.

Returns void
See
Inherited from Service.toggleMute

toggleMuteMuxed

toggleMuteMuxed(): void
Toggles mute on the muxed audio

Returns void
See
Inherited from Service.toggleMuteMuxed

togglePlay

togglePlay(): Promise<void>
Toggles playback.

Returns Promise<void>
Inherited from Service.togglePlay

unmute

unmute(): void
Unmutes the player.

Returns void
See
Inherited from Service.unmute

unmuteMuxed

unmuteMuxed(): void
Unmutes the muxed audio

Returns void
See
Inherited from Service.unmuteMuxed

updateVideoFile

updateVideoFile(videoFile): void
Parameters
- videoFile: VideoFile
Returns void
Inherited from Service.updateVideoFile

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

Inherited from Service.useDropFrame

Class HlsService

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Type Parameters

Parameters

Returns void

Returns HlsService

Properties

plugin

Example

Accessors

ended

Returns boolean

See

hlsPlayer

Returns Hls

isLooping

Returns boolean

See

isSeeking

Returns boolean

loaded

Returns boolean

See

master

Returns HTMLMediaElement

maximumPlaybackRate

Returns number

See

minimumPlaybackRate

Returns number

See

muted

Returns boolean

See

playbackRateIncrements

Returns number[]

See

Methods

abrEnabled

Returns boolean

cancelLoop

Returns void

See

decreasePlaybackRate

Returns void

See

destroy

Returns Promise<void>

getActiveAudioIndex

Returns number

getActiveFile

Returns VideoFile

getActiveSubtitleIndex

Returns number

getActiveVideoRepresentationIndex

Returns number

getAudioTracks

Returns HlsAudioTrack[]

getCurrentTime

Parameters

Returns number

See

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns string

Parameters

Returns string