MODocument

A Media Overlay Document (SMIL file).

class yael.modocument.MODocument(internal_path=None, obj=None, string=None)[source]

Build a Media Overlay Document (SMIL file) or parse it from obj or string.

body

The body child of the <smil> element.

Return type:yael.moseq.MOSeq
grouped_referenced_fragment_identifiers

A dictionary containing the fragment identifiers referenced by <text> elements in this Media Overlay Document. Each key is the path to the Content Document, and the corresponding value is a list of fragment indentifiers in that Content Document.

Return type:dict
head

The head child of the <smil> element.

Currently not parsed, as per specs, it is empty.

Return type:None
referenced_audio_files

The list of audio files referenced by <audio> elements in this Media Overlay Document.

Return type:list of str
referenced_fragment_identifiers

The list of fragment identifiers referenced by <text> elements in this Media Overlay Document.

Return type:list of str
references_embedded_audio_video

True if this Media Overlay Document references Embedded Audio and Video (i.e., if it contains a <par> with a <text> child but no <audio> child).

Return type:bool
v_epub_prefix

The epub:prefix attribute of the <smil> element.

Return type:str
v_id

The id attribute of the <smil> element.

Return type:str
v_version

The version attribute of the <smil> element.

Return type:str