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

Constructors

constructor

Properties

_cacophony? _filters _position _stereoPan _threeDOptions _volume context globalGainNode panType playbacks primeWithMediaElement stopTracksOnStop stream

Accessors

cacophony filters isPlaying playbackRate position stereoPan threeDOptions volume

Methods

addFilter addFilters applyFilters cleanup createStreamSource fadeIn fadeOut fadeTo loop pause play preplay removeFilter removeFilters resume seek stop stopWithFade

Constructors

constructor

Properties

Private Optional _cacophony

_cacophony?: Cacophony

_filters

_filters: BiquadFilterNode[] = []

_position

_position: Position = ...

_stereoPan

_stereoPan: number = 0

_threeDOptions

_threeDOptions: ThreeDOptions = ...

Canonical 3D-audio configuration storage. Always holds a fully-populated HRTF variant (ThreeDOptions with panType: "HRTF") so callers reading via the getter never see undefined fields. Setting the stereo variant replaces this with the stereo shape (no stale HRTF fields).

_volume

_volume: number = 1

Private context

context: BaseContext

Private globalGainNode

globalGainNode: GainNode

Private panType

panType: PanType

playbacks

playbacks: MediaStreamPlayback[]

Private primeWithMediaElement

primeWithMediaElement: boolean

Private stopTracksOnStop

stopTracksOnStop: boolean

Private stream

stream: MediaStream

Accessors

cacophony

filters

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

playbackRate

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

  • 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

    Returns void

stereoPan

  • get stereoPan(): number

  • Returns number

  • set stereoPan(value): void

  • Parameters

    • value: number

    Returns void

threeDOptions

  • get threeDOptions(): ThreeDOptions

  • Returns a fresh copy of the canonical 3D-audio configuration. The clone prevents callers from mutating the container's internal state via the returned reference (previously the raw _threeDOptions object leaked).

    Returns ThreeDOptions

  • set threeDOptions(options): void

  • Accepts either a full canonical ThreeDOptions value, or a partial HRTF-options override (legacy ergonomics). When a partial is provided the existing variant is merged in place — and if the existing variant is stereo, the partial is interpreted as a switch back to HRTF defaults plus the override (no stale stereo fields). When a full variant is provided with a different panType, the storage is replaced wholesale so stale fields from the previous variant cannot be observed via the getter.

    Parameters

    Returns void

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

  • 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

    Returns void

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

    Returns void

addFilters

applyFilters

cleanup

  • cleanup(): void

  • Returns void

Private createStreamSource

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.

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.

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.

loop

pause

  • pause(): void

  • Pauses all current playbacks of the sound.

    Returns void

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[]

preplay

removeFilter

  • removeFilter(filter): void

  • Removes a BiquadFilterNode from the container's filter chain. Only affects future playbacks - existing playbacks retain their cloned filters.

    Parameters

    Returns void

    Throws

    If the filter was never added to this container.

removeFilters

  • removeFilters(filters): void

  • Parameters

    Returns void

resume

seek

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

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.

Settings

Member Visibility

Theme

On This Page

constructor_cacophony_filters_position_stereoPan_threeDOptions_volumecontextglobalGainNodepanTypeplaybacksprimeWithMediaElementstopTracksOnStopstreamcacophonyfiltersisPlayingplaybackRatepositionstereoPanthreeDOptionsvolumeaddFilteraddFiltersapplyFilterscleanupcreateStreamSourcefadeInfadeOutfadeTolooppauseplaypreplayremoveFilterremoveFiltersresumeseekstopstopWithFade