Open Asterune
AudioStream

AudioStream

Accepts PCM audio samples for queued playback.

Behavior

AudioStream accepts PCM audio samples for queued playback.

Summary

Members7
Properties5
Methods2
  • Clear(): ()

    Discards audio samples waiting in the playback queue.

  • Push(samples: buffer | { number }): number

    Queues interleaved PCM samples and returns the accepted sample count.

Properties

Channels

AudioStream.Channels: number

The number of interleaved channels in the PCM stream.

PlayedSeconds

AudioStream.PlayedSeconds: number

The amount of audio consumed by playback, in seconds.

QueuedSeconds

AudioStream.QueuedSeconds: number

The duration of audio currently queued, in seconds.

SampleRate

AudioStream.SampleRate: number

The sample rate in frames per second.

StarvedSeconds

AudioStream.StarvedSeconds: number

The time for which playback lacked queued samples, in seconds.

Methods

Clear

AudioStream:Clear(): ()

Discards audio samples waiting in the playback queue.

Push

AudioStream:Push(samples: buffer | { number }): number

Queues interleaved PCM samples and returns the accepted sample count. Accepts a buffer of little-endian 32-bit floats or an array of numbers. A buffer length not divisible by four causes an error.

Operators

__tostring · __type

Used by

Sound