Struct PipLayout

Source

pub struct PipLayout {
    pub id: PipId,
    pub base_clip: ClipId,
    pub pip_clip: ClipId,
    pub start: i64,
    pub end: i64,
    pub keyframes: Vec<PipKeyframe>,
    pub default_state: PipState,
    pub maintain_aspect: bool,
}

Expand description

A picture-in-picture composition that places a secondary video clip (pip_clip) over a primary clip (base_clip).

The secondary clip’s geometry is driven by a set of keyframes. If there are no keyframes a static default state is used.

Fields§

§id: PipId

Unique identifier.

§base_clip: ClipId

The primary (background) clip.

§pip_clip: ClipId

The secondary (overlay) clip.

§start: i64

Timeline start (inclusive).

§end: i64

Timeline end (exclusive).

§keyframes: Vec<PipKeyframe>

Keyframe list, sorted by time.

§default_state: PipState

Default / static state used when no keyframes are defined.

§maintain_aspect: bool

Whether to maintain the PiP clip’s aspect ratio when scaling.

Implementations§

Source §

impl PipLayout

Source

pub fn new( id: PipId, base_clip: ClipId, pip_clip: ClipId, start: i64, end: i64, ) -> Self

Create a new PiP layout with the bottom-right preset.

Source

pub fn add_keyframe(&mut self, kf: PipKeyframe)

Add a keyframe (sorted insertion).

Source

pub fn remove_keyframes_at(&mut self, time: i64)

Remove all keyframes at the given time.

Source

pub fn state_at(&self, time: i64) -> PipState

Evaluate the PiP state at time by linearly interpolating keyframes.

If there are no keyframes the default_state is returned. If time is before the first keyframe the first keyframe’s state is returned; if after the last, the last is returned.

Source

pub fn is_active_at(&self, time: i64) -> bool

Returns true if the layout is active at time.

Source

pub fn keyframe_count(&self) -> usize

Number of keyframes.

Trait Implementations§

Source §

impl Clone for PipLayout

Source §

fn clone(&self) -> PipLayout

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 PipLayout

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for PipLayout

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

Source §

impl<T> Downcast<T> for T

Source §

fn downcast(&self) -> &T

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §