Class default

Hierarchy

BasePlugin<RecordPluginEvents, RecordPluginOptions>
- default

Constructors

constructor

new default(options): default
Create an instance of the Record plugin
Parameters
- options: RecordPluginOptions
Returns default
Overrides BasePlugin<RecordPluginEvents, RecordPluginOptions>.constructor
- Defined in plugins/record.ts:72

Properties

`Private` dataWindow

dataWindow: null | Float32Array = null

`Private` duration

duration: number = 0

`Private` isWaveformPaused

isWaveformPaused: boolean = false

`Private` lastDuration

lastDuration: number = 0

`Private` lastStartTime

lastStartTime: number = 0

`Private` mediaRecorder

mediaRecorder: null | MediaRecorder = null

`Protected` options

options: RecordPluginOptions

`Private` `Optional` originalOptions

originalOptions?: Partial<WaveSurferOptions>

`Private` stream

stream: null | MediaStream = null

`Protected` subscriptions

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

Type declaration

- (): void
- Returns void

`Private` timer

timer: Timer

`Protected` `Optional` wavesurfer

wavesurfer?: default

Methods

_init

_init(wavesurfer): void
Do not call directly, only called by WavesSurfer internally
Parameters
- wavesurfer: default
Returns void
Inherited from BasePlugin._init
- Defined in base-plugin.ts:28

`Private` applyOriginalOptionsIfNeeded

applyOriginalOptionsIfNeeded(): void
Returns void
- Defined in plugins/record.ts:352

destroy

destroy(): void
Destroy the plugin

Returns void
Overrides BasePlugin.destroy
- Defined in plugins/record.ts:345

`Protected` emit

emit<EventName>(eventName, ...args): void
Emit an event
Type Parameters
- EventName extends "destroy" | "record-start" | "record-pause" | "record-resume" | "record-end" | "record-progress" | "record-data-available"
Parameters
- eventName: EventName
- Rest ...args: RecordPluginEvents[EventName]
Returns void
Inherited from BasePlugin.emit
- Defined in event-emitter.ts:64

getDuration

getDuration(): number
Get the duration of the recording

Returns number
- Defined in plugins/record.ts:286

isActive

isActive(): boolean
Returns boolean
- Defined in plugins/record.ts:299

isPaused

isPaused(): boolean
Returns boolean
- Defined in plugins/record.ts:295

isRecording

isRecording(): boolean
Check if the audio is being recorded

Returns boolean
- Defined in plugins/record.ts:291

on

on<EventName>(event, listener, options?): (() => void)
Subscribe to an event. Returns an unsubscribe function.
Type Parameters
- EventName extends "destroy" | "record-start" | "record-pause" | "record-resume" | "record-end" | "record-progress" | "record-data-available"
Parameters
- event: EventName
- listener: EventListener<RecordPluginEvents, EventName>
- Optional options: {
  once?: boolean;
  }
  - Optional once?: boolean
Returns (() => void)
- - (): void
  - Subscribe to an event. Returns an unsubscribe function.
    
    Returns void
Inherited from BasePlugin.on
- Defined in event-emitter.ts:20

`Protected` onInit

onInit(): void
Called after this.wavesurfer is available

Returns void
Inherited from BasePlugin.onInit
- Defined in base-plugin.ts:23

once

once<EventName>(event, listener): (() => void)
Subscribe to an event only once
Type Parameters
- EventName extends "destroy" | "record-start" | "record-pause" | "record-resume" | "record-end" | "record-progress" | "record-data-available"
Parameters
- event: EventName
- listener: EventListener<RecordPluginEvents, EventName>
Returns (() => void)
- - (): void
  - Subscribe to an event only once
    
    Returns void
Inherited from BasePlugin.once
- Defined in event-emitter.ts:51

pauseRecording

pauseRecording(): void
Pause the recording

Returns void
- Defined in plugins/record.ts:312

renderMicStream

renderMicStream(stream): MicStream
Parameters
- stream: MediaStream
Returns MicStream
- Defined in plugins/record.ts:99

resumeRecording

resumeRecording(): void
Resume the recording

Returns void
- Defined in plugins/record.ts:323

startMic

startMic(options?): Promise<MediaStream>
Request access to the microphone and start monitoring incoming audio
Parameters
- Optional options: RecordPluginDeviceOptions
Returns Promise<MediaStream>
- Defined in plugins/record.ts:214

startRecording

startRecording(options?): Promise<void>
Start recording audio from the microphone
Parameters
- Optional options: RecordPluginDeviceOptions
Returns Promise<void>
- Defined in plugins/record.ts:241

stopMic

stopMic(): void
Stop monitoring incoming audio

Returns void
- Defined in plugins/record.ts:233

stopRecording

stopRecording(): void
Stop the recording

Returns void
- Defined in plugins/record.ts:304

un

un<EventName>(event, listener): void
Unsubscribe from an event
Type Parameters
- EventName extends "destroy" | "record-start" | "record-pause" | "record-resume" | "record-end" | "record-progress" | "record-data-available"
Parameters
- event: EventName
- listener: EventListener<RecordPluginEvents, EventName>
Returns void
Inherited from BasePlugin.un
- Defined in event-emitter.ts:43

unAll

unAll(): void
Clear all events

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

`Static` create

create(options?): default
Create an instance of the Record plugin
Parameters
- Optional options: RecordPluginOptions
Returns default
- Defined in plugins/record.ts:95

`Static` getAvailableAudioDevices

getAvailableAudioDevices(): Promise<MediaDeviceInfo[]>
Get a list of available audio devices You can use this to get the device ID of the microphone to use with the startMic and startRecording methods Will return an empty array if the browser doesn't support the MediaDevices API or if the user has not granted access to the microphone You can ask for permission to the microphone by calling startMic

Returns Promise<MediaDeviceInfo[]>
- Defined in plugins/record.ts:338

Generated using TypeDoc