Expand description
Versioned, host-independent project model for alpha2.
This crate describes intent only. It contains no decoder handles, GPU resources, filesystem paths, or application-specific types.
Structs§
- Audio
Effect Load - The most audio effect state a project holds at once.
- Audio
Properties - Per-clip audio presentation controls.
- Audio
Stream Shape - An audio stream’s channel count and sample rate.
- Caption
Cue - Text shown over one timeline interval.
- Captions
- What a caption track shows: its cues, in its style.
- Captions
From Words - Caption cues built from a
wordsdata set. - Clip
- A reference to a source over independent timeline and source ranges.
- Clip
Composition - A clip’s use of a
Composition, and how its time maps onto it. - Clip
Effect - One versioned effect invocation: a composition’s effect or transition node, or a timeline transition.
- ClipId
- A stable timeline-clip identifier.
- Clip
Transition - A two-input transition over the overlap of two visual clips.
- Color
Pipeline - How sources’ colors come into the working space.
- Composition
- An acyclic graph of image operations with one selected output.
- Composition
Control - A node setting a composition exposes to group nodes: an effect or transition parameter of one of its nodes.
- Composition
Id - A stable composition-graph identifier.
- Composition
Node - One image operation in a
Composition. - Composition
Reads - What each composition’s output reads: the group inputs and clip nodes reachable from its output, following group nodes into their compositions. A group node needs only the ports its composition reads, so unread ports may be left unconnected.
- Correction
Ref - A
similaritydata set applied to a clip’s own picture before its transform. - Cubic
Bezier - A CSS
cubic-bezier(x1, y1, x2, y2)timing curve. - Dash
- A dash pattern.
- Data
Binding - A value that follows a channel of a data set at render time: the
datavalue mode. - Data
Interval - One timed range;
start == endis an instant. - Data
Remap - A linear map from
inputtooutput, clamped tooutput. - Data
Samples - Samples on one time grid, stored by column.
- DataSet
- Values derived from media, anchored to a source or to the timeline.
- Data
SetId - A stable data-set identifier.
- Data
Word - One timed word.
- Domain
- An inclusive range of accepted values; an unbounded end is infinite.
- Ducking
- Sidechain ducking authored on the track that is attenuated.
- Effect
Param Spec - One declared parameter of a built-in definition.
- Effect
Resource - Host-resolved, non-media data consumed by one or more visual effects.
- Effect
Resource Id - A stable effect-resource identifier.
- Effect
Spec - A built-in effect or transition definition, without its shader.
- Ellipse
Geometry - The ellipse inscribed in a size, turned clockwise about its centre. Its outline starts at the top and runs clockwise.
- EqBand
- A single equalizer section stored independently from its DSP implementation.
- Font
Size Fit - The font sizes a text is fitted between, as fractions of the canvas’s shorter side.
- Gradient
Stop - One color of a gradient.
- Grid
Placement - Where a grid item lies on one axis, as CSS
grid_columnwrites it:2,"1 / 3","span 2","2 / span 3","auto". A missing end isauto. - Import
Notes - What an import read but could not keep, counted.
- Imported
Captions - Cues read from a subtitle file.
- Insets
- A length on each side of a box (padding or margin). Missing sides are 0.
- Keyframe
- One timestamped control value.
- Layout
Border - A border inside the border box, as wide on every side.
- Layout
Font Size Fit - The font sizes a layout text is fitted between, as a text style’s
crate::FontSizeFit, in layout sizes. Aminabovemaxwins. - Layout
Inset - Where an absolute box lies in its parent’s padding box. A missing side is auto; with
neither
leftnorright, the box keeps its flow position on that axis. - Layout
Issue - Where in a layout tree a problem lies, and what it is.
- Layout
Node - One box of a layout tree.
- Layout
Offset - A box’s offset after layout:
xright,ydown. - Layout
Shape - A box’s shapes, drawn as a shapes generator draws its items on a picture the size of the box’s content box. A shape box has no size of its own.
- Layout
Text Style - A box’s text style once inherited. Lengths are fractions of the picture’s shorter side.
- Limiter
- Final peak limiter placed at the end of the master bus.
- Line
Clamp - Lines past a clamp point are discarded, as CSS Overflow 4
line-clampdiscards them. - MadeBy
- Which extractor made a data set. Recorded for hosts; the engine never reads it.
- Made
ByPlugin - The plugin build that made a data set.
- Master
Audio - Project-wide master bus settings.
- Matte
- Another visual clip whose picture sets where this clip is visible.
- Media
Fingerprint - Evidence of a source’s media, each part recorded only when known.
- Media
Source - A host-resolved media resource.
- Merge
Layer - One layer of a
NodeOp::Merge. - NodeId
- A stable identifier of a node within one composition graph. It has no
/, which joins the IDs of the group and media nodes a step was drawn through. - Path
- One or more subpaths.
- Path
Geometry - A path, animated as one value.
- Path
Vertex - A path vertex and its tangents. The segment from
atobis the cubic Bezier througha.point,a.point + a.out_tangent,b.point + b.in_tangentandb.point; zero tangents make it straight. - Point
Keyframe - One keyframe of an
AnimatedPoint. - Polystar
Geometry - A regular polygon or star, its first point straight up from the centre before rotation, the rest clockwise.
- Project
- A complete serializable project document.
- Project
Id - A stable project identifier.
- Project
Settings - Output-wide settings independent of a renderer or encoder.
- Rectangle
Geometry - A rectangle about its centre, turned clockwise about it. Its outline starts at the top-right corner and runs clockwise.
- Rgb
- An opaque color as a color picker shows it: straight, sRGB-encoded components in
0..=1. - Rgba
- A straight (not premultiplied), sRGB-encoded color with alpha, each component in
0..=1. - RunTime
- A run’s time span.
- Shape
Issue - Where in a content tree a problem lies, and what it is.
- Shape
Mask - A shape that limits where a clip is visible.
- Shape
Transform - A group’s placement. In pixel space: translate by
position, rotate, scale, then translate by minusanchor, soanchorlands onposition. The default is identity. - Stream
Topology - The streams a media file carries.
- Stroke
Item - A stroke along geometry, centred on its outline.
- Subpath
- A run of vertices joined by cubic Bezier segments.
- Text
Animator - One animator: what it selects, and what it does to what it selects.
- Text
Animator Properties - What an animator does to each character, in proportion to its selection. A property left out does nothing.
- Text
Background - A box behind each line of text.
- TextRun
- A piece of a text that animators’ Class and Timing selectors can pick.
- Text
Shadow - A shadow of a text’s glyphs and strokes, behind them.
- Text
Stroke - A band around the glyphs and the strokes listed before it, drawn behind them.
- Text
Style - How text looks and where it lies, for caption cues or a text
crate::Generator. - Text
Style Patch - Changes to a
TextStyle. Each field set replaces the base’s whole value (lists are not merged); a field left out keeps the base’s. - Time
Scale - A positive rational rate of one time against another.
- Timeline
- Timeline tracks ordered from back to front for visual tracks.
- Track
- A homogeneous visual or audio timeline lane.
- Track
Audio - Per-track audio bus controls.
- TrackId
- A stable timeline-track identifier.
- Track
List - A grid track list as CSS writes it:
"1fr 2fr 120px","repeat(3, minmax(100px, 1fr))","repeat(auto-fill, 160px)". Named lines are not supported. - Trim
Item - Keeps a span of geometry’s length.
- Vec2
- A two-dimensional value in normalized output coordinates.
- Video
Stream Shape - A video stream’s displayed size and frame rate.
- Visual
Properties - Resolution-independent visual presentation controls for a clip.
Enums§
- Align
Content - Where the lines of a wrapping flex container, or a grid’s rows, lie across the container.
- Align
Items - Where children lie across a flex container’s main axis, or in their grid areas.
- Animated
- A value that is constant, controlled by sorted keyframes, or following a data set.
- Animated
Point - A position that can move along curves between its keyframes.
- Audio
Effect - A serializable single-input audio effect applied to a clip or track bus.
- Binding
Problem - What is wrong with a
DataBinding, aCorrectionRefor aCaptionsFromWords. - Blend
Space - The color space in which blend modes are evaluated.
- Block
Ellipsis - What ends a line that a clamp cuts, as CSS
block-ellipsis. - Cache
Intent - Whether a runtime may keep and reuse a clip’s rendered picture.
- Caption
Import Error - Why a file is not a subtitle file at all.
- Clip
Blend Mode - Blend mode, from W3C Compositing and Blending Level 1 (CSS
mix-blend-mode) with the specification’s formulas, plusplus-lighterfrom Level 2. - Clip
Reference - What a reference to a clip is.
- Data
Anchor - The clock a data set’s times are on.
- Data
Interpolation - How a sampled data set reads between its samples.
- Data
Kind - What a data set holds; each kind has a consumer in the engine.
- Data
Owner - What holds the value a
ModelError::InvalidDataBindingnames. - Data
Problem - What is wrong with a data set.
- Data
Space - Where a bound point is read.
- Data
Values - The values of a data set, by kind.
- DataVia
- The reader whose clock maps time onto a source-anchored data set.
- Display
- How a box lays its children out.
- Easing
- A timing curve from linear progress to eased progress, without a hold.
- Effect
Kind - What an effect definition draws.
- Effect
Owner - What holds the effect a
ModelError::InvalidEffectnames. - Effect
Param Type - The type of a parameter’s values: the
EffectValuevariant it takes. - Effect
Param Unit - How a parameter’s value reads in an editor.
- Effect
Problem - Why a
ClipEffectnaming a built-in does not match it. - Effect
Resource Kind - Portable effect-resource categories supported by the render ABI.
- Effect
Value - Serializable value supplied to one runtime effect parameter.
- EqBand
Kind - The filter shape of one equalizer band.
- Error
Subject - The document object a
ModelErroris about, by id. - Fade
Shape - Curve applied by a clip’s fade in and fade out.
- Fill
Rule - Which regions of a path are inside it.
- Flex
Direction - The main axis of a flex container.
- Flex
Wrap - Whether a flex container’s children wrap.
- Generator
- The picture of a generated source.
- Generator
Issue - Why a generator is invalid.
- Grid
Auto Flow - How a grid places items that have no placement of their own.
- Grid
Edge - One edge of a grid item’s placement.
- HdrSources
- What a project does with HDR sources.
- Interpolation
- Interpolation from one keyframe to the next.
- Justify
Content - Where children lie along a container’s main axis, or a grid’s columns in it.
- Layout
Length - A layout length that may be a percent: a size or an inset side.
- Layout
Problem - Why a layout tree is invalid.
- Layout
Size - A layout length that may not be a percent: a gap, radius, border width, font size, padding or margin side, or translation.
- LineCap
- How an open stroke ends.
- Line
Join - How stroke segments meet at a vertex.
- Linear
Primaries - Named RGB primaries linear-light media may be in, each with its own white point.
- Lint
Edge - The end of a range a
LintIssueis about. - Lint
Issue - Something in a project that is valid but probably not meant.
- Lint
Owner - What a
LintIssueis about. - Loop
Mode - How each pass of a
TimeMap::Loopfollows the one before. - Mask
Mode - How a mask combines with the coverage of the masks before it.
- Matte
Mode - Which property of the matte clip’s picture is coverage.
- Media
Kind - The payload domain of a source.
- Missing
Frames - How an image sequence shows a frame missing from its numbering.
- Model
Error - A document invariant violation.
- Node
Input - One named input of a node, as a node’s inputs are listed.
- NodeOp
- The operation of a
CompositionNode. - Overflow
- Whether content past a box’s padding box is drawn.
- Paint
- A color or gradient.
- Polystar
Kind - What kind of figure a polystar is.
- Position
- Whether a box is in its parent’s flow.
- Project
Load Error - Failure while decoding a serialized project document.
- Project
Write Error - Why
crate::Project::to_jsonwrote no document. - Provider
Source - A source whose media an extension provider supplies, not the host’s video and image decoders.
- Range
Shape - How selection rises and falls across a Range selector’s range.
- Range
Units - What a Range selector’s start, end and offset count in.
- Repeat
Count - How often
repeat()repeats its tracks. - RunState
- Which runs a Timing selector selects.
- Shape
Geometry - A geometry alone, as a mask’s outline is.
- Shape
Item - One entry of a shapes generator’s content tree.
- Shape
Lint Owner - The shapes or layout generator a shape
LintIssueis about. - Shape
Owner - What holds the shape or layout a
ModelError::InvalidShapeorModelError::InvalidLayoutnames. - Shape
Problem - Why a content tree or a mask outline is invalid.
- Spread
- What a linear or radial gradient shows outside its first and last stops.
- Text
Align - How lines of text align within it.
- Text
Content - A text: one string, or runs whose texts joined are the text.
- Text
Selector - How an animator selects characters.
- Text
Unit - The units a Range selector counts.
- TimeMap
- How a clip plays its source range over its timeline range.
- Timeline
Owner - What holds a timeline-keyed value or a clip reference;
trackindexestimeline.tracks. - Track
Breadth - One side of
minmax(): how large a grid track may be at least or at most. - Track
Component - One entry of a track list: a track, or
repeat()of some. - Track
Kind - The media domain accepted by a track.
- Track
Size - The size of one grid track.
- Trim
Mode - What a trim measures.
Constants§
- ANIMATOR_
SCALE_ RANGE - The range an animator’s scale takes on each axis.
- ASPECT_
RATIO_ RANGE - The range of a layout box’s
aspect_ratio. - AUDIO_
EFFECT_ STATE_ MARGIN_ MS - How long before its start, beyond its track’s and its own compressor lookahead, a clip’s effects count as holding state, in milliseconds. This covers one block of the largest size at the lowest project rate plus per-lookahead sample rounding. Effects count until the clip’s end.
- BUILTIN_
EFFECT_ PREFIX - Id prefix of built-in effects and transitions. A document id under it must name a built-in, so host effects use ids outside it.
- CURRENT_
SCHEMA_ VERSION - The newest project-document schema understood by this build.
- EQ_
FREQUENCY_ RANGE_ HZ - The frequencies an EQ band may name, in hertz: 10 Hz to just under the Nyquist frequency of the highest project rate. A band renders at most at 0.49 times the project’s rate, so a higher band sounds at that limit.
- EQ_
Q_ RANGE - The resonances an EQ band renders.
- FONT_
SIZE_ FIT_ STEPS - Steps per unit of font size (a fraction of the shorter side) that a fitted font size takes
between its bounds. Steps of
1 / 8192are exact inf32and under a pixel at 8K. - FONT_
WEIGHT_ RANGE - The font weights text takes, as CSS
font-weightnumbers. - HDR_
PEAK_ NITS_ RANGE - Supported
ColorPipeline::hdr_peak_nits: SDR white to PQ’s ceiling. - LAYOUT_
TEXT_ DEFAULTS - The initial text style: what the root inherits.
- LETTER_
SPACING_ RANGE - The letter spacings text takes, as fractions of the font size.
- LINE_
HEIGHT_ RANGE - The line heights text takes, as multiples of the font size.
- LOOP_
FADE_ SECONDS - How long sound fades out before, and in after, each wrap of a repeating loop.
- MAX_
ANIMATOR_ OFFSET - Largest magnitude of a text animator’s offset on each axis, in font sizes.
- MAX_
AUDIO_ DELAY_ MS - Most audio held in effect delay lines at once, in milliseconds, summed over the effects
MAX_AUDIO_EFFECTScounts (a compressor’slookahead_ms, a reverb’sREVERB_DELAY_MS). At the highest project rate this is under 100 MB of state. - MAX_
AUDIO_ EFFECTS - Most audio effects a project holds state for at once: the master’s, the tracks’, and
those of clips holding state then (see
AUDIO_EFFECT_STATE_MARGIN_MS). An equalizer is one effect regardless of bands. - MAX_
BLOCK_ ELLIPSIS_ BYTES - Most bytes in a
BlockEllipsis::String. - MAX_
CANVAS_ DIMENSION - Largest canvas edge accepted by the portable project model.
- MAX_
CANVAS_ PIXELS - Largest total canvas area accepted before quality scaling.
- MAX_
CAPTION_ FILE_ BYTES - The largest subtitle file read, in bytes. A cue’s JSON is longer than its subtitle block, so a larger file holds more cues than a project can.
- MAX_
CAPTION_ FILE_ CUES - The most cues read from one subtitle file: a day of continuous captions at one cue every 1.3 s.
- MAX_
CAPTION_ FONT_ SIZE - Largest caption font size, as a fraction of the frame’s shorter side.
- MAX_
CAPTION_ NAME_ BYTES - Most bytes of a caption style’s name or a cue’s speaker.
- MAX_
CAPTION_ STYLES - Most named styles one caption track holds.
- MAX_
CHAIN_ EFFECTS - Most effects one chain holds: a clip’s, a track’s, or the master’s.
- MAX_
CLASS_ NAME_ BYTES - Most bytes of one class name.
- MAX_
CLIPS - Maximum number of clips across one project, and of sources in it.
- MAX_
CLIPS_ PER_ TRACK - Maximum number of clips on one track.
- MAX_
CLIP_ MASKS - Most shape masks on one clip.
- MAX_
COMPOSITIONS - Most compositions in one project.
- MAX_
COMPOSITION_ CONTROLS - Most controls a composition exposes as a group.
- MAX_
COMPOSITION_ DEPTH - Deepest nesting of compositions. A composition that draws no other has depth one; one that draws others (via group nodes or composition-source media nodes) is one deeper than the deepest of them.
- MAX_
COMPOSITION_ NODES - Most nodes in one composition.
- MAX_
COMPRESSOR_ RATIO - Largest compressor ratio.
- MAX_
DASH_ ENTRIES - Most entries in a stroke’s dash pattern.
- MAX_
DATA_ CHANNELS - Most channels of one
pointsorscalarsdata set. - MAX_
DATA_ COORDINATE - Largest magnitude of a normalized coordinate (points, similarity translation).
- MAX_
DATA_ ID_ BYTES - Most bytes of a data set’s id.
- MAX_
DATA_ INTERVALS - Most intervals of one
intervalsdata set. - MAX_
DATA_ LABEL_ BYTES - Most bytes of an interval label, a word’s text or speaker, or a channel name.
- MAX_
DATA_ ROTATION_ DEGREES - Largest magnitude of a similarity rotation, in degrees.
- MAX_
DATA_ SCALAR - Largest magnitude of a scalar or an interval score.
- MAX_
DATA_ SCALE - Largest similarity scale; the smallest is just above zero.
- MAX_
DATA_ SETS - Most data sets in one project.
- MAX_
DATA_ VALUES - Most values (numbers or lost markers) of one sampled data set.
- MAX_
DATA_ WORDS - Most words of one
wordsdata set. - MAX_
DERIVED_ CUES - Most cues a caption track derives from words, as many as one subtitle file holds.
- MAX_
EFFECT_ INPUTS - The most named inputs an effect node gives its effect, matching what an effect definition may declare.
- MAX_
EFFECT_ RESOURCES - Maximum number of effect resources in one project.
- MAX_
ENVELOPE_ MS - Longest attack or release time, in milliseconds.
- MAX_
EQ_ BANDS - Most bands one equalizer holds.
- MAX_
EQ_ GAIN_ DB - Largest peaking gain, in decibels either way, an EQ band renders.
- MAX_
FLEX_ FACTOR - Largest flex grow or shrink factor.
- MAX_
FOLLOW_ DEPTH - Longest chain of canvas-space follows from one clip, counted in links.
- MAX_
FONT_ FAMILY_ BYTES - Most bytes in a text style’s font family name.
- MAX_
FRAME_ INLINED_ NODES - Most composition nodes the clips at one instant draw together, each clip counted as
MAX_INLINED_NODEScounts its composition and composition source. This bounds per-frame work to one composition of the largest allowed size. - MAX_
GAIN - Largest linear amplitude accepted by any authored gain.
- MAX_
GRADIENT_ STOPS - Most stops in one gradient.
- MAX_
GRID_ TRACKS - Most explicit tracks on one axis of a grid,
repeat()counts expanded. - MAX_
GROUP_ INPUTS - Most inputs a composition takes as a group.
- MAX_
INLINED_ NODES - Most nodes the project’s compositions draw in total. Each node counts one, except a group node or composition-source media node, which counts the nodes of the composition it draws. This bounds compile cost however uses multiply.
- MAX_
KEYFRAMES - Most keyframes of one animated value.
- MAX_
LATEX_ BYTES - Longest LaTeX formula a source holds, in bytes.
- MAX_
LATEX_ FONT_ SIZE - Largest LaTeX font size, in pixels per em.
- MAX_
LAYOUT_ DEPTH - Deepest nesting of one layout tree; the root is depth 1.
- MAX_
LAYOUT_ FONT_ SIZE - Largest font size of a layout’s text, as a fraction of the picture’s shorter side.
- MAX_
LAYOUT_ FRACTION - Largest magnitude of a layout length written as a fraction of the picture’s shorter side.
- MAX_
LAYOUT_ ISOLATED - Most isolated nodes (with a visual field or hidden overflow) in one layout tree.
- MAX_
LAYOUT_ NODES - Most nodes in one layout tree, the root included.
- MAX_
LAYOUT_ PERCENT - Largest magnitude of a layout length written as a percent.
- MAX_
LAYOUT_ PX - Largest magnitude of a layout length in canvas pixels: 1,024 times the largest canvas side.
- MAX_
LAYOUT_ TEXTS - Most nodes with text in one layout tree.
- MAX_
LOOKAHEAD_ MS - Longest compressor lookahead, in milliseconds.
- MAX_
LOOP_ PASSES - Most passes a looping clip makes over its timeline range. A longer loop is several clips.
- MAX_
LOTTIE_ DOCUMENT_ BYTES - Largest Lottie animation a provider reads, in bytes (a JSON file or an unpacked dotLottie animation). Parsing can take about 45 times the document size, so this caps it near 750 MiB; larger documents are refused before parsing.
- MAX_
MERGE_ LAYERS - Most layers in one merge node.
- MAX_
PATH_ SUBPATHS - Most subpaths one path holds.
- MAX_
PATH_ VERTICES - Most vertices one path holds, over all its subpaths.
- MAX_
PDF_ DOCUMENT_ BYTES - Largest PDF document a provider reads, in bytes. Larger files are refused before reading.
- MAX_
PDF_ PAGES - Most pages a PDF document a provider reads may have.
- MAX_
POLYSTAR_ POINTS - Most points a polystar has. A fractional count is valid; the fraction is dropped when drawn.
- MAX_
PROJECT_ JSON_ BYTES - Largest project document accepted by
Project::from_json. - MAX_
PROVIDER_ DOCUMENT_ BYTES - Largest dotLottie package a provider reads, in bytes, refusing larger files unread. Only the
shown animation (within
MAX_LOTTIE_DOCUMENT_BYTES) and its images are unpacked. - MAX_
RANGE_ INDEX - How far a Range selector in index units reaches past either end:
[-N, 2N]units forNof this. - MAX_
RUN_ CLASSES - Most classes one run carries.
- MAX_
SELECTED_ CHANNELS - The most source channels
AudioProperties::channelsselects. - MAX_
SEQUENCE_ FRAMES - Most frames an image sequence lists.
- MAX_
SHAPE_ DEPTH - Deepest group nesting in one shapes generator.
- MAX_
SHAPE_ ITEMS - Most items one shapes generator holds, including nested groups and their items.
- MAX_
SVG_ DOCUMENT_ BYTES - Largest SVG document a provider reads, in bytes. Parsing can take about 30 times the document size, so this caps it near 960 MiB; larger documents are refused before parsing.
- MAX_
TEXT_ ANIMATORS - Most animators one text style holds.
- MAX_
TEXT_ CONTENT_ BYTES - Most bytes of text in one caption cue or text generator.
- MAX_
TEXT_ GENERATOR_ FONT_ SIZE - Largest font size of a text generator, as a fraction of the canvas’s shorter side.
- MAX_
TEXT_ PADDING - Largest text background padding, as a fraction of the font size.
- MAX_
TEXT_ POSITION - Largest magnitude of a text’s
positionoranchorcoordinate, in canvas or text extents. - MAX_
TEXT_ RUNS - Most runs one text holds.
- MAX_
TEXT_ SHADOWS - Most shadows under one text.
- MAX_
TEXT_ SHADOW_ BLUR - Widest text shadow blur, as a fraction of the font size.
- MAX_
TEXT_ SHADOW_ OFFSET - Farthest a text shadow lies from its text on each axis, as a fraction of the font size.
- MAX_
TEXT_ STROKES - Most strokes around one text.
- MAX_
TEXT_ STROKE_ EXTENT - Widest a text’s strokes reach together (the sum of their widths), as a fraction of the font size.
- MAX_
TRACKS - Maximum number of tracks in one project.
- MAX_
TRANSITIONS_ PER_ TRACK - Maximum number of transitions on one track.
- MIN_
LEVEL_ DB - The quietest compressor threshold or ducking depth, in decibels; both are at most 0 dB.
- MIN_
POLYSTAR_ POINTS - Fewest points a polystar has.
- RANGE_
PERCENT - The range a percent Range selector’s start, end and offset take.
- REVERB_
DELAY_ MS - What one reverb counts toward
MAX_AUDIO_DELAY_MS; its comb and allpass lines hold about 157 ms at any rate. - SAMPLE_
RATE_ RANGE - Supported project audio sample-rate interval.
- SIMILARITY_
ARITY - Numbers per similarity sample:
tx,ty, rotation in degrees, scale. - WORD_
PAUSE_ TICKS - The longest gap between two words of one cue, in ticks (0.6 s).
Traits§
- Animated
Value - A type an
Animatedvalue can hold. Sealed: implemented for the model’s animatable types. - Timeline
Value - A value whose keyframes are in timeline time.
Functions§
- builtin_
effect - The built-in definition with
id. - builtin_
effects - Every built-in definition: effects, then transitions, in catalog order.
- builtin_
effects_ json - The catalog JSON the built-ins were read from, as
schema/effects.v1.jsonpublishes it. - caption_
rows - Splits cues onto rows, one caption track each. Every cue goes to the first row with room
(a track holds
MAX_CLIPS_PER_TRACK) whose last cue has ended by its start. O(n log n) in the cues, however many overlap. - check_
builtin_ effect - Checks
effectagainst its built-in definition, used askind, as project validation does for a timeline transition or a node without named inputs. Ids outsideBUILTIN_EFFECT_PREFIXbelong to the host and pass. - clip_
runs - Clamps a cue’s run times to its range after the range was shortened. A run that would start at or after the end gets no time.
- end_
cues_ where_ the_ next_ starts - Ends each cue of
cues, sorted by start, where the next starts, and drops a cue left empty. - group_
words - Words grouped into cues that end at
max_charscharacters, a sentence’s end, a pause longer thanWORD_PAUSE_TICKS, a change of speaker, or before the text would passMAX_TEXT_CONTENT_BYTESorcrate::MAX_TEXT_RUNSruns. Each cue has one run per word (with the separator that follows it), timed from the cue’s start, so Timing selectors follow the speech. A word whose text trims to nothing is skipped. - loop_
passes - Passes a
source-tick loop makes overtimelineticks, rounded up; zero for an empty source. - parse_
srt - Reads SubRip (
.srt) text. - parse_
webvtt - Reads WebVTT (
.vtt) text.NOTE,STYLE, andREGIONblocks are ignored. - valid_
class_ name - Whether
nameis a class name a run or a Class selector may carry. - valid_
interval - Checks an interval’s own fields (order against its neighbours is checked by the caller).
- valid_
word - Checks a word’s own fields (order against its neighbours is checked by the caller).
- validate_
shape_ items - Checks a content tree: its limits, every value’s range, and that animated paths and paints agree in structure between keyframes.
- value_
in_ bounds - Whether
valueis inside its kind’s bounds;componentis the position within a sample’s numbers for a similarity set.
Type Aliases§
- Timeline
Visit - A visitor of timeline-clock values, given each value’s place as
Type.field(Type[tag]for an enum variant), the names of the model’s JSON schema.