Struct EngineProject 

pub struct EngineProject { /* private fields */ }

An immutable project snapshot and its reusable evaluation index.

Implementations

impl EngineProject

pub fn new(project: Project) -> Result<Self, EvalError>

Validates a project and builds its active interval index.

Errors

Returns an evaluation error when the project is structurally invalid.

pub const fn generation(&self) -> u64

Which snapshot this is: unique among the snapshots this process has made, and shared by a snapshot’s clones, which hold the same project. An crate::Exporter renders only the snapshot it was made for.

pub const fn draws_text(&self) -> bool

Whether any frame may draw text (Project::draws_text), so a host must prepare it (crate::TextTextures::prepare_at).

pub fn evaluate(&self, time: MediaTime) -> Result<FrameDesc<'_>, EvalError>

Evaluates a deterministic frame description.

Errors

Returns an error if the immutable index and project disagree.

pub fn frame_needs(&self, time: MediaTime) -> Result<Vec<FrameNeed>, EvalError>

Returns the host frames needed at a timeline timestamp.

Errors

Returns an error if the immutable index and project disagree.

pub fn evaluate_audio( &self, range: TimeRange, ) -> Result<AudioSpanDesc<'_>, EvalError>

Evaluates every audio clip overlapping a half-open timeline span.

Errors

Returns an error if the immutable index and project disagree.

pub fn evaluate_audio_in<'s>( &self, range: TimeRange, scratch: &'s mut AudioSpanScratch, ) -> Result<AudioSpan<'_, 's>, EvalError>

Evaluates the same clips as Self::evaluate_audio into reusable memory, allocating nothing once scratch has grown to the span.

Errors

Returns an error if the immutable index and project disagree.

pub fn timeline_range(&self) -> Option<TimeRange>

Returns the smallest interval holding everything the timeline shows, caption cues included (alpha2_model::Timeline::extent).

pub fn effects(&self) -> Vec<(&str, u32)>

Every effect the project can draw, by id and version, each once in order: those of the compositions its clips show or draw as their source, and its transitions’. A composition that cannot draw its output is reported when a frame shows it.

pub fn check_effects(&self, renderer: &Renderer) -> Result<(), EngineError>

Checks that renderer can draw every effect the project uses (Self::effects).

Errors

Returns crate::EngineError::UnregisteredEffect naming the first one it cannot.

pub fn project(&self) -> &Project

Returns the immutable project document.

Trait Implementations

impl Clone for EngineProject

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EngineProject

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

Formats the value using the given formatter.