Class PcmStreamSound

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

Hierarchy

RoutableSource
- PcmStreamSound

Implements

BaseSound

Constructors

constructor

new PcmStreamSound(
    workletNode: AudioWorkletNode,
    context: BaseContext,
    globalGainNode: GainNode,
    options: PcmStreamSoundOptions & {
        bufferDuration: number;
        channelCount: number;
        latency: number;
    },
    _cacophony?: Cacophony,
): PcmStreamSound
Parameters
- workletNode: AudioWorkletNode
- context: BaseContext
- globalGainNode: GainNode
- options: PcmStreamSoundOptions & {
      bufferDuration: number;
      channelCount: number;
      latency: number;
  }
- Optional_cacophony: Cacophony
Returns PcmStreamSound
Overrides RoutableSource.constructor
- Defined in src/pcmStream.ts:213

Properties

_filters

_filters: BiquadFilterNode[] = []

_position

_position: Position

`Protected`_routeTarget

_routeTarget: Bus | null = null

Primary route target. null is the canonical master route.

`Protected`_sends

_sends: Map<Bus, number> = ...

Additional send target to gain-value mappings.

_stereoPan

_stereoPan: number

_threeDOptions

_threeDOptions: ThreeDOptions

_volume

_volume: number

`Protected`context

context: BaseContext

`Protected`globalGainNode

globalGainNode: GainNode

`Readonly`panType

panType: PanType

playbacks

playbacks: PcmStreamPlayback[]

`Optional`soundType

soundType?: SoundType

spatialSmoothingTau

spatialSmoothingTau: number

Spatial time constant in seconds; assigning changes current and future voices.

`Optional`streamCapabilities

streamCapabilities?: StreamCapabilities

Accessors

bufferedDuration

get bufferedDuration(): number
Returns number
- Defined in src/pcmStream.ts:241

cacophony

get cacophony(): Cacophony | undefined
Returns Cacophony | undefined
Overrides RoutableSource.cacophony
- Defined in src/pcmStream.ts:237

filters

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

inputChannelCount

get inputChannelCount(): number
Returns number
- Defined in src/pcmStream.ts:245

isPlaying

get isPlaying(): boolean
Returns boolean
Implementation of BaseSound.isPlaying

Inherited from RoutableSource.isPlaying
- Defined in src/container.ts:61

playbackRate

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

position

get position(): Position
Returns Position
Implementation of BaseSound.position

Inherited from RoutableSource.position
- Defined in src/container.ts:62
set position(position: Position): void
Parameters
- position: Position
Returns void
Implementation of BaseSound.position

Inherited from RoutableSource.position
- Defined in src/container.ts:63

stereoPan

get stereoPan(): number
Returns number
Inherited from RoutableSource.stereoPan
- Defined in src/container.ts:66
set stereoPan(value: number): void
Parameters
- value: number
Returns void
Inherited from RoutableSource.stereoPan
- Defined in src/container.ts:67

threeDOptions

get threeDOptions(): ThreeDOptions
Returns ThreeDOptions
Implementation of BaseSound.threeDOptions

Inherited from RoutableSource.threeDOptions
- Defined in src/container.ts:64
set threeDOptions(options: ThreeDOptions | Partial<HrtfPannerOptions>): void
Parameters
- options: ThreeDOptions | Partial<HrtfPannerOptions>
Returns void
Implementation of BaseSound.threeDOptions

Inherited from RoutableSource.threeDOptions
- Defined in src/container.ts:65

volume

get volume(): number
Returns number
Implementation of BaseSound.volume

Inherited from RoutableSource.volume
- Defined in src/container.ts:68
set volume(volume: number): void
Parameters
- volume: number
Returns void
Implementation of BaseSound.volume

Inherited from RoutableSource.volume
- Defined in src/container.ts:69

Methods

_onBusDrained

_onBusDrained(bus: Bus, target: Bus): void
Called by Bus.drainTo to move this source off the draining bus onto target. The source reroutes its primary route and/or any send that targeted bus.
Parameters
- bus: Bus
- target: Bus
Returns void
Inherited from RoutableSource._onBusDrained
- Defined in src/routableSource.ts:293

`Protected`_preparePlayback

_preparePlayback(playback: BasePlayback): void
Materialize all declared recipes, then establish this playback's sends.
Parameters
- playback: BasePlayback
Returns void
Inherited from RoutableSource._preparePlayback
- Defined in src/routableSource.ts:179

_resolveRouteTargetNode

_resolveRouteTargetNode(): GainNode
Resolve the node used by future playbacks for their primary output. Sources left on a subsequently destroyed bus fall back to master.

Returns GainNode
Inherited from RoutableSource._resolveRouteTargetNode
- Defined in src/routableSource.ts:147

_validateSpatialOptions

_validateSpatialOptions(options: SpatialOptions): void
Internal
Validate a broadcast, including every voice, without mutation.
Parameters
- options: SpatialOptions
Returns void
Inherited from RoutableSource._validateSpatialOptions
- Defined in src/container.ts:54

`Protected`_wireRouteSends

_wireRouteSends(playback: BasePlayback): void
Establish every configured send on a newly created playback.
Parameters
- playback: BasePlayback
Returns void
Inherited from RoutableSource._wireRouteSends
- Defined in src/routableSource.ts:163

addEffect

addEffect(effect: CacophonyEffect): void
Parameters
- effect: CacophonyEffect
Returns void
Inherited from RoutableSource.addEffect
- Defined in src/routableSource.ts:51

addFilter

addFilter(filter: BiquadFilterNode): void
Adds a BiquadFilterNode to the filter chain.
Parameters
- filter: BiquadFilterNode
Returns void

Throws
If the same filter instance is added twice.
Implementation of BaseSound.addFilter

Inherited from RoutableSource.addFilter
- Defined in src/routableSource.ts:66

addFilters

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

attachPullSource

attachPullSource(
source: PcmStreamPullSource,
capabilities: StreamCapabilities,
): void
Parameters
- source: PcmStreamPullSource
- capabilities: StreamCapabilities
Returns void
- Defined in src/pcmStream.ts:269

cleanup

cleanup(): void
Returns void
Overrides RoutableSource.cleanup
- Defined in src/pcmStream.ts:418

end

end(): void
Returns void
- Defined in src/pcmStream.ts:325

fadeIn

fadeIn(duration: number, type?: FadeType): Promise<void>
Parameters
- duration: number
- Optionaltype: FadeType
Returns Promise<void>
Implementation of BaseSound.fadeIn

Inherited from RoutableSource.fadeIn
- Defined in src/container.ts:71

fadeOut

fadeOut(duration: number, type?: FadeType): Promise<void>
Parameters
- duration: number
- Optionaltype: FadeType
Returns Promise<void>
Implementation of BaseSound.fadeOut

Inherited from RoutableSource.fadeOut
- Defined in src/container.ts:72

fadeTo

fadeTo(value: number, duration: number, type?: FadeType): Promise<void>
Parameters
- value: number
- duration: number
- Optionaltype: FadeType
Returns Promise<void>
Implementation of BaseSound.fadeTo

Inherited from RoutableSource.fadeTo
- Defined in src/container.ts:70

handlePullError

handlePullError(error: unknown): void
Parameters
- error: unknown
Returns void
- Defined in src/pcmStream.ts:278

loop

loop(_loopCount?: LoopCount): LoopCount
Parameters
- Optional_loopCount: LoopCount
Returns LoopCount
- Defined in src/pcmStream.ts:408

off

off<K extends keyof PcmStreamEvents>(
event: K,
listener: (data: PcmStreamEvents[K]) => void,
): void
Type Parameters
- K extends keyof PcmStreamEvents
Parameters
- event: K
- listener: (data: PcmStreamEvents[K]) => void
Returns void
- Defined in src/pcmStream.ts:253

on

on<K extends keyof PcmStreamEvents>(
event: K,
listener: (data: PcmStreamEvents[K]) => void,
): () => void
Type Parameters
- K extends keyof PcmStreamEvents
Parameters
- event: K
- listener: (data: PcmStreamEvents[K]) => void
Returns () => void
- Defined in src/pcmStream.ts:249

pause

pause(): void
Returns void
Implementation of BaseSound.pause

Overrides RoutableSource.pause
- Defined in src/pcmStream.ts:370

play

play(options?: PlayOptions): PcmStreamPlayback[]
Parameters
- Optionaloptions: PlayOptions
Returns PcmStreamPlayback[]
Implementation of BaseSound.play

Overrides RoutableSource.play
- Defined in src/pcmStream.ts:360

preplay

preplay(): PcmStreamPlayback[]
Returns PcmStreamPlayback[]
Overrides RoutableSource.preplay
- Defined in src/pcmStream.ts:333

removeEffect

removeEffect(effect: CacophonyEffect): void
Parameters
- effect: CacophonyEffect
Returns void
Inherited from RoutableSource.removeEffect
- Defined in src/routableSource.ts:58

removeFilter

removeFilter(filter: BiquadFilterNode): void
Removes a BiquadFilterNode from the filter chain by object identity.
Parameters
- filter: BiquadFilterNode
Returns void

Throws
If the filter was never added to this container.
Implementation of BaseSound.removeFilter

Inherited from RoutableSource.removeFilter
- Defined in src/routableSource.ts:74

removeSend

removeSend(target: string | Bus): void
Remove this source's aux send from current and future playbacks without changing its primary route. No-op if no send exists, including when the bus reference is destroyed. Names must still resolve to a registered bus; retain the bus reference to remove a send after destroying a named bus.
Parameters
- target: string | Bus
Returns void
Inherited from RoutableSource.removeSend
- Defined in src/routableSource.ts:110

resume

resume(): void
Returns void
- Defined in src/pcmStream.ts:378

routeTo

routeTo(
    target: string | Bus,
    sendGain?: number,
    options?: SendGainOptions,
): void
Route this source to a bus, or add an independent send when sendGain is provided. options ramps existing sends in place; new sends and future playbacks start at sendGain. Prior automation is canceled and re-anchored. Exponential ramps to zero approach 0.0001, then become exactly silent at the endpoint. Ramps from zero or involving negative gains use linear interpolation.
Parameters
- target: string | Bus
- OptionalsendGain: number
- Optionaloptions: SendGainOptions
Returns void

Throws
RangeError for non-finite gain or negative/non-finite duration.

Throws
TypeError when options is given without sendGain; primary routes do not ramp.
Inherited from RoutableSource.routeTo
- Defined in src/routableSource.ts:94

seek

seek(time: number): void
Parameters
- time: number
Returns void
Implementation of BaseSound.seek
- Defined in src/pcmStream.ts:401

stop

stop(): void
Returns void
Implementation of BaseSound.stop

Overrides RoutableSource.stop
- Defined in src/pcmStream.ts:386

stopWithFade

stopWithFade(duration: number, type?: FadeType): Promise<void>
Parameters
- duration: number
- Optionaltype: FadeType
Returns Promise<void>
Implementation of BaseSound.stopWithFade

Inherited from RoutableSource.stopWithFade
- Defined in src/container.ts:73

write

write(samples: Float32Array): boolean
Enqueue PCM at the context's sample rate.

Samples are interleaved according to channelCount. false means the fixed ring buffer is full (or this accepted write filled it); wait for drain before retrying a rejected chunk.
Parameters
- samples: Float32Array
Returns boolean
- Defined in src/pcmStream.ts:291

Class PcmStreamSound

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PcmStreamSound

Properties

_filters

_position

Protected_routeTarget

Protected_sends

_stereoPan

_threeDOptions

_volume

Protectedcontext

ProtectedglobalGainNode

ReadonlypanType

playbacks

OptionalsoundType

spatialSmoothingTau

OptionalstreamCapabilities

Accessors

bufferedDuration

Returns number

cacophony

Returns Cacophony | undefined

filters

Returns BiquadFilterNode[]

inputChannelCount

Returns number

isPlaying

Returns boolean

playbackRate

Returns number

Parameters

Returns void

position

Returns Position

Parameters

Returns void

stereoPan

Returns number

Parameters

Returns void

threeDOptions

Returns ThreeDOptions

Parameters

Returns void

volume

Returns number

Parameters

Returns void

Methods

_onBusDrained

Parameters

Returns void

Protected_preparePlayback

Parameters

Returns void

_resolveRouteTargetNode

Returns GainNode

_validateSpatialOptions

Parameters

Returns void

Protected_wireRouteSends

Parameters

Returns void

addEffect

Parameters

Returns void

addFilter

Parameters

Returns void

Throws

`Protected`_routeTarget

`Protected`_sends

`Protected`context

`Protected`globalGainNode

`Readonly`panType

`Optional`soundType

`Optional`streamCapabilities

`Protected`_preparePlayback

`Protected`_wireRouteSends