Skip to main content

OpusConfig

Struct OpusConfig 

Source
pub struct OpusConfig { /* private fields */ }
Expand description

Opus audio codec configuration.

Implementations§

Source§

impl OpusConfig

Source

pub fn new() -> Self

Creates a new Opus configuration.

Source

pub fn voice() -> Self

Voice/VOIP optimised preset.

Uses VOIP application mode, maximum complexity, VBR, and forward error correction — suitable for speech transmission over lossy networks.

Source

pub fn music() -> Self

Music streaming preset.

Uses Audio application mode, maximum complexity, VBR, and a 20 ms frame duration — optimal balance for music with transparent quality.

Source

pub fn fullband() -> Self

Full-band (20 Hz–20 kHz) audio preset.

Forces full-band mode with maximum complexity and VBR.

Source

pub fn application(self, app: OpusApplication) -> Self

Sets the application type.

Source

pub fn complexity(self, complexity: u8) -> Self

Sets the complexity (0-10).

Source

pub fn frame_duration(self, duration_ms: f32) -> Self

Sets the frame duration in milliseconds.

Source

pub fn vbr(self, enable: bool) -> Self

Enables variable bitrate.

Source

pub fn with_vbr(self, enabled: bool) -> Self

Enables or disables variable bitrate via builder pattern.

Source

pub fn with_constrained_vbr(self, enabled: bool) -> Self

Enables or disables constrained VBR mode.

Constrained VBR limits bitrate peaks while still allowing variation, giving better quality than strict CBR with bounded bitrate.

Source

pub fn with_dtx(self, enabled: bool) -> Self

Enables or disables Discontinuous Transmission (DTX).

DTX reduces bitrate during silence by sending comfort noise packets, useful for VOIP applications where silence is frequent.

Source

pub fn with_fec(self, enabled: bool) -> Self

Enables or disables in-band Forward Error Correction (FEC).

FEC adds redundant audio data that allows partial recovery from packet loss in VoIP scenarios. Increases bitrate slightly.

Source

pub fn with_packet_loss_perc(self, pct: u8) -> Self

Sets the expected packet loss percentage (0–100).

This hint guides the encoder in tuning FEC strength and bitrate distribution. Requires FEC to be enabled for full effect.

Source

pub fn build(self) -> CodecConfig

Converts to base codec config.

Trait Implementations§

Source§

impl Clone for OpusConfig

Source§

fn clone(&self) -> OpusConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OpusConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for OpusConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more