AcademySoftwareFoundation / AcademySoftwareFoundation/OpenTimelineIO

Document still/held image support

Open
#68 0 comments 0 reactions 0 assignees View on GitHub
documentation needs discussion roadmap
Dominant language
C++
Stars
2k
Forks
351
Avg merge
1d 12h
Merged PRs (30d)
1

Description

Sometimes a clip's media is a single image, held for some duration. We have found that folks using OTIO are surprised by this. They seem to expect that a clip's media_reference is always a movie file, or an ImageSequenceReference, but that is not a requirement.

We should document this use case, and provide OTIO samples with clips that point to still images.

Contributor guide

Open the contributing guide

Research direction

Start by locating the existing OTIO documentation and sample material, then review how clips, media_reference, movie files, and ImageSequenceReference are currently described. Document that a clip may reference a single still image held for a duration, and add samples showing clips that point to still images.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.