Struct FrameStream 

pub struct FrameStream { /* private fields */ }

A stream of decoded video frames produced by a background decode thread.

Implements tokio_stream::Stream so it can be used with StreamExt combinators such as next(), map(), filter(), and take().

The background decoder is spawned via tokio::task::spawn_blocking and communicates through a bounded mpsc channel. Dropping the stream closes the channel, which causes the background thread to stop at the next frame boundary.

Example

use tokio_stream::StreamExt;

use unbundle::{ExtractOptions, FrameRange, MediaFile, UnbundleError};

let mut unbundler = MediaFile::open("input.mp4")?;
let mut stream = unbundler
    .video()
    .frame_stream(FrameRange::Interval(30), ExtractOptions::new())?;

while let Some(result) = stream.next().await {
    let (frame_number, image) = result?;
    println!("Got frame {frame_number}");
}

Trait Implementations

impl Stream for FrameStream

type Item = Result<(u64, DynamicImage), UnbundleError>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.