Struct sndfile::WriteOptions

pub struct WriteOptions { /* private fields */ }

Options for writing audio files.

Implementations

impl WriteOptions

pub fn new(
    major_format: MajorFormat,
    subtype_format: SubtypeFormat,
    endian: Endian,
    samplerate: usize,
    channels: usize
) -> Self

Create new WriteOptions.

• major_format: Audio container format, e.g., SubtypeFormat::WAV, SubtypeFormat::FLAC, etc
• subtype_format: Audio encoding format, e.g., SubtypeFormat::PCM_S16, SubtypeFormat::VORBIS, etc
• endian: Usually Endian::File
• samplerate: A positive number
• channels: A positive number

pub fn validate(self) -> Option<Self>

This function allows the caller to check if a set of parameters in the WriteOptions is valid.

Returns Some(Self) if the parameters are valid and None otherwise.

Trait Implementations

impl Debug for WriteOptions

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

Formats the value using the given formatter.