Struct MoviePlayer 

pub struct MoviePlayer { /* private fields */ }

Plays a Movie as an interactive manual.

Whoever watches can pause, drag the position, jump to a chapter and click the marks on the film. With “stop at each step” on, which is how it starts, the film holds at each Recorder::guide until the marked spot is clicked, so people follow it at their own pace. It sleeps while paused.

Cloning a film is cheap, since the film itself is shared:

use ravenrs_movie::{Movie, MoviePlayer};

let movie = Movie::from_bytes(&std::fs::read("manual.ravenmovie").unwrap_or_default())?;
let player = MoviePlayer::new(movie).width(960.0);

Implementations

impl MoviePlayer

pub fn new(movie: Movie) -> Self

A player for movie, stopped at its first picture.

pub fn next(self, title: impl Into<String>, open: impl Fn() + 'static) -> Self

What comes after this film, offered when it ends.

pub fn on_finished(self, finished: impl Fn() + 'static) -> Self

Runs when the film reaches its end.

pub fn max_film_height(self, height: f32) -> Self

The film is no taller than this, and the chapters take the width it leaves. For a player that should fit a window with its controls in view.

pub fn width(self, width: f32) -> Self

The width of the whole player, in logical pixels (960 by default). The film gets what its chapters leave.

pub fn narration(self, narration: Narration) -> Self

Recordings of what the film says, in place of the system’s voice. What is not among them is still said by the system’s voice.

pub fn logo(self, logo: LottieAnimation) -> Self

The app’s animated logo, played on the film’s opening and farewell cards.

pub fn labels(self, labels: MovieLabels) -> Self

The words it shows.

pub fn cue(self, cue: MovieCue) -> Self

Lets something outside the player open a moment of the film.

Trait Implementations

impl Debug for MoviePlayer

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

Formats the value using the given formatter.

impl View for MoviePlayer

fn build(&self, cx: &mut BuildCx<'_>) -> NodeId

Creates this view’s node for the current build.

fn type_name(&self) -> &'static str

The name the diagnostics panel shows this view’s cost under.