Skip to main content

AudioEncoder

Struct AudioEncoder 

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

Encodes audio frames to a file using FFmpeg.

§Construction

Use AudioEncoder::create() to get an AudioEncoderBuilder, then call AudioEncoderBuilder::build():

use ff_encode::{AudioEncoder, AudioCodec};

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

Implementations§

Source§

impl AudioEncoder

Source

pub fn create<P: AsRef<Path>>(path: P) -> AudioEncoderBuilder

Creates a builder for the specified output file path.

This method is infallible. Validation occurs when AudioEncoderBuilder::build() is called.

Source

pub fn actual_codec(&self) -> &str

Returns the name of the FFmpeg encoder actually used (e.g. "aac", "libopus").

Source

pub fn push(&mut self, frame: &AudioFrame) -> Result<(), EncodeError>

Pushes an audio frame for encoding.

§Errors

Returns EncodeError if encoding fails or the encoder is not initialised.

Source

pub fn finish(self) -> Result<(), EncodeError>

Flushes remaining frames and writes the file trailer.

§Errors

Returns EncodeError if finalising fails.

Trait Implementations§

Source§

impl Drop for AudioEncoder

Source§

fn drop(&mut self)

Executes the destructor for this 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> 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.