Skip to main content

TimelinePlayer

Struct TimelinePlayer 

Source
pub struct TimelinePlayer;
Expand description

Thin builder for a (TimelineRunner, PlayerHandle) pair backed by a Timeline.

Playback is limited to the primary video track (video_tracks[0]). When any clip carries an audio stream, an AudioMixer is created and audio is mixed into the stereo output from PlayerHandle::pop_audio_samples.

§Example

use ff_pipeline::{Timeline, Clip};
use ff_preview::{TimelinePlayer, RgbaSink};
use std::time::Duration;

let timeline = Timeline::builder()
    .canvas(1920, 1080)
    .frame_rate(30.0)
    .video_track(vec![
        Clip::new("intro.mp4").trim(Duration::ZERO, Duration::from_secs(5)),
    ])
    .build()?;

let (mut runner, handle) = TimelinePlayer::open(&timeline)?;
runner.set_sink(Box::new(RgbaSink::new()));
std::thread::spawn(move || { let _ = runner.run(); });
handle.play();

Implementations§

Source§

impl TimelinePlayer

Source

pub fn open( timeline: &Timeline, ) -> Result<(TimelineRunner, PlayerHandle), PreviewError>

Open timeline for real-time preview playback.

Probes every clip’s source file to determine effective durations and audio availability, opens a DecodeBuffer for each clip on the primary video track, and seeks each buffer to its configured in_point.

When any clip carries an audio stream an AudioMixer is created and the first audio-bearing clip’s decode thread is started immediately.

§Errors

Returns PreviewError when:

  • timeline has no video tracks or the primary track is empty,
  • a clip source file cannot be found or opened,
  • a clip cannot be probed for duration.

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, 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.