Struct Settings 

#[non_exhaustive]
pub struct Settings {
    pub codec: Codec,
    pub sample_rate: u32,
    pub layout: Layout,
    pub bitrate: Option<Rate>,
    pub dtx: bool,
    pub frame_duration: Duration,
}

Audio codec settings shared by Encoder and Producer.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

codec: Codec

Output codec. Defaults to Codec::Opus.

sample_rate: u32

Sample rate accepted by the codec.

layout: Layout

Layout accepted by the codec.

bitrate: Option<Rate>

Bitrate in bits per second. None lets Opus pick. PCM requires None because its bitrate is fixed by the sample rate and channel count.

Rates too low for Opus to code anything at the chosen frame_duration are rejected. The floor is 1200 bps at the default 20 ms, rises for shorter frames, and is 2400 bps for frames of 10 ms and longer.

dtx: bool

Enable Opus discontinuous transmission during silence.

frame_duration: Duration

Encoded frame duration. Opus accepts 2.5 / 5 / 10 / 20 / 40 / 60 ms. PCM accepts any duration containing a whole number of samples.

Implementations

impl Settings

pub fn new(sample_rate: u32, layout: Layout) -> Self

Build default Opus settings for sample_rate and layout.

pub fn from_input(codec: Codec, input: &Input) -> Self

Derive concrete codec settings from source PCM.

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Settings

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

Formats the value using the given formatter.

impl Default for Settings

fn default() -> Self

Returns the “default value” for a type.