@@ -74,18 +74,19 @@ size_t get_media_size(
7474
7575// / @brief Write a timeline and it's referenced media to an .otioz bundle.
7676// /
77- // / Takes as input an OTIO file that has media references which are all
78- // / ExternalReferences with target_urls to files with unique basenames that are
79- // / accessible through the file system and bundles those files and the otio
80- // / file into a single zip file with the suffix .otioz.
77+ // / Takes as input a timeline that has media references which are all
78+ // / ExternalReferences, with target_urls to files with unique basenames that are
79+ // / accessible through the file system. The timeline .otio file, a version file,
80+ // / and media references are bundled into a single zip file with the suffix
81+ // / .otioz.
8182// /
82- // / The otio file and version file are compressed using the ZIP "deflate"
83- // / mode. All media files are store uncompressed.
83+ // / The timline . otio file and version file are compressed using the ZIP
84+ // / "deflate" mode. All media files are store uncompressed.
8485// /
8586// / Can error out if files are not locally referenced. or provide missing
8687// / references.
8788// /
88- // / Note that OTIOZ files _always_ use the unix style path separator ('/').
89+ // / Note that .otioz files _always_ use the unix style path separator ('/').
8990// / This ensures that regardless of which platform a bundle was created on, it
9091// / can be read on UNIX and Windows platforms.
9192// /
@@ -111,10 +112,11 @@ Timeline* from_otioz(
111112
112113// / @brief Write a timeline and it's referenced media to an .otiod bundle.
113114// /
114- // / Takes as input an OTIO file that has media references which are all
115- // / ExternalReferences with target_urls to files with unique basenames that are
116- // / accessible through the file system and bundles those files and the otio file
117- // / into a single directory named with a suffix of .otiod.
115+ // / Takes as input a timeline that has media references which are all
116+ // / ExternalReferences, with target_urls to files with unique basenames that are
117+ // / accessible through the file system. The timeline .otio file, a version file,
118+ // / and media references are bundled into a single directory named with a
119+ // / suffix of .otiod.
118120// /
119121// / @param timeline The timeline to write.
120122// / @param file_name The bundle file name.
0 commit comments