Second draft of file bundle adapter docs. #1709
Conversation
docs/tutorials/otio-filebundles.md
Outdated
|
|
||
| ### Convert an otio into a zip bundle | ||
| - absolute path: "file:///path/to/some/file" (encodes "/path/to/some/file") | ||
| - relative path: "path/to/some/file" (assumes the path is relative to the current working directory when invoking the adapter on the source timeline). |
There was a problem hiding this comment.
Does the current working directory refer the location of the timeline or where the command is being run?
There was a problem hiding this comment.
an update on this - it would appear that it refers to the cwd of the command being run, but I think it should probably be relative to the location of the timeline. The final resulting paths are relative to the root of the bundle.
|
|
||
| The file bundle adapters expect the `target_url` field of the `media_reference` to be in one of two forms (as produced by python's urlparse library): | ||
| OTIOZ (adds the version.txt file and is encoded in a zipfile): |
There was a problem hiding this comment.
Maybe add a note here that the content.otio and version.txt files are compressed and the media is uncompressed?
There was a problem hiding this comment.
good suggestion!
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1709 +/- ##
==========================================
+ Coverage 79.95% 84.12% +4.16%
==========================================
Files 197 198 +1
Lines 21879 22242 +363
Branches 4342 4688 +346
==========================================
+ Hits 17494 18710 +1216
- Misses 2252 2610 +358
+ Partials 2133 922 -1211
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 107 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
|
ssteinbach
force-pushed
the
main.filebundledocclarify
branch
from
da3b7b3
to
9ce9ac3
Compare
ssteinbach
force-pushed
the
main.filebundledocclarify
branch
from
9ce9ac3
to
c47eeb9
Compare
Following conversation with @darbyjohnston, an attempt to clean up and clarify the documentation for the file bundle adpaters.