Class RegionsPlugin

Hierarchy

BasePlugin<RegionsPluginEvents, RegionsPluginOptions>
- RegionsPlugin

Index

Constructors

Properties

options regions regionsContainer subscriptions wavesurfer?

Methods

addRegion avoidOverlapping clearRegions destroy emit enableDragSelection getRegions init initRegionsContainer on onInit once saveRegion un unAll create

Constructors

constructor

new RegionsPlugin(options?): RegionsPlugin
Create an instance of RegionsPlugin
Parameters
- Optional options: undefined
Returns RegionsPlugin
Overrides BasePlugin<RegionsPluginEvents, RegionsPluginOptions>.constructor
- Defined in plugins/regions.ts:296

Properties

`Protected` options

options: undefined

`Private` regions

regions: Region[] = []

`Private` regionsContainer

regionsContainer: HTMLElement

`Protected` subscriptions

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

Type declaration

- (): void
- Returns void

`Protected` `Optional` wavesurfer

wavesurfer?: WaveSurfer

Methods

addRegion

addRegion(options): Region
Create a region with given parameters
Parameters
- options: RegionParams
Returns Region
- Defined in plugins/regions.ts:394

`Private` avoidOverlapping

avoidOverlapping(region): void
Parameters
- region: Region
Returns void
- Defined in plugins/regions.ts:336

clearRegions

clearRegions(): void
Remove all regions

Returns void
- Defined in plugins/regions.ts:475

destroy

destroy(): void
Destroy the plugin and clean up

Returns void
Overrides BasePlugin.destroy
- Defined in plugins/regions.ts:480

`Protected` emit

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

enableDragSelection

enableDragSelection(options): (() => void)
Enable creation of regions by dragging on an empty space on the waveform. Returns a function to disable the drag selection.
Parameters
- options: Omit<RegionParams, "start" | "end">
Returns (() => void)
- - (): void
  - Enable creation of regions by dragging on an empty space on the waveform. Returns a function to disable the drag selection.
    
    Returns void
- Defined in plugins/regions.ts:420

getRegions

getRegions(): Region[]
Get all created regions

Returns Region[]
- Defined in plugins/regions.ts:332

init

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

`Private` initRegionsContainer

initRegionsContainer(): HTMLElement
Returns HTMLElement
- Defined in plugins/regions.ts:314

on

on<EventName>(eventName, listener): (() => void)
Subscribe to an event. Returns an unsubscribe function.
Type Parameters
- EventName extends keyof RegionsPluginEvents
Parameters
- eventName: EventName
- listener: EventListener<RegionsPluginEvents, 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/regions.ts:307

once

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

`Private` saveRegion

saveRegion(region): void
Parameters
- region: Region
Returns void
- Defined in plugins/regions.ts:358

un

un<EventName>(eventName, listener): void
Unsubscribe from an event
Type Parameters
- EventName extends keyof RegionsPluginEvents
Parameters
- eventName: EventName
- listener: EventListener<RegionsPluginEvents, 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?): RegionsPlugin
Create an instance of RegionsPlugin
Parameters
- Optional options: undefined
Returns RegionsPlugin
- Defined in plugins/regions.ts:302

Generated using TypeDoc