Struct opus::Encoder

pub struct Encoder { /* private fields */ }

An Opus encoder with associated state.

Implementations

impl Encoder

pub fn new(
    sample_rate: u32,
    channels: Channels,
    mode: Application
) -> Result<Encoder>

Create and initialize an encoder.

pub fn encode(&mut self, input: &[i16], output: &mut [u8]) -> Result<usize>

Encode an Opus frame.

pub fn encode_float(
    &mut self,
    input: &[f32],
    output: &mut [u8]
) -> Result<usize>

Encode an Opus frame from floating point input.

pub fn encode_vec(&mut self, input: &[i16], max_size: usize) -> Result<Vec<u8>>

Encode an Opus frame to a new buffer.

pub fn encode_vec_float(
    &mut self,
    input: &[f32],
    max_size: usize
) -> Result<Vec<u8>>

Encode an Opus frame from floating point input to a new buffer.

pub fn reset_state(&mut self) -> Result<()>

Reset the codec state to be equivalent to a freshly initialized state.

pub fn get_final_range(&mut self) -> Result<u32>

Get the final range of the codec’s entropy coder.

pub fn get_bandwidth(&mut self) -> Result<Bandwidth>

Get the encoder’s configured bandpass.

pub fn get_sample_rate(&mut self) -> Result<u32>

Get the samping rate the encoder was intialized with.

pub fn set_bitrate(&mut self, value: Bitrate) -> Result<()>

Set the encoder’s bitrate.

pub fn get_bitrate(&mut self) -> Result<Bitrate>

Get the encoder’s bitrate.

pub fn set_vbr(&mut self, vbr: bool) -> Result<()>

Enable or disable variable bitrate.

pub fn get_vbr(&mut self) -> Result<bool>

Determine if variable bitrate is enabled.

pub fn set_vbr_constraint(&mut self, vbr: bool) -> Result<()>

Enable or disable constrained VBR.

pub fn get_vbr_constraint(&mut self) -> Result<bool>

Determine if constrained VBR is enabled.

pub fn set_inband_fec(&mut self, value: bool) -> Result<()>

Configures the encoder’s use of inband forward error correction (FEC).

pub fn get_inband_fec(&mut self) -> Result<bool>

Gets encoder’s configured use of inband forward error correction.

pub fn set_packet_loss_perc(&mut self, value: i32) -> Result<()>

Sets the encoder’s expected packet loss percentage.

pub fn get_packet_loss_perc(&mut self) -> Result<i32>

Gets the encoder’s expected packet loss percentage.

pub fn get_lookahead(&mut self) -> Result<i32>

Gets the total samples of delay added by the entire codec.

Trait Implementations

impl Debug for Encoder

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

Formats the value using the given formatter.

impl Drop for Encoder

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Encoder