Skip to main content

TimecodeScheduler

Struct TimecodeScheduler 

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

Frame-accurate timecode playback scheduler.

Maintains an internal frame counter and fires registered triggers when playback passes their target timecode.

Implementations§

Source§

impl TimecodeScheduler

Source

pub fn new(rate: FrameRate, drop_frame: bool) -> Self

Create a new scheduler, starting at 00:00:00:00.

Source

pub fn current_timecode(&self) -> Option<Timecode>

Current timecode.

Returns None only if the frame count is somehow invalid.

Source

pub fn seek(&mut self, tc: Timecode)

Seek to a specific timecode.

Source

pub fn advance_frames(&mut self, frames: u64) -> FiredTriggers

Advance by frames frames and return any fired triggers.

Source

pub fn register_trigger( &mut self, target: Timecode, label: impl Into<String>, one_shot: bool, ) -> TriggerId

Register a trigger at a target timecode.

Returns the TriggerId assigned.

Source

pub fn unregister_trigger(&mut self, id: TriggerId)

Remove a trigger.

Source

pub fn trigger_label(&self, id: TriggerId) -> Option<&str>

Get the label of a trigger.

Source

pub fn trigger_count(&self) -> usize

Number of registered triggers.

Source

pub fn reset(&mut self)

Reset to 00:00:00:00.

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> 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§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.