Skip to main content

EditorState

Struct EditorState 

Source
pub struct EditorState { /* private fields */ }
Expand description

What is being edited, kept by the app so that it can be read and saved. All the edits the editor can make are methods here too, for scripts and tests.

Implementations§

Source§

impl EditorState

Source

pub fn new(movie: Movie) -> Self

Starts editing movie, with whatever edits it already has.

Source

pub fn movie(&self) -> Movie

The film with the edits so far.

Source

pub fn undo(&self)

Takes the last edit back.

Source

pub fn redo(&self)

Puts back what Self::undo took.

Source

pub fn position_ms(&self) -> u64

Where the playhead is, in milliseconds of the timeline.

Source

pub fn seek(&self, ms: u64)

Moves the playhead.

Source

pub fn toggle_playing(&self)

Plays from the playhead, or pauses.

Source

pub fn split(&self)

Cuts the clip at the playhead in two.

Source

pub fn delete_selected(&self)

Deletes what is selected: a clip takes its time with it.

Source

pub fn select_clip(&self, index: usize)

Selects the clip at this place on the main track.

Source

pub fn select_overlay(&self, id: u64)

Selects an overlay.

Source

pub fn add_overlay(&self, kind: OverlayKind) -> u64

Adds an effect at the playhead and selects it.

Source

pub fn light_at_end(&self, region: Region, previous: Option<u64>) -> u64

Lights region for the last seconds of the film, replacing what previous lit, and says how to replace this one. It marks where a problem is.

Source

pub fn add_title(&self, title: &str)

Puts a title card at the playhead and selects it.

Source

pub fn add_chapter(&self, title: &str)

Starts a chapter at the playhead.

Source

pub fn set_speed(&self, speed: f32)

Changes how fast the selected clip plays.

Trait Implementations§

Source§

impl Clone for EditorState

Source§

fn clone(&self) -> EditorState

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for EditorState

Source§

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

Formats the value using the given formatter. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more