Struct OutputSession

pub struct OutputSession { /* private fields */ }

One output process for each uninterrupted run of a PCM format.

A natural track transition reuses the process. The caller should call abort when seeking or skipping, because ffplay may have queued samples from the old track. finish closes its input and waits for the last audio to drain. Dropping an active session stops its child process.

Implementations

impl OutputSession

pub fn new() -> Self

Use ffplay from the local executable search path.

pub fn format(&self) -> Option<OutputFormat>

The format currently accepted by the process, if any.

pub fn process_id(&self) -> Option<u32>

Process identifier used by the terminal transport controls.

pub fn prepare( &mut self, format: OutputFormat, ) -> Result<OutputChange, OutputError>

Reuse matching output or drain and reopen it for a new format.

pub fn close_input(&mut self)

Close the input while allowing the process to play queued samples.

pub fn poll_finished(&mut self) -> Result<bool, OutputError>

Return true after a successful child exit, or an error for failure.

pub fn finish(&mut self) -> Result<(), OutputError>

Close the input and wait for the output process to drain normally.

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

Discard queued output and stop the process after a transport change.

Trait Implementations

impl Default for OutputSession

fn default() -> Self

Returns the “default value” for a type.

impl Drop for OutputSession

fn drop(&mut self)

Executes the destructor for this type.

impl Write for OutputSession

fn write(&mut self, bytes: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.