Class MediaStreamSound

The base interface for any sound-producing entity, including individual sounds, groups, and playbacks. BaseSound

Hierarchy

PlaybackContainer<typeof FilterManager, this> & FilterManager<this>
- MediaStreamSound

Implements

BaseSound

Constructors

constructor

new MediaStreamSound(stream, context, globalGainNode, options?, _cacophony?): MediaStreamSound
Parameters
- stream: MediaStream
- context: BaseContext
- globalGainNode: GainNode
- options: MediaStreamSoundOptions = {}
- Optional _cacophony: Cacophony
Returns MediaStreamSound
Overrides PlaybackContainer(FilterManager).constructor
- Defined in src/mediaStream.ts:174

Properties

`Private` `Optional` _cacophony

_cacophony?: Cacophony

_filters

_filters: BiquadFilterNode[] = []

_position

_position: Position = ...

_stereoPan

_stereoPan: number = 0

_threeDOptions

_threeDOptions: PannerOptions = ...

_volume

_volume: number = 1

`Private` context

context: BaseContext

`Private` globalGainNode

globalGainNode: GainNode

`Private` panType

panType: PanType

playbacks

playbacks: MediaStreamPlayback[]

`Private` stopTracksOnStop

stopTracksOnStop: boolean

`Private` stream

stream: MediaStream

Accessors

cacophony

get cacophony(): undefined | Cacophony
Returns undefined | Cacophony
- Defined in src/mediaStream.ts:189

filters

get filters(): BiquadFilterNode[]
Returns BiquadFilterNode[]
Inherited from PlaybackContainer(FilterManager).filters
- Defined in src/filters.ts:48

isPlaying

get isPlaying(): boolean
Returns a boolean indicating whether the object is currently playing. an object is playing if any of its playbacks are currently playing.

Returns boolean
True if the object is playing, false otherwise.
Implementation of BaseSound.isPlaying
Inherited from PlaybackContainer(FilterManager).isPlaying
- Defined in src/container.ts:112

playbackRate

get playbackRate(): number
Returns number
- Defined in src/mediaStream.ts:238
set playbackRate(_rate): void
Parameters
- _rate: number
Returns void
- Defined in src/mediaStream.ts:242

position

get position(): Position
Retrieves the current 3D spatial position of the sound in the audio context. The position is returned as an array of three values[x, y, z].

Returns Position
The current position of the sound.
Implementation of BaseSound.position
Inherited from PlaybackContainer(FilterManager).position
- Defined in src/container.ts:122
set position(position): void
Sets the 3D spatial position of the sound in the audio context. The position is an array of three values[x, y, z]. This method updates the position of all active playbacks of the sound.
Parameters
- position: Position
  The new position of the sound.
Returns void
Implementation of BaseSound.position
Inherited from PlaybackContainer(FilterManager).position
- Defined in src/container.ts:137

stereoPan

get stereoPan(): null | number
Returns null | number
Inherited from PlaybackContainer(FilterManager).stereoPan
- Defined in src/container.ts:153
set stereoPan(value): void
Parameters
- value: number
Returns void
Inherited from PlaybackContainer(FilterManager).stereoPan
- Defined in src/container.ts:157

threeDOptions

get threeDOptions(): PannerOptions
Returns PannerOptions
Implementation of BaseSound.threeDOptions
Inherited from PlaybackContainer(FilterManager).threeDOptions
- Defined in src/container.ts:144
set threeDOptions(options): void
Parameters
- options: Partial<PannerOptions>
Returns void
Implementation of BaseSound.threeDOptions
Inherited from PlaybackContainer(FilterManager).threeDOptions
- Defined in src/container.ts:148

volume

get volume(): number
Gets the volume of the sound. This volume level affects all current and future playbacks of this sound instance. The volume is specified as a linear value between 0 (silent) and 1 (full volume).

Returns number
The current volume of the sound.
Implementation of BaseSound.volume
Inherited from PlaybackContainer(FilterManager).volume
- Defined in src/container.ts:169
set volume(volume): void
Sets the volume of the sound. This volume level affects all current and future playbacks of this sound instance. The volume is specified as a linear value between 0 (silent) and 1 (full volume).
Parameters
- volume: number
  The new volume level for the sound.
Returns void
Implementation of BaseSound.volume
Inherited from PlaybackContainer(FilterManager).volume
- Defined in src/container.ts:180

Methods

addFilter

addFilter(filter): void
Adds a BiquadFilterNode to the container's filter chain. Filters are cloned when creating new playbacks - existing playbacks are not affected. Each playback gets independent filter instances for isolated processing.
Parameters
- filter: BiquadFilterNode
  The filter to add to the chain.
Returns void
Implementation of BaseSound.addFilter
Inherited from PlaybackContainer(FilterManager).addFilter
- Defined in src/container.ts:88

addFilters

addFilters(filters): void
Parameters
- filters: BiquadFilterNode[]
Returns void
Inherited from PlaybackContainer(FilterManager).addFilters
- Defined in src/filters.ts:52

applyFilters

applyFilters(connection): any
Parameters
- connection: any
Returns any
Inherited from PlaybackContainer(FilterManager).applyFilters
- Defined in src/filters.ts:40

cleanup

cleanup(): void
Returns void
Overrides PlaybackContainer(FilterManager).cleanup
- Defined in src/mediaStream.ts:244

`Private` createStreamSource

createStreamSource(stream): MediaStreamAudioSourceNode
Parameters
- stream: MediaStream
Returns MediaStreamAudioSourceNode
- Defined in src/mediaStream.ts:193

fadeIn

fadeIn(duration, type?): Promise<void>
Fades in all playbacks from silence to their current volume.
Parameters
- duration: number
  The fade duration in milliseconds.
- Optional type: FadeType
  The fade curve type. Defaults to "linear".
Returns Promise<void>
Resolves when all fades complete.
Implementation of BaseSound.fadeIn
Inherited from PlaybackContainer(FilterManager).fadeIn
- Defined in src/container.ts:203

fadeOut

fadeOut(duration, type?): Promise<void>
Fades out all playbacks from their current volume to silence.
Parameters
- duration: number
  The fade duration in milliseconds.
- Optional type: FadeType
  The fade curve type. Defaults to "linear".
Returns Promise<void>
Resolves when all fades complete.
Implementation of BaseSound.fadeOut
Inherited from PlaybackContainer(FilterManager).fadeOut
- Defined in src/container.ts:213

fadeTo

fadeTo(value, duration, type?): Promise<void>
Fades the volume of all playbacks to a target value over a duration.
Parameters
- value: number
  The target volume (0 to 1).
- duration: number
  The fade duration in milliseconds.
- Optional type: FadeType
  The fade curve type. Defaults to "linear".
Returns Promise<void>
Resolves when all fades complete.
Implementation of BaseSound.fadeTo
Inherited from PlaybackContainer(FilterManager).fadeTo
- Defined in src/container.ts:192

loop

loop(_loopCount?): LoopCount
Parameters
- Optional _loopCount: LoopCount
Returns LoopCount
- Defined in src/mediaStream.ts:234

pause

pause(): void
Pauses all current playbacks of the sound.

Returns void
Implementation of BaseSound.pause
Inherited from PlaybackContainer(FilterManager).pause
- Defined in src/container.ts:77

play

play(): BasePlayback[]
Starts playback of the sound and returns a Playback instance representing this particular playback. Multiple Playback instances can be created by calling this method multiple times, allowing for the same sound to be played concurrently with different settings.

Returns BasePlayback[]
An array containing the Playback instances that have been started.
Implementation of BaseSound.play
Inherited from PlaybackContainer(FilterManager).play
- Defined in src/container.ts:55

preplay

preplay(): MediaStreamPlayback[]
Returns MediaStreamPlayback[]
Overrides PlaybackContainer(FilterManager).preplay
- Defined in src/mediaStream.ts:200

removeFilter

removeFilter(filter): void
Removes a BiquadFilterNode from the container's filter chain. Only affects future playbacks - existing playbacks retain their cloned filters.
Parameters
- filter: BiquadFilterNode
  The filter to remove from the chain.
Returns void
Throws
If the filter was never added to this container.
Implementation of BaseSound.removeFilter
Inherited from PlaybackContainer(FilterManager).removeFilter
- Defined in src/container.ts:101

removeFilters

removeFilters(filters): void
Parameters
- filters: BiquadFilterNode[]
Returns void
Inherited from PlaybackContainer(FilterManager).removeFilters
- Defined in src/filters.ts:57

resume

resume(): void
Returns void
- Defined in src/mediaStream.ts:230

seek

seek(_time): void
Parameters
- _time: number
Returns void
Implementation of BaseSound.seek
- Defined in src/mediaStream.ts:228

stop

stop(): void
Stops all current playbacks of the sound immediately. This will halt the sound regardless of how many times it has been played.

Returns void
Implementation of BaseSound.stop
Inherited from PlaybackContainer(FilterManager).stop
- Defined in src/container.ts:65

stopWithFade

stopWithFade(duration, type?): Promise<void>
Fades out all playbacks then stops them.
Parameters
- duration: number
  The fade-out duration in milliseconds.
- Optional type: FadeType
  The fade curve type. Defaults to "linear".
Returns Promise<void>
Resolves when the fade completes and all playbacks are stopped.
Implementation of BaseSound.stopWithFade
Inherited from PlaybackContainer(FilterManager).stopWithFade
- Defined in src/container.ts:223

Class MediaStreamSound

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MediaStreamSound

Properties

Private Optional _cacophony

_filters

_position

_stereoPan

_threeDOptions

_volume

Private context

Private globalGainNode

Private panType

playbacks

Private stopTracksOnStop

Private stream

Accessors

cacophony

Returns undefined | Cacophony

filters

Returns BiquadFilterNode[]

isPlaying

Returns boolean

playbackRate

Returns number

Parameters

Returns void

position

Returns Position

Parameters

Returns void

stereoPan

Returns null | number

Parameters

Returns void

threeDOptions

Returns PannerOptions

Parameters

Returns void

volume

Returns number

Parameters

Returns void

Methods

addFilter

Parameters

Returns void

addFilters

Parameters

Returns void

applyFilters

Parameters

Returns any

cleanup

Returns void

Private createStreamSource

Parameters

Returns MediaStreamAudioSourceNode

fadeIn

Parameters

Returns Promise<void>

fadeOut

Parameters

Returns Promise<void>

fadeTo

Parameters

Returns Promise<void>

loop

Parameters

Returns LoopCount

pause

`Private` `Optional` _cacophony

`Private` context

`Private` globalGainNode

`Private` panType

`Private` stopTracksOnStop

`Private` stream

`Private` createStreamSource