Struct Player 

pub struct Player { /* private fields */ }

A playing file. Lives on the thread that draws it; dropping it stops the workers and ends its AudioOut.

Implementations

impl Player

pub fn open(path: &Path, audio: bool) -> Result<(Player, Option<AudioOut>)>

Opens path paused at the start. With audio, the file’s sound is decoded and the returned AudioOut must be played for the clock to run; without, it plays silent on the wall clock.

pub fn open_preview( path: &Path, audio: bool, max_side: u32, ) -> Result<(Player, Option<AudioOut>)>

As Player::open, for a small preview: pictures fit max_side on their long side, and dropping it never waits for the workers, which stop after the packet they are on. Opening reads and probes the file, so it may take a moment; call it off the UI thread (a Player and its AudioOut can be sent to the thread that draws).

pub fn info(&self) -> &Info

pub fn is_ready(&self) -> bool

The first picture is decoded (or there is none to wait for).

pub fn play(&mut self)

Plays at the current speed; from the end, plays from the start.

pub fn pause(&mut self)

pub fn toggle(&mut self)

pub fn is_playing(&self) -> bool

pub fn seek(&mut self, secs: f64)

Jumps to secs (clamped to the clip): the keyframe before it is found and decoded forward to the frame at secs.

pub fn step(&mut self, frames: i32)

Moves frames frames forwards (or backwards when negative) and pauses. Forward steps take the next decoded frames; backward steps seek to the earlier frame.

pub fn rate(&self) -> f32

pub fn set_rate(&mut self, rate: f32)

Changes the speed. The sound is stretched to match and keeps its pitch, as preservesPitch does in Eagle’s <video>, so the queued sound is decoded again from here.

pub fn set_volume(&mut self, volume: f32)

0..=1.

pub fn set_muted(&mut self, muted: bool)

Muting stops decoding the sound and runs the picture on the wall clock; unmuting decodes it again from the playhead.

pub fn set_looping(&mut self, looping: bool)

pub fn looping(&self) -> bool

pub fn current_time(&self) -> f64

The playhead in seconds.

pub fn tick(&mut self)

Call every frame: at the end of the clip, starts again from the top when looping, or stops.

pub fn frame(&mut self) -> Option<Frame>

The frame due now, if it differs from the last one handed out.

pub fn current_frame(&self) -> Result<Frame>

The picture at the playhead at the clip’s full size, decoded afresh so playback is not disturbed.

Trait Implementations

impl Drop for Player

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.