Struct Project 

pub struct Project {
    pub schema_version: u32,
    pub id: ProjectId,
    pub name: String,
    pub settings: ProjectSettings,
    pub sources: Vec<MediaSource>,
    pub effect_resources: Vec<EffectResource>,
    pub compositions: Vec<Composition>,
    pub timeline: Timeline,
    pub audio: MasterAudio,
}

A complete serializable project document.

Fields

schema_version: u32

Version used to serialize this document.

id: ProjectId

Stable identity of this project.

name: String

Human-readable project name. It has no semantic meaning.

settings: ProjectSettings

Output-wide timeline settings.

sources: Vec<MediaSource>

Media resources referenced by clips.

effect_resources: Vec<EffectResource>

Non-media resources referenced by effect invocations.

compositions: Vec<Composition>

Composition graphs that clips show.

timeline: Timeline

Ordered visual and audio tracks.

audio: MasterAudio

Master bus applied to the summed track audio.

Implementations

impl Project

pub fn audio_effect_load(&self) -> AudioEffectLoad

Measures the most audio effect state this project holds at once, which validation bounds by crate::MAX_AUDIO_EFFECTS and crate::MAX_AUDIO_DELAY_MS. It sorts the clips’ intervals once: O(n log n) in the clips with effects.

impl Project

pub fn lint(&self) -> Vec<LintIssue>

Diagnostics that do not stop the project rendering, in a fixed order: unused sources, then shapes generators (sources’, then composition nodes’), then HDR sources, then tracks in order and each track’s clips, transitions, and cues in order, then compositions’ nodes in order, then generated sources’ trees in order.

impl Project

pub fn from_json(json: &str) -> Result<Self, ProjectLoadError>

Parses and validates a serialized project document.

The document’s schema_version is read first: a document of another version reports ModelError::UnsupportedSchemaVersion rather than whatever shape difference the versions have.

Errors

Returns ProjectLoadError for malformed, unsupported, or structurally invalid documents.

pub fn used_sources(&self) -> Vec<&MediaSource>

The sources a render of this project can read, in source order: each clip’s own, and those the media nodes its compositions draw read.

A clip’s compositions are the one it names and, for a composition source, the source’s when the one it names draws the clip (crate::CompositionReads::draws_clip). From a composition’s output the walk follows the inputs drawing a node reads (crate::CompositionReads::needed_inputs, as the renderer plans them), into the composition a group node draws and the one a composition source a media node reads shows. So an unconnected node, a composition nothing shows, the inputs a bypassed node passes over, and the group ports a group’s composition never reads read nothing. An unconnected input the output needs fails those frames; what the connected inputs read is still used.

pub fn hdr_sources(&self) -> Vec<&SourceId>

Returns the HDR sources, which the project tone-maps or refuses as its ColorPipeline says: those whose color is PQ or HLG, or declared HDR, as the renderer decides (alpha2_media::ColorMetadata::is_hdr).

pub fn draws_text(&self) -> bool

Whether anything in the project may draw text: a caption track, or a text or layout generator in a source or a composition. A host whose project draws none needs no fonts and prepares no text. A layout is resolved by the text host, with or without text.

pub fn new( id: ProjectId, name: impl Into<String>, settings: ProjectSettings, ) -> Self

Creates an empty project using the current schema version.

pub fn validate(&self) -> Result<(), ModelError>

Checks structural invariants without performing media I/O.

Errors

Returns the first invalid document invariant encountered.

Trait Implementations

impl Clone for Project

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 Project

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Project

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Project

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Project

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Project