Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AudioPlayer

Hierarchy

  • AudioPlayer

Index

Properties

Constructors

Methods

Accessors

Properties

Optional id

id?: string

Optional url

url?: string

errorInfo

errorInfo: { timeout?: number; lastPosition?: number; error: boolean }

Type declaration

  • Optional timeout?: number
  • Optional lastPosition?: number
  • error: boolean

Optional metaData

metaData?: EventMetaData

offset

offset: number = 0

playingStartTime

playingStartTime: number = 0

audio

audio: HTMLAudioElement

liveCatchupThreshold

liveCatchupThreshold: number = 5

Optional player

player?: playerType

Optional loadNewAsset

loadNewAsset?: boolean

Constructors

constructor

Methods

initShaka

  • initShaka(audioElem: HTMLAudioElement): void

adjustPlayback

  • adjustPlayback(): void

getMimeType

  • getMimeType(stream: string): "" | "application/dash+xml" | "application/vnd.apple.mpegurl"

getStreamExtension

  • getStreamExtension(stream: string): undefined | string

init

  • init(opts?: { id: string; url: string; offset: number; metaData?: EventMetaData }): Promise<void>

clear

  • clear(): void

triggerUpdate

  • triggerUpdate(): void

play

  • play(opts?: { id: string; url: string; offset: number; metaData?: EventMetaData }): Promise<void>

pause

  • pause(): void

displaySeek

  • displaySeek(position: number): void

seekToEnd

  • seekToEnd(): void

seekToStart

  • seekToStart(): void

rawSeek

  • rawSeek(position: number, useOffset?: boolean): void

ff

  • ff(distance: number): void

rewind

  • rewind(distance: number): void

setRate

  • setRate(rate: number): void

setVolume

  • setVolume(volume: number): void

setPlayingStartTime

  • setPlayingStartTime(time: number): void

togglePlaybackRate

  • togglePlaybackRate(): void

playing

  • playing(id: null | string): boolean

Accessors

rawDuration

  • get rawDuration(): number

rawCurrentTime

  • get rawCurrentTime(): number

playbackRate

  • get playbackRate(): number

volume

  • get volume(): number

eventMetaData

displayDuration

  • get displayDuration(): number

displayCurrentTime

  • get displayCurrentTime(): number

error

  • get error(): boolean

Generated using TypeDoc