SoundStream | miniSphere

Provides a stream-like interface for playing raw audio data.

Hierarchy

SoundStream

Index

Constructors

constructor

Properties

length

Methods

Constructors

constructor

new SoundStream(sampleRate?: number, bitsPerSample?: 8 | 16 | 32, numChannels?: number): SoundStream

- Defined in lib.sphere.d.ts:1313
Construct a new audio stream with the given parameters.

Parameters
- Optional sampleRate: number
  
  The sample rate of the audio data, in Hz.
- Optional bitsPerSample: 8 | 16 | 32
  
  The number of bits per sample.
- Optional numChannels: number
  
  Number of independent audio channels in the audio data.
Returns SoundStream

Properties

length

length: number

Methods

pause

pause(): void

- Defined in lib.sphere.d.ts:1326
Pause playback of this audio stream.

Returns void

play

play(mixer?: Mixer): void

- Defined in lib.sphere.d.ts:1332
Play this audio stream on a given mixer. If the stream is paused and a mixer is not specified, resume playback from the paused position.

Parameters
- Optional mixer: Mixer
Returns void

stop

stop(): void

- Defined in lib.sphere.d.ts:1335
Stop playback and discard any unplayed data in the stream buffer.

Returns void

write

write(data: ArrayBuffer | ArrayBufferView): void

- Defined in lib.sphere.d.ts:1342
Write new audio data to the end of the stream buffer. Can (and should!) be called during active playback.

Parameters
- data: ArrayBuffer | ArrayBufferView
  
  Buffer containing audio data to feed into the stream.
Returns void

Generated using TypeDoc