Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HlsMedia

HLS Media.

description

Class that handles M3U8 files using hls.js within the player

see

https://github.com/video-dev/hls.js/

class

HlsMedia

Hierarchy

Index

Constructors

constructor

  • new HlsMedia(element: HTMLMediaElement, mediaSource: Source, options: __type): HlsMedia

Properties

element

element: HTMLMediaElement

Native video/audio tag.

type

HTMLMediaElement

memberof

Native

Private events

events: EventsList

Hls events that will be triggered in Player.

see

https://github.com/video-dev/hls.js/blob/master/src/events.js

type

EventsList

memberof

HlsMedia

media

media: Source

The current media source element.

type

Source

memberof

Native

Private options

options: object

Hls options to be passed to the Hls instance.

see

https://github.com/video-dev/hls.js/blob/master/docs/API.md#fine-tuning

type

{object}

memberof

HlsMedia

Private player

player: any

Instance of hls.js player.

type

Hls

memberof

HlsMedia

promise

promise: Promise<any>

Promise to be resolved once media starts playing to avoid race issues.

type

Promise

memberof

Native

Private recoverDecodingErrorDate

recoverDecodingErrorDate: number

Time in milliseconds to attempt to recover media after an error.

type

number

memberof

HlsMedia

Private recoverSwapAudioCodecDate

recoverSwapAudioCodecDate: number

Time in milliseconds to attempt to swap audio codec after an error.

type

number

memberof

HlsMedia

Accessors

currentTime

  • get currentTime(): number
  • set currentTime(value: number): void

duration

  • get duration(): number

ended

  • get ended(): boolean

muted

  • get muted(): boolean
  • set muted(value: boolean): void

paused

  • get paused(): boolean

playbackRate

  • get playbackRate(): number
  • set playbackRate(value: number): void

src

  • set src(media: Source): void

volume

  • get volume(): number
  • set volume(value: number): void

Methods

Private _assign

  • _assign(event: string, data: any): void

Private _revoke

  • _revoke(): void
  • Remove all hls.js events and destroy hlsjs player instance.

    memberof

    HlsMedia

    Returns void

canPlayType

  • canPlayType(mimeType: string): boolean
  • Provide support via hls.js if browser does not have native support for HLS

    inheritdoc
    memberof

    HlsMedia

    Parameters

    • mimeType: string

    Returns boolean

destroy

  • destroy(): void

load

  • load(): void

pause

  • pause(): void

play

  • play(): void

Generated using TypeDoc