Struct Encoder

pub struct Encoder<'a> { /* private fields */ }

• The Encoder struct contains all of the encoder types and provides convenient functions that have generic type parameters.
• It just translates the API to the inner encoder API.

Implementations

impl<'a> Encoder<'a>

pub fn new<T>(encoder: T) -> Self

where T: EncoderToImpl + 'a,

pub fn get_channels(&self) -> u16

pub fn get_max_channels(&self) -> u16

pub fn begin_encoding(&mut self) -> Result<(), AudioWriteError>

pub fn new_fmt_chunk(&mut self) -> Result<FmtChunk, AudioWriteError>

pub fn get_bitrate(&self) -> u32

pub fn update_fmt_chunk( &self, fmt: &mut FmtChunk, ) -> Result<(), AudioWriteError>

pub fn finish(&mut self) -> Result<(), AudioWriteError>

pub fn write_interleaved_samples<S>( &mut self, samples: &[S], ) -> Result<(), AudioWriteError>

where S: SampleType,

• Write samples regardless of channels

pub fn write_frame<S>(&mut self, frame: &[S]) -> Result<(), AudioWriteError>

where S: SampleType,

• Write an audio frame, each frame contains one sample for all channels

pub fn write_frames<S>( &mut self, frames: &[Vec<S>], ) -> Result<(), AudioWriteError>

where S: SampleType,

• Write audio frames, each frame contains one sample for all channels

pub fn write_sample<S>(&mut self, mono: S) -> Result<(), AudioWriteError>

where S: SampleType,

• Write only one sample regardless of channels

pub fn write_mono<S>(&mut self, monos: S) -> Result<(), AudioWriteError>

where S: SampleType,

• Write a single channel of audio to the encoder

pub fn write_mono_channel<S>( &mut self, monos: &[S], ) -> Result<(), AudioWriteError>

where S: SampleType,

• Write a single channel of audio to the encoder

pub fn write_dual_mono<S>( &mut self, mono1: S, mono2: S, ) -> Result<(), AudioWriteError>

where S: SampleType,

• Write double samples of audio to the encoder

pub fn write_dual_monos<S>( &mut self, mono1: &[S], mono2: &[S], ) -> Result<(), AudioWriteError>

where S: SampleType,

• Write double channels of audio to the encoder

pub fn write_monos<S>( &mut self, monos: &[Vec<S>], ) -> Result<(), AudioWriteError>

where S: SampleType,

• Write multiple channels of audio to the encoder

pub fn write_stereo<S>(&mut self, stereo: (S, S)) -> Result<(), AudioWriteError>

where S: SampleType,

• Write only one stereo sample to the encoder

pub fn write_stereos<S>( &mut self, stereos: &[(S, S)], ) -> Result<(), AudioWriteError>

where S: SampleType,

• Write stereo samples to the encoder

Trait Implementations

impl<'a> Debug for Encoder<'a>

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

Formats the value using the given formatter.

impl Default for Encoder<'_>

fn default() -> Self

Returns the “default value” for a type.