Class AudioTimePointer

Class to create an audio time pointer.

Hierarchy

AudioTimePointer

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AudioTimePointer(audioElement: HTMLMediaElement, viewElement: HTMLElement, options?: IAudioTimePointerOptions): AudioTimePointer

Constructor

Parameters
- audioElement: HTMLMediaElement
  
  Input HTML element with source audio.
- viewElement: HTMLElement
  
  The parent container to append the time pointer.
- Optional options: IAudioTimePointerOptions
  
  Option params.
Returns AudioTimePointer

Properties

Protected audioElement

audioElement: HTMLMediaElement

Protected enableControl

enableControl: boolean

Protected isPointerInternal

isPointerInternal: boolean = false

Protected onPointerClick

onPointerClick: (ev: Event) => void

Type declaration

- (ev: Event): void
- Parameters
  - ev: Event
  Returns void

Protected onTimeUpdate

onTimeUpdate: (ev: Event) => void

Type declaration

- (ev: Event): void
- Parameters
  - ev: Event
  Returns void

Protected Optional options

options: IAudioTimePointerOptions

Protected pointerClass

pointerClass: string

Protected pointerElement

pointerElement: HTMLElement

Protected pointerMode

pointerMode: EnumAudioTimePointerMode

Protected pointerStyle

pointerStyle: any

Protected viewElement

viewElement: HTMLElement

Methods

Protected createPointer

createPointer(pointerElement?: HTMLElement): HTMLElement

Parameters
- Optional pointerElement: HTMLElement
Returns HTMLElement

destroy

destroy(): void

Removes all constructed elements and event listeners.

Returns void

Protected getPointerDefaultStyle

getPointerDefaultStyle(): any

Returns any

Protected init

init(options?: IAudioTimePointerOptions): void

Parameters
- Optional options: IAudioTimePointerOptions
Returns void

Protected movePointerToCurrentTime

movePointerToCurrentTime(): void

Returns void

Protected register

register(): void

Returns void

Protected removePointer

removePointer(): void

Returns void

resize

resize(): void

Updates the canvas size depended on the viewElement size.

Returns void

Protected setCurrentTimeByClick

setCurrentTimeByClick(event: MouseEvent): void

Parameters
- event: MouseEvent
Returns void

Protected setOptions

setOptions(options?: IAudioTimePointerOptions): void

Parameters
- Optional options: IAudioTimePointerOptions
Returns void

Protected unregister

unregister(): void

Returns void

Generated using TypeDoc