Module record 

Recording the mix an audio world fills into its output buffer.

A recording is an OnAudioFill source ordered after every other one, so it sees the samples the whole world contributed. The samples it keeps are the ones the output stream would receive: the world’s GlobalAudioGain scales the sum and it clamps to the unit range, exactly as dispatch_audio_fill finishes a fill.

The recorder learns the format from the first fill it sees rather than being told one: an audio world publishes its rate only once a device is open, and a world that opens none fills at the rate its sources were built for. A recording stops at max_seconds of audio and keeps what it captured, so an unattended recording cannot grow without bound. A finished recording is written in the RecordingFormat its caller names: a RIFF/WAVE file of the samples themselves, or the same samples in a lossless FLAC stream.

Re-exports

use std::sync::Arc; 🔒

use std::sync::Mutex; 🔒

use unlit_ecs::sync; 🔒

use unlit_ecs::Entity; 🔒

use unlit_ecs::World; 🔒

use unlit_ecs::bundle; 🔒

use crate::audio::AudioChunk; 🔒

use crate::audio::AudioFillOrder; 🔒

use crate::audio::AudioFormat; 🔒

use crate::audio::GlobalAudioGain; 🔒

use crate::audio::OnAudioFill; 🔒

Structs

RecordedAudio

The samples a finished recording captured.

RecordingHandle

A recording in progress on a world.

RecordingState 🔒

What a recording has captured so far.

Enums

RecordingError

Why a recording, or the format it is written in, was refused.

RecordingFormat

The file format a recording is written in.

Constants

BITS_PER_SAMPLE 🔒

How many bits one quantized sample takes, the resolution both encoders declare for the samples they hold.

Functions

quantize 🔒

Quantize a sample into the 16-bit range both encoders write.

start_recording

Start recording everything world fills, for at most max_seconds.

write_flac 🔒

Write interleaved samples as a lossless FLAC stream.

write_wav 🔒

Write interleaved samples as a 16-bit PCM RIFF/WAVE file.