Class WaveShaper

export

Hierarchy

WaveShaper

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new WaveShaper(options?: ManagerInput): WaveShaper

- Defined in core/waveshaper.ts:105
throws

Throws an error if samplerate is null or NaN

Parameters
- Default value options: ManagerInput = defaultOptions
Returns WaveShaper

Accessors

activeWaveShapers

get activeWaveShapers(): string[]

- Defined in core/waveshaper.ts:80
description

Active id's, redraws when draw is called without argument

readonly

unused

memberof

WaveShaper

Returns string[]

duration

get duration(): number

- Defined in core/waveshaper.ts:102
description

Total duration of all tracks

readonly

memberof

WaveShaper

Returns number

lastProcessResult

get lastProcessResult(): ProcessResult | null

- Defined in core/waveshaper.ts:91
description

Last result of calling process, argument given to all callbacks

readonly

memberof

WaveShaper

Returns ProcessResult | null

options

get options(): ManagerOptions

- Defined in core/waveshaper.ts:68
description

Currect settings

readonly

memberof

WaveShaper

Returns ManagerOptions

Methods

clearTracks

clearTracks(...ids: string[]): WaveShaper

- Defined in core/waveshaper.ts:373
description

Removes the waves and all callbacks with given id from the manager

Parameters
- Rest ...ids: string[]
Returns WaveShaper

WaveShaper instance

emitSegment

emitSegment(old: AudioInterval | null, changed: AudioInterval | null): void

- Defined in core/waveshaper.ts:259
Emits a segment update

Parameters
- old: AudioInterval | null
  
  Old interval
- changed: AudioInterval | null
  
  Updated interval
Returns void

flatten

flatten(ids?: string[]): WaveShaper

- Defined in core/waveshaper.ts:141
description

Flattens the segments of the given waveshaper id

Parameters
- Default value ids: string[] = []
Returns WaveShaper

WaveShaper instance

getTrack

getTrack(id: string): Track | undefined

- Defined in core/waveshaper.ts:388
description

Gets Track with given id

Parameters
- id: string
Returns Track | undefined

Track with given ID

off

off(id: string, callBack: WaveShaperCallback): WaveShaper

- Defined in core/waveshaper.ts:220
Unregisters a callback from the given track, will no longer be called

Parameters
- id: string
  
  id of Track to unregister from
- callBack: WaveShaperCallback
  
  callback to remove
Returns WaveShaper

WaveShaper instance

offOptions

offOptions(cb: OptionsCallback): void

- Defined in core/waveshaper.ts:276
Removes a previously added callback

Parameters
- cb: OptionsCallback
  
  Callback function
Returns void

offSegment

offSegment(cb: SegmentCallback): void

- Defined in core/waveshaper.ts:246
Removes a previously added callback for the Interval update callback

Parameters
- cb: SegmentCallback
  
  Callback function
Returns void

on

on(id: string, callBack: WaveShaperCallback): WaveShaper

- Defined in core/waveshaper.ts:201
Registers a callback that fires when the track with given id is processed

Parameters
- id: string
  
  id of Track to register to
- callBack: WaveShaperCallback
  
  will be invoked when the given track is processed
Returns WaveShaper

WaveShaper instance

onOptions

onOptions(cb: OptionsCallback): void

- Defined in core/waveshaper.ts:268
Adds a callback that is fired when options are updated

Parameters
- cb: OptionsCallback
  
  Callback function
Returns void

onSegment

onSegment(cb: SegmentCallback): void

- Defined in core/waveshaper.ts:237
Adds a callback that is triggered when an Interval is updated

Parameters
- cb: SegmentCallback
  
  Callback function
Returns void

positionToTime

positionToTime(position: number): number

- Defined in core/waveshaper.ts:129
Gives the time corresponding to a given position

Parameters
- position: number
Returns number

process

process(ids?: string[], start?: number, width?: number, shift?: number): WaveShaper

- Defined in core/waveshaper.ts:160
Processes all relevant WaveShapers and invokes registered callbacks

Parameters
- Default value ids: string[] = []
  
  Options array of id's to draw
- Default value start: number = 0
  
  Start position
- Default value width: number = this.options.width
  
  Width to process
- Default value shift: number = 0
  
  Units to shift current data
Returns WaveShaper

WaveShaper instance

setActive

setActive(...ids: string[]): WaveShaper

- Defined in core/waveshaper.ts:360
description

The given id's are set as the active waveshapers, process only processes these when set, call with no values to allways process all values (default)

Parameters
- Rest ...ids: string[]
  
  Waveshaper id's to set as active
Returns WaveShaper

WaveShaper instance

setData

setData(...data: Data[]): this

- Defined in core/waveshaper.ts:344
description

Adds audio data to the waveshaper and redraws waveshapers using it

Parameters
- Rest ...data: Data[]
  
  AudioBuffer with audio data
Returns this

WaveShaper instance

setOptions

setOptions(options: ManagerInput): WaveShaper

- Defined in core/waveshaper.ts:299
description

Merges the given options into the current and returns updated options

Parameters
- options: ManagerInput
  
  A (partial) ManagerOptions object
Returns WaveShaper

WaveShaper instance

setTracks

setTracks(...tracks: TrackInput[]): WaveShaper

- Defined in core/waveshaper.ts:319
description

Adds a waveshaper to the manager

Parameters
- Rest ...tracks: TrackInput[]
Returns WaveShaper

WaveShaper instance

timeToPosition

timeToPosition(time: number): number

- Defined in core/waveshaper.ts:121
Gives the position corresponding to a given time

Parameters
- time: number
Returns number

Generated using TypeDoc