Struct OggVorbisEncoderParams

pub struct OggVorbisEncoderParams {
    pub mode: OggVorbisMode,
    pub channels: u16,
    pub sample_rate: u32,
    pub stream_serial: Option<i32>,
    pub bitrate: Option<OggVorbisBitrateStrategy>,
    pub minimum_page_data_size: Option<u16>,
}

• OggVorbis encoder parameters, NOTE: Most of the comments or documents were copied from vorbis_rs

Fields

mode: OggVorbisMode

OggVorbis encoder mode

channels: u16

Num channels

sample_rate: u32

Sample rate

stream_serial: Option<i32>

The serials for the generated OggVorbis streams will be randomly generated, as dictated by the Ogg specification. If this behavior is not desirable, set this field to Some(your_serial_number).

bitrate: Option<OggVorbisBitrateStrategy>

OggVorbis bitrate strategy represents a bitrate management strategy that a OggVorbis encoder can use.

minimum_page_data_size: Option<u16>

• Specifies the minimum size of OggVorbis stream data to put into each Ogg page, except for some header pages,
• which have to be cut short to conform to the OggVorbis specification.
• This value controls the tradeoff between Ogg encapsulation overhead and ease of seeking and packet loss concealment.
• By default, it is set to None, which lets the encoder decide.

Implementations

impl OggVorbisEncoderParams

pub fn create_vorbis_builder<W>( &self, writer: W, ) -> Result<VorbisEncoderBuilder<W>, AudioWriteError>

where W: Write,

pub fn get_bitrate(&self) -> u32

Trait Implementations

impl Clone for OggVorbisEncoderParams

fn clone(&self) -> OggVorbisEncoderParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OggVorbisEncoderParams

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

Formats the value using the given formatter.

impl Default for OggVorbisEncoderParams

fn default() -> OggVorbisEncoderParams

Returns the “default value” for a type.

impl PartialEq for OggVorbisEncoderParams

fn eq(&self, other: &OggVorbisEncoderParams) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for OggVorbisEncoderParams

impl StructuralPartialEq for OggVorbisEncoderParams