Enum FrameSyncAudioRequest 

pub enum FrameSyncAudioRequest {
    QueryInput,
    Capture {
        sample_rate: Option<NonZeroI32>,
        channels: Option<NonZeroI32>,
        samples: NonZeroI32,
    },
}

Explicit audio operation for FrameSync::capture_audio.

FrameSync audio has two distinct SDK modes:

• QueryInput asks the SDK for the current input audio format without requesting samples.
• Capture asks the SDK for a positive number of samples, optionally using the source sample rate and/or source channel count.

None for sample_rate or channels maps to the SDK’s 0 value, meaning “use the current source value”. The samples field must be positive.

Variants

QueryInput

Query the current incoming audio format without requesting sample data.

Capture

Capture audio samples with optional source-derived output parameters.

Fields

sample_rate: Option<NonZeroI32>

Requested output sample rate. None uses the current source rate.

channels: Option<NonZeroI32>

Requested output channel count. None uses the current source count.

samples: NonZeroI32

Number of samples to capture per channel.

Implementations

impl FrameSyncAudioRequest

pub fn capture(samples: NonZeroI32) -> Self

Capture samples using the source sample rate and source channel count.

pub fn capture_with( sample_rate: Option<NonZeroI32>, channels: Option<NonZeroI32>, samples: NonZeroI32, ) -> Self

Capture samples with explicit optional sample-rate and channel requests.

Trait Implementations

impl Clone for FrameSyncAudioRequest

fn clone(&self) -> FrameSyncAudioRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameSyncAudioRequest

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

Formats the value using the given formatter.

impl PartialEq for FrameSyncAudioRequest

fn eq(&self, other: &FrameSyncAudioRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for FrameSyncAudioRequest

impl Eq for FrameSyncAudioRequest

impl StructuralPartialEq for FrameSyncAudioRequest