Skip to content

Latest commit

 

History

History
203 lines (103 loc) · 5.33 KB

SoundStudioFactory.md

File metadata and controls

203 lines (103 loc) · 5.33 KB

@eliastik/simple-sound-studio-lib

@eliastik/simple-sound-studio-lib / SoundStudioFactory

Class: SoundStudioFactory

Defined in: utils/SoundStudioFactory.ts:19

Factory class to create instances of sound studio components.

This factory supports both singleton-based methods (deprecated) and a new instance-based creation model. The singleton methods will be removed in a future release.

Constructors

new SoundStudioFactory()

new SoundStudioFactory(): SoundStudioFactory

Returns

SoundStudioFactory

Methods

createAudioEditor()

static createAudioEditor(configService?, buffersToFetch?): AudioEditorInterface

Defined in: utils/SoundStudioFactory.ts:65

Create a singleton AudioEditor instance.

Parameters

configService?

ConfigService

Optional configuration service.

buffersToFetch?

string[]

Optional list of audio buffers to pre-fetch.

Returns

AudioEditorInterface

The singleton AudioEditor instance.

Deprecated

This method is deprecated. Use createNewInstance instead.

createNewInstance()

static createNewInstance(options?): SoundStudioFactoryInstance

Defined in: utils/SoundStudioFactory.ts:36

Create a new instance of sound studio components.

Parameters

options?

SoundStudioFactoryNewInstanceOptions

Optional configuration for the new instance. See SoundStudioFactoryNewInstanceOptions

Returns

SoundStudioFactoryInstance

A new instance of the sound studio components. See SoundStudioFactoryInstance

createVoiceRecorder()

static createVoiceRecorder(): VoiceRecorderInterface

Defined in: utils/SoundStudioFactory.ts:91

Create a singleton VoiceRecorder instance.

Returns

VoiceRecorderInterface

The singleton VoiceRecorder instance.

Deprecated

This method is deprecated. Use createNewInstance instead.

getAudioEditorInstance()

static getAudioEditorInstance(): null | AudioEditorInterface

Defined in: utils/SoundStudioFactory.ts:105

Get the singleton AudioEditor instance.

Returns

null | AudioEditorInterface

The singleton AudioEditor instance, or null if not initialized.

Deprecated

This method is deprecated. Use createNewInstance instead.

getAudioPlayerInstance()

static getAudioPlayerInstance(): null | BufferPlayerInterface

Defined in: utils/SoundStudioFactory.ts:119

Get the singleton BufferPlayer instance.

Returns

null | BufferPlayerInterface

The singleton BufferPlayer instance, or null if not initialized.

Deprecated

This method is deprecated. Use createNewInstance instead.

getAudioRecorderInstance()

static getAudioRecorderInstance(): null | VoiceRecorderInterface

Defined in: utils/SoundStudioFactory.ts:133

Get the singleton VoiceRecorder instance.

Returns

null | VoiceRecorderInterface

The singleton VoiceRecorder instance, or null if not initialized.

Deprecated

This method is deprecated. Use createNewInstance instead.

getConfigServiceInstance()

static getConfigServiceInstance(): undefined | ConfigService

Defined in: utils/SoundStudioFactory.ts:161

Get the singleton ConfigService instance.

Returns

undefined | ConfigService

The singleton ConfigService instance, or undefined if not initialized.

Deprecated

This method is deprecated. Use createNewInstance instead.

getEventEmitterInstance()

static getEventEmitterInstance(): null | EventEmitterInterface

Defined in: utils/SoundStudioFactory.ts:147

Get the singleton EventEmitter instance.

Returns

null | EventEmitterInterface

The singleton EventEmitter instance, or null if not initialized.

Deprecated

This method is deprecated. Use createNewInstance instead.