Struct ffmpeg_sidecar::command::FfmpegCommand

pub struct FfmpegCommand { /* private fields */ }

A wrapper around std::process::Command with some convenient preset argument sets and customization for ffmpeg specifically.

Implementations

impl FfmpegCommand

pub fn testsrc(&mut self) -> &mut Self

Generate a procedural test video. Equivalent to ffmpeg -i lavfi -f testsrc

FFmpeg testsrc filter documentation

pub fn rawvideo(&mut self) -> &mut Self

Preset for emitting raw decoded video frames on stdout. Equivalent to -f rawvideo -pix_fmt rgb24 -.

pub fn pipe_stdout(&mut self) -> &mut Self

Configure the ffmpeg command to produce output on stdout.

Synchronizes two changes:

1. Pass pipe:1 to the ffmpeg command (“output on stdout”)
2. Set the stdout field of the inner Command to Stdio::piped()

pub fn arg<S: AsRef<OsStr>>(&mut self, arg: S) -> &mut Self

Adds an argument to pass to the program.

Identical to arg in std::process::Command.

pub fn args<I, S>(&mut self, args: I) -> &mut Selfwhere I: IntoIterator<Item = S>, S: AsRef<OsStr>,

Adds multiple arguments to pass to the program.

Identical to args in std::process::Command.

pub fn get_args(&self) -> CommandArgs<'_>

Returns an iterator of the arguments that will be passed to the program.

Identical to get_args in std::process::Command.

pub fn spawn(&mut self) -> Result<FfmpegChild>

Spawn the ffmpeg command as a child process, wrapping it in a FfmpegChild interface.

Identical to spawn in std::process::Command.

pub fn print_command(&mut self) -> &mut Self

Print a command that can be copy-pasted to run in the terminal. Requires &mut self so that it chains seamlessly with other methods in the interface.

pub fn new() -> Self

pub fn new_with_exe<S: AsRef<OsStr>>(exe: S) -> Self

pub fn as_inner(&mut self) -> &Command

Escape hatch to access the inner Command.

pub fn as_inner_mut(&mut self) -> &mut Command

Escape hatch to mutably access the inner Command.

Trait Implementations

impl Debug for FfmpegCommand

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

Format the program and arguments of a Command for display. Any non-utf8 data is lossily converted using the utf8 replacement character.

impl Default for FfmpegCommand

fn default() -> Self

Returns the “default value” for a type.

impl From<Command> for FfmpegCommand

fn from(inner: Command) -> Self

Convert a Command into a FfmpegCommand, making no guarantees about the validity of its configured arguments and stdio. For example, set_expected_loglevel() is not automatically applied, which can have unexpected effects on log parsing.

impl Into<Command> for FfmpegCommand

fn into(self) -> Command

Converts this type into the (usually inferred) input type.