Class RecordPlugin

Hierarchy

BasePlugin<RecordPluginEvents, RecordPluginOptions>
- RecordPlugin

Index

Constructors

Properties

mediaRecorder options recordedUrl subscriptions wavesurfer?

Methods

cleanUp destroy emit getRecordedUrl init isRecording loadBlob on onInit once render startRecording stopRecording un unAll create

Constructors

constructor

new RecordPlugin(options): RecordPlugin
Parameters
- options: RecordPluginOptions
Returns RecordPlugin
Inherited from BasePlugin<RecordPluginEvents, RecordPluginOptions>.constructor
- Defined in base-plugin.ts:11

Properties

`Private` mediaRecorder

mediaRecorder: null | MediaRecorder = null

`Protected` options

options: RecordPluginOptions

`Private` recordedUrl

recordedUrl: string = ''

`Protected` subscriptions

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

Type declaration

- (): void
- Returns void

`Protected` `Optional` wavesurfer

wavesurfer?: WaveSurfer

Methods

`Private` cleanUp

cleanUp(): void
Returns void
- Defined in plugins/record.ts:107

destroy

destroy(): void
Returns void
Overrides BasePlugin.destroy
- Defined in plugins/record.ts:166

`Protected` emit

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

getRecordedUrl

getRecordedUrl(): string
Returns string
- Defined in plugins/record.ts:162

init

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

isRecording

isRecording(): boolean
Returns boolean
- Defined in plugins/record.ts:152

`Private` loadBlob

loadBlob(data, type): void
Parameters
- data: Blob[]
- type: string
Returns void
- Defined in plugins/record.ts:30

on

on<EventName>(eventName, listener): (() => void)
Subscribe to an event. Returns an unsubscribe function.
Type Parameters
- EventName extends keyof RecordPluginEvents
Parameters
- eventName: EventName
- listener: EventListener<RecordPluginEvents, 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
Returns void
Inherited from BasePlugin.onInit
- Defined in base-plugin.ts:16

once

once<EventName>(eventName, listener): (() => void)
Subscribe to an event only once
Type Parameters
- EventName extends keyof RecordPluginEvents
Parameters
- eventName: 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:33

render

render(stream): (() => void)
Parameters
- stream: MediaStream
Returns (() => void)
- - (): void
  - Returns void
- Defined in plugins/record.ts:36

startRecording

startRecording(): Promise<void>
Returns Promise<void>
- Defined in plugins/record.ts:116

stopRecording

stopRecording(): void
Returns void
- Defined in plugins/record.ts:156

un

un<EventName>(eventName, listener): void
Unsubscribe from an event
Type Parameters
- EventName extends keyof RecordPluginEvents
Parameters
- eventName: EventName
- listener: EventListener<RecordPluginEvents, 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?): RecordPlugin
Parameters
- Optional options: RecordPluginOptions
Returns RecordPlugin
- Defined in plugins/record.ts:26

Generated using TypeDoc