Skip to main content

caption_cues

Function caption_cues 

Source
pub fn caption_cues(
    project: &Project,
    track: &TrackId,
    captions: &Captions,
) -> Result<Vec<CaptionCue>, ModelError>
Expand description

The cues a caption track shows, its own or its from_words words grouped in timeline time.

A source-anchored word set contributes through each clip of the named track showing its source with a forward or loop time map (reversed sound is unintelligible and a freeze is silent). A word is mapped through the clip’s inverse time map, clipped to the clip, and dropped when its midpoint lies outside the clip’s source range. Words are grouped per clip and loop pass, so a cue never spans a cut; where cues of neighbouring clips overlap, each ends where the next starts.

Every cue passes the checks of an explicit cue, and the cues are ordered and disjoint.

§Errors

ModelError::TooManyDerivedCues naming track when the words map to more than alpha2_model::MAX_DATA_WORDS instances or group into more than MAX_DERIVED_CUES cues.