Skip to main content

MtmdVideoParams

Struct MtmdVideoParams 

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

Parameters controlling how a MtmdVideo stream is opened and sampled.

Obtain a default-initialised instance via MtmdVideoParams::default() (which mirrors mtmd_helper_video_init_params_default: ~4 fps, native ffmpeg/ffprobe from PATH, and a 5 s timestamp interval) and tweak it with the builder methods.

Implementations§

Source§

impl MtmdVideoParams

Source

pub fn fps_target(self, fps: f32) -> Self

Desired output frame rate. Values <= 0 mean “use the video’s native fps” (the default is ~4 fps).

Source

pub fn timestamp_interval_ms(self, ms: i64) -> Self

Interval, in milliseconds, between inserted timestamp text chunks (e.g. "[10m50.5s]"). Values <= 0 disable timestamps (default 5000 ms).

Source

pub fn ffmpeg_bin_dir(self, dir: Option<&str>) -> Result<Self>

Directory containing the ffmpeg/ffprobe binaries. Pass None to search PATH (the default).

§Errors

Returns an error if dir contains an interior NUL byte.

Trait Implementations§

Source§

impl Debug for MtmdVideoParams

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MtmdVideoParams

Source§

fn default() -> Self

Returns the “default value” for a 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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more