Skip to main content

AudioEncoderBuilder

Struct AudioEncoderBuilder 

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

Builder for constructing an AudioEncoder.

Created by calling AudioEncoder::create(). Call build() to open the output file and prepare for encoding.

§Examples

use ff_encode::{AudioEncoder, AudioCodec};

let mut encoder = AudioEncoder::create("output.m4a")
    .audio(48000, 2)
    .audio_codec(AudioCodec::Aac)
    .build()?;

Implementations§

Source§

impl AudioEncoderBuilder

Source

pub fn audio(self, sample_rate: u32, channels: u32) -> Self

Configure audio stream settings.

Source

pub fn audio_codec(self, codec: AudioCodec) -> Self

Set audio codec.

Source

pub fn audio_bitrate(self, bitrate: u64) -> Self

Set audio bitrate in bits per second.

Source

pub fn container(self, container: Container) -> Self

Set container format explicitly (usually auto-detected from file extension).

Source

pub fn build(self) -> Result<AudioEncoder, EncodeError>

Validate builder state and open the output file.

§Errors

Returns EncodeError if configuration is invalid, the output path cannot be created, or no suitable encoder is found.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.