Struct TcMetadata 

pub struct TcMetadata {
    pub timecode: Timecode,
    pub frame_rate: FrameRate,
    pub source: TimecodeSource,
    pub reel: Option<ReelId>,
    pub record_date: Option<RecordDate>,
    pub user_bits: Option<UserBitsPayload>,
    pub tags: HashMap<String, String>,
    pub scene: Option<String>,
    pub take: Option<u32>,
}

Comprehensive timecode metadata block.

Bundles a timecode with all associated metadata such as source, reel, date, user bits, and custom key-value tags.

Fields

timecode: Timecode

The timecode value

frame_rate: FrameRate

Frame rate used for the timecode

source: TimecodeSource

Source of the timecode

reel: Option<ReelId>

Optional reel identifier

record_date: Option<RecordDate>

Optional recording date

user_bits: Option<UserBitsPayload>

User bits payload

tags: HashMap<String, String>

Arbitrary string key-value tags

scene: Option<String>

Scene label

take: Option<u32>

Take number

Implementations

impl TcMetadata

pub fn new( timecode: Timecode, frame_rate: FrameRate, source: TimecodeSource, ) -> Self

Creates new metadata for a timecode.

pub fn with_reel(self, reel: ReelId) -> Self

Sets the reel identifier.

pub fn with_record_date(self, date: RecordDate) -> Self

Sets the recording date.

pub fn with_user_bits(self, ub: UserBitsPayload) -> Self

Sets the user bits.

pub fn with_tag(self, key: impl Into<String>, value: impl Into<String>) -> Self

Adds a custom tag.

pub fn with_scene(self, scene: impl Into<String>) -> Self

Sets the scene label.

pub fn with_take(self, take: u32) -> Self

Sets the take number.

pub fn summary(&self) -> String

Formats metadata as a human-readable summary string.

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

Validates that the metadata is internally consistent.

Errors

Returns an error if the timecode frame rate info does not match the declared frame rate.

Trait Implementations

impl Clone for TcMetadata

fn clone(&self) -> TcMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TcMetadata

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

Formats the value using the given formatter.