imflib.cpl

Composition Playlist and its related classes

Based on st-2067-3-2020: https://ieeexplore.ieee.org/document/9097510/

The Composition Playlist (Cpl) combines the assets in an IMF to a timeline. A CPL is divided into one or more Segments.

Each Segment contains one or more Sequences, which are more or less analogous to tracks in a traditional NLE.

Each Sequencereferences one or more Resources, which are analogous to subclips in a traditional NLE.

Resources comprised of external files are TrackFileResources. The file path to each TrackFileResouces can be resolved by cross-referencing the UUID in TrackFileResource.track_file_id with the UUID in imflib.pkl.Asset.id and imflib.assetmap.Asset.id.

Classes

AudioResource(intrinsic_duration, id, ...)	A main audio resource
BaseResource(intrinsic_duration, id, ...)	A BaseResource XSD within a sequence
ContentKind(kind[, scope])	The kind of content undelying the composition
ContentMaturityRating(rating, agency, ...)	Content maturity rating and info
ContentVersion(label, id, additional_properties)	A version of the content represented in the CPL
Cpl(title, edit_rate, id, issue_date, ...)	An IMF Composition Playlist
EditRate(edit_rate)	A rational edit rate
EssenceDescriptor(id, descriptor_data)	A description of an essence
ExtensionProperty(raw_xml)	Application extension
ISXDSequence(id, track_id, _resources, ...)	SMPTE RDD 47-2018 isochronous sequence
ImageResource(intrinsic_duration, id, ...)	A main image resource
Locale(languages, regions, ...)	Locale-specific information
MainAudioSequence(id, track_id, _resources, ...)	Main audio sequence of a segment
MainImageSequence(id, track_id, _resources, ...)	An XSD MainImageSequenceType from IMF Core Constraints
MarkerResource(intrinsic_duration, id, ...)	A CPL Marker
MarkerSequence(id, track_id, _resources, ...)	Marker sequence
Segment(annotation, id, _sequences, ...)	A CPL segment
Sequence(id, track_id, _resources, ...)	A sequence within a segment
TrackFileResource(intrinsic_duration, id, ...)	A file-based resource