Struct VSAudioFormat

#[repr(C)]
pub struct VSAudioFormat {
    pub sample_type: VSSampleType,
    pub bits_per_sample: c_int,
    pub bytes_per_sample: c_int,
    pub num_channels: c_int,
    pub channel_layout: u64,
}

Describes the format of a clip.

Use queryAudioFormat() to fill it in with proper error checking. Manually filling out the struct is allowed but discouraged since illegal combinations of values will cause undefined behavior.

Fields

sample_type: VSSampleType

See VSSampleType.

bits_per_sample: c_int

Number of significant bits.

bytes_per_sample: c_int

Number of bytes needed for a sample. This is always a power of 2 and the smallest possible that can fit the number of bits used per sample, implicit from VSAudioFormat::channel_layout.

num_channels: c_int

Number of audio channels, implicit from VSAudioFormat::bits_per_sample

channel_layout: u64

A bitmask representing the channels present using the constants in 1 left shifted by the constants in VSAudioChannels.

Trait Implementations

impl Clone for VSAudioFormat

fn clone(&self) -> VSAudioFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VSAudioFormat

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

Formats the value using the given formatter.

impl Hash for VSAudioFormat

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for VSAudioFormat

fn eq(&self, other: &VSAudioFormat) -> 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 Eq for VSAudioFormat

impl StructuralPartialEq for VSAudioFormat