Struct RecordingHandle 

pub struct RecordingHandle {
    entity: Entity,
    state: Arc<Mutex<RecordingState>>,
}

A recording in progress on a world.

The handle owns the shared buffer the OnAudioFill source writes into. Keep it around — as a component of the world, for instance — and hand it back to RecordingHandle::stop or RecordingHandle::cancel to finish.

Fields

entity: Entity

state: Arc<Mutex<RecordingState>>

Implementations

impl RecordingHandle

pub(crate) fn format(&self) -> Option<AudioFormat>

The format the recording captured at, once it has seen a fill.

Only the MCP tools ask for it, and their module is compiled on the host under its feature alone, so a build without them carries it unread. The unit tests below read it too, so a test build never does.

pub fn frame_count(&self) -> usize

How many frames the recording has captured.

pub fn seconds(&self) -> f64

How many seconds of audio the recording has captured.

pub fn is_full(&self) -> bool

Whether the recording reached its limit and stopped capturing.

A recording that has seen no fill yet is never full: its limit is not known until the format is.

pub fn stop(self, world: &mut World) -> Option<RecordedAudio>

Stop recording, despawn the source and take the captured samples.

A recording that saw no fill has no format to write, so there is nothing to hand back.

pub fn cancel(self, world: &mut World)

Stop recording, despawn the source and discard the captured samples.

Trait Implementations

impl Clone for RecordingHandle

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RecordingHandle

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.