Class MediaStreamPlayback

Hierarchy

BasePlayback
- MediaStreamPlayback

Constructors

constructor

new MediaStreamPlayback(
    origin: MediaStreamSound,
    source: MediaStreamAudioSourceNode,
    gainNode: GainNode,
    context: BaseContext,
    outputNode: AudioNode,
    panType: PanType,
    stopTracksOnStop: boolean,
    primeWithMediaElement?: boolean,
): MediaStreamPlayback
Parameters
- origin: MediaStreamSound
- source: MediaStreamAudioSourceNode
- gainNode: GainNode
- context: BaseContext
- outputNode: AudioNode
- panType: PanType
- stopTracksOnStop: boolean
- primeWithMediaElement: boolean = true
Returns MediaStreamPlayback
Overrides BasePlayback.constructor
- Defined in src/mediaStream.ts:46

Properties

`Protected` `Optional`_effectChain

_effectChain?: EffectChain

_filters

_filters: BiquadFilterNode[] = []

_isFading

_isFading: boolean

_panType

_panType: PanType = "stereo"

_sendGains

_sendGains: Map<Bus, GainNode> = ...

Per-playback send-gain allocations owned by the shared routing state machine. Cleanup disconnects every allocation deterministically.

`Protected`_state

_state: PlaybackState = "unplayed"

eventEmitter

eventEmitter: TypedEventEmitter<PlaybackEvents> = ...

`Optional`gainNode

gainNode?: GainNode

Accessors

duration

get duration(): number
Returns number
- Defined in src/mediaStream.ts:98

filters

get filters(): BiquadFilterNode[]
Returns BiquadFilterNode[]
Inherited from BasePlayback.filters
- Defined in src/filters.ts:38

isFading

get isFading(): boolean
Returns boolean
Inherited from BasePlayback.isFading
- Defined in src/volumeMixin.ts:18

isPaused

get isPaused(): boolean
Returns boolean
Inherited from BasePlayback.isPaused
- Defined in src/basePlayback.ts:173

isPlaying

get isPlaying(): boolean
Checks if the audio is currently playing.

Returns boolean
Inherited from BasePlayback.isPlaying
- Defined in src/basePlayback.ts:169

outputNode

get outputNode(): GainNode
Returns GainNode
- Defined in src/mediaStream.ts:183

panType

get panType(): PanType
Returns PanType
Inherited from BasePlayback.panType
- Defined in src/pannerMixin.ts:63

playbackRate

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

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.
Inherited from BasePlayback.position
- Defined in src/pannerMixin.ts:220
set position(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.
Inherited from BasePlayback.position
- Defined in src/pannerMixin.ts:200

stereoPan

get stereoPan(): number | null
Gets the stereo panning value.

Returns number | null
The current stereo pan value, or null if stereo panning is not applicable.
Inherited from BasePlayback.stereoPan
- Defined in src/pannerMixin.ts:95
set stereoPan(value: number): 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.
Inherited from BasePlayback.stereoPan
- Defined in src/pannerMixin.ts:108

threeDOptions

get threeDOptions(): ThreeDOptions
Gets the 3D audio options if HRTF panning is used.

Returns ThreeDOptions
The current 3D audio options (HRTF variant).

Throws
Throws an error if the sound has been cleaned up or if HRTF panning is not used.
Inherited from BasePlayback.threeDOptions
- Defined in src/pannerMixin.ts:127
set threeDOptions(options: ThreeDOptions | Partial<HrtfPannerOptions>): void
Sets the 3D audio options for HRTF panning. Accepts either a full ThreeDOptions value or a partial HRTF override. Any field omitted from the input is left at its current value on the underlying PannerNode.
Parameters
- options: ThreeDOptions | Partial<HrtfPannerOptions>
Returns void

Throws
Throws an error if the sound has been cleaned up or if HRTF panning is not used.
Inherited from BasePlayback.threeDOptions
- Defined in src/pannerMixin.ts:163

volume

get volume(): number
Returns number
Inherited from BasePlayback.volume
- Defined in src/volumeMixin.ts:16
set volume(value: number): void
Parameters
- value: number
Returns void
Inherited from BasePlayback.volume
- Defined in src/volumeMixin.ts:17

Methods

_addFilterEffect

_addFilterEffect(effect: CacophonyEffect): Promise<AudioNode>
Internal
Materialize a source-level biquad recipe and retain filter API compatibility.
Parameters
- effect: CacophonyEffect
Returns Promise<AudioNode>
Inherited from BasePlayback._addFilterEffect
- Defined in src/basePlayback.ts:59

_addSourceEffect

_addSourceEffect(effect: CacophonyEffect): Promise<AudioNode>
Internal
Source preplay path that preserves synchronous native-build failures.
Parameters
- effect: CacophonyEffect
Returns Promise<AudioNode>
Inherited from BasePlayback._addSourceEffect
- Defined in src/basePlayback.ts:54

addEffect

addEffect(effect: CacophonyEffect): Promise<AudioNode>
Build and splice an effect into this live playback's pre-panner chain.
Parameters
- effect: CacophonyEffect
Returns Promise<AudioNode>
Inherited from BasePlayback.addEffect
- Defined in src/basePlayback.ts:45

addFilter

addFilter(filter: BiquadFilterNode): void
Parameters
- filter: BiquadFilterNode
Returns void
Overrides BasePlayback.addFilter
- Defined in src/mediaStream.ts:169

addFilters

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

cancelFade

cancelFade(): void
Cancels any in-progress fade, emitting fadeCancel if a fade was active.

Returns void
Inherited from BasePlayback.cancelFade
- Defined in src/basePlayback.ts:260

cleanup

cleanup(): void
Returns void
Overrides BasePlayback.cleanup
- Defined in src/mediaStream.ts:210

connect

connect(destination: AudioParam | AudioNode): AudioNode
Parameters
- destination: AudioParam | AudioNode
Returns AudioNode
- Defined in src/mediaStream.ts:190

disconnect

disconnect(destination?: AudioParam | AudioNode): void
Parameters
- Optionaldestination: AudioParam | AudioNode
Returns void
- Defined in src/mediaStream.ts:194

emit

emit<K extends "seek" | (keyof BaseAudioEvents)>(
event: K,
data: PlaybackEvents[K],
): void
Type Parameters
- K extends "seek" | (keyof BaseAudioEvents)
Parameters
- event: K
- data: PlaybackEvents[K]
Returns void
Inherited from BasePlayback.emit
- Defined in src/basePlayback.ts:234

emitAsync

emitAsync<K extends "seek" | (keyof BaseAudioEvents)>(
event: K,
data: PlaybackEvents[K],
): Promise<void>
Type Parameters
- K extends "seek" | (keyof BaseAudioEvents)
Parameters
- event: K
- data: PlaybackEvents[K]
Returns Promise<void>
Inherited from BasePlayback.emitAsync
- Defined in src/basePlayback.ts:238

`Protected`emitPaused

emitPaused(): void
Returns void
Inherited from BasePlayback.emitPaused
- Defined in src/basePlayback.ts:201

`Protected`emitPlayStarted

emitPlayStarted(isResume: boolean): void
Parameters
- isResume: boolean
Returns void
Inherited from BasePlayback.emitPlayStarted
- Defined in src/basePlayback.ts:189

`Protected`emitStopped

emitStopped(): void
Returns void
Inherited from BasePlayback.emitStopped
- Defined in src/basePlayback.ts:210

fadeIn

fadeIn(
    duration: number,
    type?: FadeType,
    options?: { startTime?: number },
): Promise<void>
Parameters
- duration: number
- Optionaltype: FadeType
- Optionaloptions: { startTime?: number }
Returns Promise<void>
Inherited from BasePlayback.fadeIn
- Defined in src/volumeMixin.ts:26

fadeOut

fadeOut(duration: number, type?: FadeType): Promise<void>
Parameters
- duration: number
- Optionaltype: FadeType
Returns Promise<void>
Inherited from BasePlayback.fadeOut
- Defined in src/volumeMixin.ts:27

fadeTo

fadeTo(
    value: number,
    duration: number,
    type?: FadeType,
    options?: { startTime?: number; startValue?: number },
): Promise<void>
Fades the volume to a target value, emitting fadeStart and fadeEnd events.
Parameters
- value: number
- duration: number
- type: FadeType = "linear"
- Optionaloptions: { startTime?: number; startValue?: number }
Returns Promise<void>
Inherited from BasePlayback.fadeTo
- Defined in src/basePlayback.ts:245

isFilterBypassed

isFilterBypassed(filter: BiquadFilterNode): boolean
Parameters
- filter: BiquadFilterNode
Returns boolean
Inherited from BasePlayback.isFilterBypassed
- Defined in src/basePlayback.ts:145

`Protected`markPaused

markPaused(): void
Returns void
Inherited from BasePlayback.markPaused
- Defined in src/basePlayback.ts:181

`Protected`markPlaying

markPlaying(): void
Returns void
Inherited from BasePlayback.markPlaying
- Defined in src/basePlayback.ts:177

`Protected`markStopped

markStopped(): void
Returns void
Inherited from BasePlayback.markStopped
- Defined in src/basePlayback.ts:185

off

off<K extends "seek" | (keyof BaseAudioEvents)>(
event: K,
listener: (data: PlaybackEvents[K]) => void,
): void
Remove event listener.
Type Parameters
- K extends "seek" | (keyof BaseAudioEvents)
Parameters
- event: K
- listener: (data: PlaybackEvents[K]) => void
Returns void
Inherited from BasePlayback.off
- Defined in src/basePlayback.ts:230

on

on<K extends "seek" | (keyof BaseAudioEvents)>(
event: K,
listener: (data: PlaybackEvents[K]) => void,
): () => void
Register event listener.
Type Parameters
- K extends "seek" | (keyof BaseAudioEvents)
Parameters
- event: K
- listener: (data: PlaybackEvents[K]) => void
Returns () => void
Cleanup function
Inherited from BasePlayback.on
- Defined in src/basePlayback.ts:223

pause

pause(): void
Returns void
Overrides BasePlayback.pause
- Defined in src/mediaStream.ts:133

play

play(options?: PlayOptions): [MediaStreamPlayback]
Parameters
- Optionaloptions: PlayOptions
Returns [MediaStreamPlayback]
Overrides BasePlayback.play
- Defined in src/mediaStream.ts:102

rampEffectParam

rampEffectParam(
    handle: AudioNode,
    paramName: string,
    value: number,
    options?: { duration?: number; type?: FadeType },
): void
Parameters
- handle: AudioNode
- paramName: string
- value: number
- Optionaloptions: { duration?: number; type?: FadeType }
Returns void
Inherited from BasePlayback.rampEffectParam
- Defined in src/basePlayback.ts:101

rampFilterParam

rampFilterParam(
    filter: BiquadFilterNode,
    paramName: string,
    value: number,
    options?: { duration?: number; type?: FadeType },
): void
Parameters
- filter: BiquadFilterNode
- paramName: string
- value: number
- Optionaloptions: { duration?: number; type?: FadeType }
Returns void
Inherited from BasePlayback.rampFilterParam
- Defined in src/basePlayback.ts:149

removeFilter

removeFilter(filter: BiquadFilterNode): void
Parameters
- filter: BiquadFilterNode
Returns void
Overrides BasePlayback.removeFilter
- Defined in src/mediaStream.ts:176

resume

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

`Protected`setEffectChainEndpoints

setEffectChainEndpoints(input: AudioNode, output: AudioNode): void
Parameters
- input: AudioNode
- output: AudioNode
Returns void
Inherited from BasePlayback.setEffectChainEndpoints
- Defined in src/basePlayback.ts:33

setFilterBypassed

setFilterBypassed(filter: BiquadFilterNode, bypassed: boolean): void
Parameters
- filter: BiquadFilterNode
- bypassed: boolean
Returns void
Inherited from BasePlayback.setFilterBypassed
- Defined in src/basePlayback.ts:138

setFilterOrder

setFilterOrder(filters: readonly BiquadFilterNode[]): void
Parameters
- filters: readonly BiquadFilterNode[]
Returns void
Inherited from BasePlayback.setFilterOrder
- Defined in src/basePlayback.ts:129

setGainNode

setGainNode(gainNode: GainNode): void
Parameters
- gainNode: GainNode
Returns void
Inherited from BasePlayback.setGainNode
- Defined in src/volumeMixin.ts:14

setPannerNode

setPannerNode(pannerNode: PannerNode): void
Parameters
- pannerNode: PannerNode
Returns void
Inherited from BasePlayback.setPannerNode
- Defined in src/pannerMixin.ts:86

setPanType

setPanType(panType: PanType, audioContext: BaseContext): void
Parameters
- panType: PanType
- audioContext: BaseContext
Returns void
Inherited from BasePlayback.setPanType
- Defined in src/pannerMixin.ts:67

stop

stop(): void
Returns void
Overrides BasePlayback.stop
- Defined in src/mediaStream.ts:148

Class MediaStreamPlayback

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MediaStreamPlayback

Properties

Protected Optional_effectChain

_filters

_isFading

_panType

_sendGains

Protected_state

eventEmitter

OptionalgainNode

origin

Optionalpanner

Optionalsource

Accessors

duration

Returns number

filters

Returns BiquadFilterNode[]

isFading

Returns boolean

isPaused

Returns boolean

isPlaying

Returns boolean

outputNode

Returns GainNode

panType

Returns PanType

playbackRate

Returns number

Parameters

Returns void

position

Returns Position

Throws

Parameters

Returns void

Throws

stereoPan

Returns number | null

Parameters

Returns void

Throws

threeDOptions

Returns ThreeDOptions

Throws

Parameters

Returns void

Throws

volume

Returns number

Parameters

Returns void

Methods

_addFilterEffect

Parameters

Returns Promise<AudioNode>

_addSourceEffect

Parameters

Returns Promise<AudioNode>

addEffect

Parameters

Returns Promise<AudioNode>

addFilter

Parameters

Returns void

addFilters

Parameters

Returns void

cancelFade

`Protected` `Optional`_effectChain

`Protected`_state

`Optional`gainNode

`Optional`panner

`Optional`source

`Protected`emitPaused

`Protected`emitPlayStarted

`Protected`emitStopped

`Protected`markPaused

`Protected`markPlaying

`Protected`markStopped

`Protected`setEffectChainEndpoints