Struct Timeline 

pub struct Timeline {
    pub library_id: String,
    pub streamer_id: String,
    pub name: String,
    pub revision: u32,
    pub entries: Vec<ShotEntry>,
    pub sort_order: u32,
    pub id: TimelineId,
}

A named, reusable timeline in a shared definition library.

Like an OTIO Track, entries is an ordered sequence of shot appearances. A Shot is the reusable source definition; any number of entries may reference it, and every entry owns its direction and capture parameters independently. shot_index is an authored production label, not a competing sort key.

Fields

library_id: String

Shared definition scope. Empty on legacy rows and interpreted as the default shared library.

streamer_id: String

Legacy provenance retained for wire and persisted-row compatibility. The active stream is supplied only when a RecordingJob starts.

name: String

revision: u32

Immutable-program revision. Editing the timeline advances this value; recording it does not. Legacy rows stored this as version.

entries: Vec<ShotEntry>

Ordered shot appearances. They project to OTIO Clips only at the interchange boundary. Legacy persistence rows used clips or cues.

sort_order: u32

id: TimelineId

Implementations

impl Timeline

pub fn legacy_default_id(library_id: &str) -> String

Historic identity used by the retired automatic shot-list workflow. Kept only so persisted rows and their references can be reconciled.

pub fn shared_legacy_default_id() -> String

pub fn has_legacy_default_identity(&self) -> bool

pub fn has_legacy_default_name(&self) -> bool

pub fn effective_library_id(&self) -> &str

pub fn next_revision(&self) -> u32

pub fn normalize_entries(&mut self)

Normalize legacy memberships into ordered ShotEntry instances. A legacy Both membership becomes two independently addressable entries, while repeated references to the same Shot are deliberately preserved.

pub fn backfill_entry_parameters(&mut self, shots: &[Shot]) -> bool

Materialize every legacy optional entry value from its referenced Shot. Once this returns true, later Shot-default edits cannot leak across timelines.

pub fn add_entry(&mut self, shot_id: &str, direction: ShotEntryMode)

pub fn add_shot_entry(&mut self, shot: &Shot, direction: ShotEntryMode)

pub fn add_shot_entry_instance( &mut self, shot: &Shot, direction: ShotDirection, entry_id: impl Into<String>, )

pub fn remove_entry(&mut self, entry_id: &str)

pub fn set_entry_direction(&mut self, entry_id: &str, direction: ShotDirection)

pub fn capture_count(&self) -> usize

Trait Implementations

impl AnyItem for Timeline

fn as_any(&self) -> &dyn Any

Returns self as &dyn Any for downcasting.

fn entity_type(&self) -> &'static str

Returns the entity type name (e.g., “Target”, “Scene”).

fn equals(&self, other: &dyn AnyItem) -> bool

Typed equality across erased items.

fn server_owner(&self) -> Option<&str>

Returns the current #[server_owned] field value, if this item has one.

fn bake_server_owner(&self, server_id: &str) -> Option<Arc<dyn AnyItem>>

Returns a clone of this item with the #[server_owned] field set to server_id. Returns None if this item has no #[server_owned] field.

impl Clone for Timeline

fn clone(&self) -> Timeline

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Timeline

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Timeline

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eventable for Timeline

const ENTITY_NAME_STATIC: &'static str = "Timeline"

Static entity type name (use entity_type() from AnyItem for instance access).

fn entity_name_static() -> &'static str

Back-compat helper for generic call sites that still expect a function.

fn ingest_buffer_policy() -> IngestBufferPolicy

Opt-in ingest buffering policy for this entity type.

fn parse(value: Value) -> Result<Arc<dyn AnyItem>, Error>

Parse JSON into this item type.

fn parse_bytes(bytes: &[u8]) -> Result<Arc<dyn AnyItem>, Error>

Parse JSON bytes into this item type. Skips the Value round-trip when callers can hand off raw bytes (~2.27× faster than the Value → from_value path on a typical entity payload).

impl IdFor<Timeline> for TimelineId

type MapKey = Arc<str>

fn map_key(&self) -> Self::MapKey

impl PartialEq for Timeline

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Timeline

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for Timeline

type WithoutGenerics = Timeline

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = Timeline

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export.

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.

impl WithId for Timeline

fn id(&self) -> Arc<str>

impl WithTypedId for Timeline

type Id = TimelineId

fn typed_id(&self) -> Self::Id