API

Audio

Semantic audio values, stateful sessions, codecs, and signal operations.

Generated from rustdocNative Rust surface22 functions19 types5 enums0 constants & variables
This inventory is generated from public rustdoc declarations. Modules, structs, enums, traits, aliases, signatures, source comments, and source links follow the native Rust API.

Examples

oa

Types

20 members

Whole-audio value backed by a planar FP32 [channels, samples] matrix. Clones retain the same matrix storage and semantic audio metadata.

Source
10 members
9 members
19 members

Incremental WAV, FLAC, or MP3 playback through the default output device.

Open the source and default output device with decoding initially paused.

method

Open the source and default output device with decoding initially paused.

method

Open the source and default output device with decoding initially paused.

method

Open the source and default output device with decoding initially paused.

method

Open the source and default output device with decoding initially paused.

method

Open the source and default output device with decoding initially paused.

method

Open the source and default output device with decoding initially paused.

method

Open the source and default output device with decoding initially paused.

method

Open the source and default output device with decoding initially paused.

method

Open the source and default output device with decoding initially paused.

method

Open the source and default output device with decoding initially paused.

method

Open the source and default output device with decoding initially paused.

method
Source

Enums

Speaker layout carried by an Audio value.

Mono · Stereo · Stereo21 · Surround51 · Surround71 · Unknown

Functions

Decode one WAV/PCM, FLAC, or MP3 file and upload planar FP32 samples. This is a synchronous CPU codec boundary followed by device upload. It does not introduce a decoder session or a hidden execution backend. Errors Returns an error for an empty path, file I/O failure, unsupported or malformed media, changing stream parameters, empty decoded audio, checked-size overflow, or device allocation/upload failure.

Decode one in-memory WAV/PCM, FLAC, or MP3 stream and upload planar FP32 samples. Errors Returns an error for empty, unsupported, malformed, or parameter-changing media, empty decoded audio, checked-size overflow, or device allocation/upload failure.

Encode non-empty interleaved FP32 frames as lossless IEEE-float WAV bytes. Errors Returns an error for a zero sample rate or channel count, incomplete frames, or values that exceed the RIFF/WAV 32-bit header limits.

Read planar device samples and encode lossless IEEE-float WAV bytes. This is an explicit blocking host-observation boundary. Errors Returns an error when readback fails or the resulting WAV exceeds checked allocation or RIFF header limits.

Encode and write one lossless IEEE-float WAV file. This is an explicit blocking host-observation and filesystem boundary. Errors Returns an error for an empty path, failed readback or encoding, or a host filesystem write failure.

Types

20 members

Whole-audio value backed by a planar FP32 [channels, samples] matrix. Clones retain the same matrix storage and semantic audio metadata.

Source
10 members
3 members
4 members
4 members
9 members
19 members

Incremental WAV, FLAC, or MP3 playback through the default output device.

Open the source and default output device with decoding initially paused.

method

Open the source and default output device with decoding initially paused.

method

Open the source and default output device with decoding initially paused.

method

Open the source and default output device with decoding initially paused.

method

Open the source and default output device with decoding initially paused.

method

Open the source and default output device with decoding initially paused.

method

Open the source and default output device with decoding initially paused.

method

Open the source and default output device with decoding initially paused.

method

Open the source and default output device with decoding initially paused.

method

Open the source and default output device with decoding initially paused.

method

Open the source and default output device with decoding initially paused.

method

Open the source and default output device with decoding initially paused.

method
Source
4 members
4 members
3 members
4 members
4 members
4 members
4 members
4 members

Enums

Speaker layout carried by an Audio value.

Mono · Stereo · Stereo21 · Surround51 · Surround71 · Unknown

Elementary audio representation produced by AudioEncoder.

PcmS16

Global level estimator used by normalize.

Peak · Rms

Window function applied before each FFT frame.

Hann · Hamming · Blackman · Rectangular