Class PcmStreamPlayback

Hierarchy

BasePlayback
- PcmStreamPlayback

Constructors

constructor

new PcmStreamPlayback(
    origin: PcmStreamSound,
    source: AudioWorkletNode,
    gainNode: GainNode,
    context: BaseContext,
    outputNode: AudioNode,
    panType: PanType,
): PcmStreamPlayback
Parameters
- origin: PcmStreamSound
- source: AudioWorkletNode
- gainNode: GainNode
- context: BaseContext
- outputNode: AudioNode
- panType: PanType
Returns PcmStreamPlayback
Overrides BasePlayback.constructor
- Defined in src/pcmStream.ts:50

Properties

`Protected` `Optional`_effectChain

_effectChain?: EffectChain

_filters

_filters: BiquadFilterNode[] = []

_isFading

_isFading: boolean

_panType

_panType: PanType

_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

origin

origin: PcmStreamSound

`Optional`panner

panner?: PannerNode | StereoPannerNode

`Readonly`panType

panType: PanType

position

position: Position

Requested position target; initial poses are immediate, subsequent writes use spatialSmoothingTau.

`Optional`source

source?: AudioWorkletNode

spatialSmoothingTau

spatialSmoothingTau: number

Spatial exponential time constant in seconds (default 0). Setting 0 snaps pending targets.

Accessors

_spatialSmoothingActive

get _spatialSmoothingActive(): boolean
Internal
Smooth only while a voice can be heard or resumed. Unplayed and stopped voices take poses immediately, so a replayed voice starts at its requested pose.

Returns boolean
Inherited from BasePlayback._spatialSmoothingActive
- Defined in src/basePlayback.ts:38

duration

get duration(): number
Returns number
- Defined in src/pcmStream.ts:67

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:195

isPlaying

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

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

outputNode

get outputNode(): GainNode
Returns GainNode
- Defined in src/pcmStream.ts:136

playbackRate

get playbackRate(): number
Returns number
- Defined in src/pcmStream.ts:116
set playbackRate(_rate: number): void
Parameters
- _rate: number
Returns void
- Defined in src/pcmStream.ts:120

state

get state(): PlaybackState
Gets the current lifecycle state without changing playback.

Returns PlaybackState
Inherited from BasePlayback.state
- Defined in src/basePlayback.ts:186

stereoPan

get stereoPan(): number | null
Requested stereo pan target, including during smoothing.

Returns number | null
Inherited from BasePlayback.stereoPan
- Defined in src/pannerMixin.ts:65
set stereoPan(value: number): void
Parameters
- value: number
Returns void
Inherited from BasePlayback.stereoPan
- Defined in src/pannerMixin.ts:66

threeDOptions

get threeDOptions(): ThreeDOptions
Panner configuration with requested position/orientation targets; omitted axes retain automation.

Returns ThreeDOptions
Inherited from BasePlayback.threeDOptions
- Defined in src/pannerMixin.ts:68
set threeDOptions(options: ThreeDOptions | Partial<HrtfPannerOptions>): void
Parameters
- options: ThreeDOptions | Partial<HrtfPannerOptions>
Returns void
Inherited from BasePlayback.threeDOptions
- Defined in src/pannerMixin.ts:69

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:68

_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:63

_handleEnded

_handleEnded(): void
Returns void
- Defined in src/pcmStream.ts:108

_snapSpatialMotion

_snapSpatialMotion(): void
Internal
Snap pending spatial transitions to their requested targets.

Returns void
Inherited from BasePlayback._snapSpatialMotion
- Defined in src/pannerMixin.ts:59

_validateSpatialOptions

_validateSpatialOptions(options: SpatialOptions): void
Internal
Validate a spatial write without changing the voice.
Parameters
- options: SpatialOptions
Returns void
Inherited from BasePlayback._validateSpatialOptions
- Defined in src/pannerMixin.ts:61

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:54

addFilter

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

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:284

cleanup

cleanup(): void
Returns void
Overrides BasePlayback.cleanup
- Defined in src/pcmStream.ts:155

connect

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

disconnect

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

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:258

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:262

`Protected`emitPaused

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

`Protected`emitPlayStarted

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

`Protected`emitStopped

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

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:269

isFilterBypassed

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

`Protected`markPaused

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

`Protected`markPlaying

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

`Protected`markStopped

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

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:254

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:247

pause

pause(): void
Returns void
Overrides BasePlayback.pause
- Defined in src/pcmStream.ts:87

play

play(options?: PlayOptions): [PcmStreamPlayback]
Parameters
- Optionaloptions: PlayOptions
Returns [PcmStreamPlayback]
Overrides BasePlayback.play
- Defined in src/pcmStream.ts:71

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:110

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:158

removeFilter

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

`Protected`setEffectChainEndpoints

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

setFilterBypassed

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

setFilterOrder

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

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:63

setPanType

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

stop

stop(): void
Returns void
Overrides BasePlayback.stop
- Defined in src/pcmStream.ts:95

Class PcmStreamPlayback

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PcmStreamPlayback

Properties

Protected Optional_effectChain

_filters

_isFading

_panType

_sendGains

Protected_state

eventEmitter

OptionalgainNode

origin

Optionalpanner

ReadonlypanType

position

Optionalsource

spatialSmoothingTau

Accessors

_spatialSmoothingActive

Returns boolean

duration

Returns number

filters

Returns BiquadFilterNode[]

isFading

Returns boolean

isPaused

Returns boolean

isPlaying

Returns boolean

outputNode

Returns GainNode

playbackRate

Returns number

Parameters

Returns void

state

Returns PlaybackState

stereoPan

Returns number | null

Parameters

Returns void

threeDOptions

Returns ThreeDOptions

Parameters

Returns void

volume

Returns number

Parameters

Returns void

Methods

_addFilterEffect

Parameters

Returns Promise<AudioNode>

_addSourceEffect

Parameters

Returns Promise<AudioNode>

_handleEnded

Returns void

_snapSpatialMotion

Returns void

_validateSpatialOptions

Parameters

Returns void

addEffect

Parameters

Returns Promise<AudioNode>

addFilter

Parameters

Returns void

addFilters

`Protected` `Optional`_effectChain

`Protected`_state

`Optional`gainNode

`Optional`panner

`Readonly`panType

`Optional`source

`Protected`emitPaused

`Protected`emitPlayStarted

`Protected`emitStopped

`Protected`markPaused

`Protected`markPlaying

`Protected`markStopped

`Protected`setEffectChainEndpoints