Struct creek_encode_wav::WavEncoder

pub struct WavEncoder<B: WavBitDepth + 'static> { /* private fields */ }

Trait Implementations

impl<B: WavBitDepth + 'static> Encoder for WavEncoder<B>

type T = <B as WavBitDepth>::T

The data type of a single sample. (i.e. f32)

type AdditionalOpts = ()

Any additional options for creating a file with this encoder.

type FileParams = Params

Any additional information on the file.

type OpenError = WavOpenError

The error type while opening the file.

type FatalError = WavFatalError

The error type when a fatal error occurs.

const DEFAULT_BLOCK_SIZE: usize = 32_768usize

The default number of frames in a write block.

const DEFAULT_NUM_WRITE_BLOCKS: usize = 8usize

The default number of write blocks. This must be sufficiently large to ensure there are enough write blocks for the client in the worst case write latency scenerio.

fn new( path: PathBuf, num_channels: u16, sample_rate: u32, block_size: usize, _num_write_blocks: usize, _additional_opts: Self::AdditionalOpts ) -> Result<(Self, FileInfo<Self::FileParams>), Self::OpenError>

Open the file for writing.

fn encode( &mut self, write_block: &WriteBlock<Self::T> ) -> Result<WriteStatus, Self::FatalError>

Write a block of data to the file.

fn finish_file(&mut self) -> Result<(), Self::FatalError>

Finish up the file and then close it.

fn discard_file(&mut self) -> Result<(), Self::FatalError>

Delete all created files. Do not start over.

fn discard_and_restart(&mut self) -> Result<(), Self::FatalError>

Delete all created files and start over from the beginning.