Class MediaStreamPlayback

Hierarchy

  • BasePlayback
    • MediaStreamPlayback

Constructors

constructor

Properties

_fadeTimeout? _filters _isFading _panType _playing eventEmitter gainNode? hasStarted origin panner? source? stopTracksOnStop

Accessors

duration filters isFading isPlaying outputNode panType playbackRate position stereoPan threeDOptions volume

Methods

addFilter addFilters applyFilters cancelFade cleanup connect disconnect emit emitAsync fadeIn fadeOut fadeTo off on pause play refreshFilters removeFilter removeFilters resume setGainNode setPanType setPannerNode stop

Constructors

constructor

Properties

Optional _fadeTimeout

_fadeTimeout?: Timeout

_filters

_filters: BiquadFilterNode[] = []

_isFading

_isFading: boolean = false

_panType

_panType: PanType = "stereo"

_playing

_playing: boolean = false

eventEmitter

eventEmitter: TypedEventEmitter<PlaybackEvents> = ...

Optional gainNode

gainNode?: GainNode

Private hasStarted

hasStarted: boolean = false

origin

origin: MediaStreamSound

Optional panner

panner?: PannerNode | StereoPannerNode

Optional source

source?: MediaStreamAudioSourceNode

Private stopTracksOnStop

stopTracksOnStop: boolean

Accessors

duration

filters

isFading

  • get isFading(): boolean

  • Whether a fade is currently in progress.

    Returns boolean

isPlaying

  • get isPlaying(): boolean

  • Checks if the audio is currently playing.

    Returns boolean

    True if the audio is playing, false otherwise.

outputNode

panType

playbackRate

position

  • get position(): Position

  • Gets the position of the audio source in 3D space (HRTF panning only).

    Returns Position

    The [x, y, z] coordinates of the audio source.

    Throws

    Throws an error if the sound has been cleaned up or if HRTF panning is not used.

  • set position(position): void

  • Sets the position of the audio source in 3D space (HRTF panning only).

    Parameters

    • position: Position

      The [x, y, z] coordinates of the audio source.

    Returns void

    Throws

    Throws an error if the sound has been cleaned up or if HRTF panning is not used.

stereoPan

  • get stereoPan(): null | number

  • Gets the stereo panning value.

    Returns null | number

    The current stereo pan value, or null if stereo panning is not applicable.

  • set stereoPan(value): void

  • Sets the stereo panning value.

    Parameters

    • value: number

      The stereo pan value to set, between -1 (left) and 1 (right).

    Returns void

    Throws

    Throws an error if stereo panning is not available, if the sound has been cleaned up, or if the value is out of bounds.

threeDOptions

  • get threeDOptions(): PannerOptions

  • Gets the 3D audio options if HRTF panning is used.

    Returns PannerOptions

    The current 3D audio options.

    Throws

    Throws an error if the sound has been cleaned up or if HRTF panning is not used.

  • set threeDOptions(options): void

  • Sets the 3D audio options for HRTF panning.

    Parameters

    • options: Partial<PannerOptions>

      The 3D audio options to set.

    Returns void

    Throws

    Throws an error if the sound has been cleaned up or if HRTF panning is not used.

volume

  • get volume(): number

  • Gets the current volume of the audio.

    Returns number

    The current volume.

    Throws

    Throws an error if the sound has been cleaned up.

  • set volume(v): void

  • Sets the volume of the audio.

    Parameters

    • v: number

      The volume to set.

    Returns void

    Throws

    Throws an error if the sound has been cleaned up.

Methods

addFilter

addFilters

applyFilters

  • applyFilters(connection): any

  • Parameters

    • connection: any

    Returns any

cancelFade

  • cancelFade(): void

  • Cancels any in-progress fade, emitting fadeCancel if a fade was active.

    Returns void

cleanup

connect

disconnect

emit

emitAsync

fadeIn

  • fadeIn(duration, type?): Promise<void>

  • Fades in from silence to the 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 the fade completes.

fadeOut

  • fadeOut(duration, type?): Promise<void>

  • Fades out from the 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 the fade completes.

fadeTo

  • fadeTo(value, duration, type?): Promise<void>

  • Fades the volume to a target value, emitting fadeStart and fadeEnd events.

    Parameters

    • value: number
    • duration: number
    • type: FadeType = "linear"

    Returns Promise<void>

off

  • off<K>(event, listener): void

  • Remove event listener.

    Type Parameters

    Parameters

    • event: K
    • listener: ((data) => void)

    Returns void

on

  • on<K>(event, listener): (() => void)

  • Register event listener.

    Type Parameters

    Parameters

    • event: K
    • listener: ((data) => void)

    Returns (() => void)

    Cleanup function

      • (): void

      • Returns void

pause

play

Private refreshFilters

removeFilter

removeFilters

resume

setGainNode

setPanType

setPannerNode

stop

Settings

Member Visibility

Theme

On This Page

constructor_fadeTimeout_filters_isFading_panType_playingeventEmittergainNodehasStartedoriginpannersourcestopTracksOnStopdurationfiltersisFadingisPlayingoutputNodepanTypeplaybackRatepositionstereoPanthreeDOptionsvolumeaddFilteraddFiltersapplyFilterscancelFadecleanupconnectdisconnectemitemitAsyncfadeInfadeOutfadeTooffonpauseplayrefreshFiltersremoveFilterremoveFiltersresumesetGainNodesetPanTypesetPannerNodestop