Struct Encoder 

pub struct Encoder { /* private fields */ }

Audio encoder over the PCM layout declared in Config::input.

Build one with Encoder::new, feed full PCM frames via encode, then pass the trailing partial frame to finish. Publish every packet either call returns and apply the terminal Finish::discard_padding when the container supports it.

Implementations

impl Encoder

pub fn new(config: &Config) -> Result<Self, Error>

Open an encoder for config.

pub fn config(&self) -> &Config

The encoder config, including the latest accepted runtime bitrate.

pub fn codec(&self) -> Codec

The codec this encoder emits. A Producer must be built for the same codec to publish its packets.

pub fn codec_rate(&self) -> u32

Sample rate the codec actually runs at, which is Config::sample_rate resolved.

pub fn codec_channels(&self) -> u32

Channel count the codec actually runs at, which is Config::channels resolved.

pub fn frame_size(&self) -> usize

Number of samples per channel the codec consumes per call to encode.

pub fn bitrate(&self) -> u64

Current target bitrate in bits per second.

pub fn set_bitrate(&mut self, bitrate: u64) -> Result<(), Error>

Retune the live Opus encoder to bitrate bits per second.

pub fn encode(&mut self, pcm: &[f32]) -> Result<Bytes, Error>

Encode one frame of interleaved f32 PCM at codec_rate.

pcm.len() must equal frame_size() * codec_channels(). The Producer handles format conversion and resampling before calling this; for direct use, the caller does the same.

pub fn finish(self, pcm: &[f32]) -> Result<Finish, Error>

Finish encoding, zero-padding pcm as the final partial frame and returning every packet needed to drain codec lookahead.

pcm is interleaved at codec_rate, may be empty, and must contain at most one frame. Silence added here only drains audio already supplied; Finish::discard_padding reports how much of the decoded tail is artificial and must not count as source duration. Consuming the encoder prevents encoding across the artificial terminal padding.

pub fn catalog(&self) -> AudioConfig

hang catalog entry describing this encoder’s output stream.