Skip to main content

NativeAvEncodeSink

Struct NativeAvEncodeSink 

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

Audio/video sink that encodes and interleaves through the linked FFmpeg libraries without requiring command-line programs on the host. Video frames and audio blocks must be submitted in nondecreasing start-timestamp order; ready packets are muxed incrementally instead of retained for the full file.

Implementations§

Source§

impl NativeAvEncodeSink

Source

pub fn create( path: impl AsRef<Path>, config: AvEncodeConfig, ) -> Result<Self, EncodeError>

Creates linked-library video, audio, and container encoders without touching the final destination.

§Errors

Returns an encoder error for invalid configuration, paths, or stale component outputs.

Source

pub fn create_with_video_encoder( path: impl AsRef<Path>, config: AvEncodeConfig, encoder_name: &str, ) -> Result<Self, EncodeError>

Creates the requested concrete video encoder by its FFmpeg short name.

§Errors

Returns an encoder error when the name is unavailable, implements a different codec, or the remaining configuration is invalid.

Source

pub fn create_with_video_encoder_threads( path: impl AsRef<Path>, config: AvEncodeConfig, encoder_name: Option<&str>, software_threads: &dyn Fn() -> i64, ) -> Result<Self, EncodeError>

Creates an encoder whose software thread count the caller decides.

software_threads is asked, at most once, only when a candidate that runs on the CPU is opened: the caller sizes the rest of its work from NativeVideoEncoderSelection afterwards, so a hardware candidate that fails to open and falls through to software still gets a software encoder’s share of the CPU.

encoder_name is the concrete encoder the caller pinned. None lets the candidates for the codec be tried in preference order, which is what makes the open-time fallback reachable.

§Errors

Returns an encoder error when no candidate opens, or for invalid configuration, paths, codecs, or muxers.

Source

pub fn stage_timings(&self) -> EncodeStageTimings

Where this sink’s time has gone so far, both threads together.

Source

pub fn video_selection(&self) -> &NativeVideoEncoderSelection

The video encoder this sink opened, and the candidates it passed over.

Source

pub fn write_prepared_video( &mut self, frame: &mut Yuv420pFrameBuffer, pts: MediaTime, ) -> Result<(), EncodeError>

Encodes a frame the caller already packed, without copying it.

See crate::NativeVideoEncodeSink::write_prepared_video; this is the same handover for the muxed audio/video sink.

§Errors

Returns an error for a frame sized differently from this encoder, a non-monotonic timestamp, or a codec failure.

Trait Implementations§

Source§

impl Drop for NativeAvEncodeSink

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl EncodeSink for NativeAvEncodeSink

Source§

fn write( &mut self, event: EncodeEvent, cancel: &CancelToken, ) -> Result<(), EncodeError>

Queues one timestamped media item. Read more
Source§

fn finish(&mut self, cancel: &CancelToken) -> Result<(), EncodeError>

Drains encoder delay, interleaves remaining packets, and writes the trailer. Read more
Source§

fn abort(&mut self) -> Result<(), EncodeError>

Aborts and applies the adapter’s partial-output cleanup policy. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,