Class TimelinePlugin

Hierarchy

BasePlugin<TimelinePluginEvents, TimelinePluginOptions>
- TimelinePlugin

Index

Constructors

Properties

options subscriptions timelineWrapper wavesurfer?

Methods

defaultPrimaryLabelInterval defaultSecondaryLabelInterval defaultTimeInterval destroy emit formatTime init initTimeline initTimelineWrapper on onInit once un unAll create

Constructors

constructor

new TimelinePlugin(options?): TimelinePlugin
Parameters
- Optional options: TimelinePluginOptions
Returns TimelinePlugin
Overrides BasePlugin<TimelinePluginEvents, TimelinePluginOptions>.constructor
- Defined in plugins/timeline.ts:38

Properties

`Protected` options

options: TimelinePluginOptions & {
height: number;
}

Type declaration

height: number

`Protected` subscriptions

subscriptions: (() => void)[] = []

Type declaration

- (): void
- Returns void

`Private` timelineWrapper

timelineWrapper: HTMLElement

`Protected` `Optional` wavesurfer

wavesurfer?: WaveSurfer

Methods

`Private` defaultPrimaryLabelInterval

defaultPrimaryLabelInterval(pxPerSec): number
Parameters
- pxPerSec: number
Returns number
- Defined in plugins/timeline.ts:113

`Private` defaultSecondaryLabelInterval

defaultSecondaryLabelInterval(pxPerSec): number
Parameters
- pxPerSec: number
Returns number
- Defined in plugins/timeline.ts:125

`Private` defaultTimeInterval

defaultTimeInterval(pxPerSec): number
Parameters
- pxPerSec: number
Returns number
- Defined in plugins/timeline.ts:101

destroy

destroy(): void
Unmount

Returns void
Overrides BasePlugin.destroy
- Defined in plugins/timeline.ts:77

`Protected` emit

emit<EventName>(eventName, ...args): void
Emit an event
Type Parameters
- EventName extends "ready"
Parameters
- eventName: EventName
- Rest ...args: TimelinePluginEvents[EventName]
Returns void
Inherited from BasePlugin.emit
- Defined in event-emitter.ts:69

`Private` formatTime

formatTime(seconds): string
Parameters
- seconds: number
Returns string
- Defined in plugins/timeline.ts:88

init

init(wavesurfer): void
Parameters
- wavesurfer: WaveSurfer
Returns void
Inherited from BasePlugin.init
- Defined in base-plugin.ts:21

`Private` initTimeline

initTimeline(duration): void
Parameters
- duration: number
Returns void
- Defined in plugins/timeline.ts:136

`Private` initTimelineWrapper

initTimelineWrapper(): HTMLElement
Returns HTMLElement
- Defined in plugins/timeline.ts:82

on

on<EventName>(eventName, listener): (() => void)
Subscribe to an event. Returns an unsubscribe function.
Type Parameters
- EventName extends "ready"
Parameters
- eventName: EventName
- listener: EventListener<TimelinePluginEvents, EventName>
Returns (() => void)
- - (): void
  - Subscribe to an event. Returns an unsubscribe function.
    
    Returns void
Inherited from BasePlugin.on
- Defined in event-emitter.ts:20

onInit

onInit(): void
Called by wavesurfer, don't call manually

Returns void
Overrides BasePlugin.onInit
- Defined in plugins/timeline.ts:50

once

once<EventName>(eventName, listener): (() => void)
Subscribe to an event only once
Type Parameters
- EventName extends "ready"
Parameters
- eventName: EventName
- listener: EventListener<TimelinePluginEvents, EventName>
Returns (() => void)
- - (): void
  - Subscribe to an event only once
    
    Returns void
Inherited from BasePlugin.once
- Defined in event-emitter.ts:33

un

un<EventName>(eventName, listener): void
Unsubscribe from an event
Type Parameters
- EventName extends "ready"
Parameters
- eventName: EventName
- listener: EventListener<TimelinePluginEvents, EventName>
Returns void
Inherited from BasePlugin.un
- Defined in event-emitter.ts:50

unAll

unAll(): void
Clear all events

Returns void
Inherited from BasePlugin.unAll
- Defined in event-emitter.ts:64

`Static` create

create(options?): TimelinePlugin
Parameters
- Optional options: TimelinePluginOptions
Returns TimelinePlugin
- Defined in plugins/timeline.ts:45

Generated using TypeDoc