imflib.scm

SMPTE ST 2017-9-2018: Sidecar Asset Map

class imflib.scm.SidecarAsset(id: ~uuid.UUID = <factory>, associated_cpl_ids: set[uuid.UUID] = <factory>)

Bases: object

A SMPTE ST 2017-9-2018 Sidecar Asset-to-CPL Mapping

associated_cpl_ids: set[uuid.UUID]

Unique list of CPL UUIDs associated with this asset

classmethod from_xml(xml: Element, ns: Optional[dict] = None) → SidecarAsset

Parse a Sidecar Asset from XML

id: UUID

UUID of the Sidecar Asset

to_xml() → Element

Build an XML representation of a SidecarAsset

class imflib.scm.SidecarCompositionMap(id: ~uuid.UUID = <factory>, issue_date: ~datetime.datetime = <factory>, assets: ~typing.List[~imflib.scm.SidecarAsset] = <factory>, issuer: ~typing.Optional[~imflib.UserText] = None, annotation: ~typing.Optional[~imflib.UserText] = None, additional_properties: list[xml.etree.ElementTree.Element] = <factory>, security: ~typing.Optional[~imflib.Security] = None)

Bases: object

A SMPTE ST 2017-9-2018 Sidecar Composition Map

additional_properties: list[xml.etree.ElementTree.Element]

Additional properties defined in this SCM

annotation: Optional[UserText] = None

Human-readable description of this SCM

assets: List[SidecarAsset]

A list of sidecar assets

classmethod from_file(path: str) → SidecarCompositionMap

Parse an existing SCM from a given file path

classmethod from_xml(xml: Element, ns: Optional[dict] = None) → SidecarCompositionMap

Parse an SCM from XML

id: UUID

UUID of this SCM

issue_date: datetime

Datetime this SCM was issued

issuer: Optional[UserText] = None

The person or company that issued this SCM

security: Optional[Security] = None

XML signer and signature

to_file(file: TextIOWrapper)

Write to a file

to_xml() → Element

Return an XML representation of this Sidecar Composition Map