Class SmilBody

Parsed content of the media overlay body which is the starting point for the presentation contained in the media overlay document. This class corresponds to the <body> element in a media overlay document.

See https://www.w3.org/publishing/epub32/epub-mediaoverlays.html#elemdef-smil-body for more information.

Inheritance
object
SmilBody
Inherited Members
Namespace: VersOne.Epub.Schema
Assembly: VersOne.Epub.dll
Syntax
public class SmilBody

Constructors

View Source

SmilBody(string?, List<Epub3StructuralSemanticsProperty>?, string?, List<SmilSeq>, List<SmilPar>)

Initializes a new instance of the SmilBody class.

Declaration
public SmilBody(string? id, List<Epub3StructuralSemanticsProperty>? epubTypes, string? epubTextRef, List<SmilSeq> seqs, List<SmilPar> pars)
Parameters
Type Name Description
string id

An optional identifier of this element.
List<Epub3StructuralSemanticsProperty> epubTypes

An optional list of the structural semantics of the corresponding element in the EPUB content document.
string epubTextRef

The relative IRI reference of the corresponding EPUB content document, including a fragment identifier that references the specific element.
List<SmilSeq> seqs

The list of the media objects which are to be rendered sequentially.
List<SmilPar> pars

The list of the media objects which are to be rendered in parallel.
Exceptions
Type Condition
ArgumentNullException

The seqs parameter is null.
ArgumentNullException

The pars parameter is null.

Properties

View Source

EpubTextRef

Gets the relative IRI reference of the corresponding EPUB content document, including a fragment identifier that references the specific element.

Declaration
public string? EpubTextRef { get; }
Property type: string
View Source

EpubTypes

Gets an optional list of the structural semantics of the corresponding element in the EPUB content document.

Declaration
public List<Epub3StructuralSemanticsProperty>? EpubTypes { get; }
Property type: List<Epub3StructuralSemanticsProperty>
View Source

Id

Gets an optional identifier of this element. If present, this value is unique within the scope of the media overlay document.

Declaration
public string? Id { get; }
Property type: string
View Source

Pars

Gets the list of the media objects which are to be rendered in parallel. Each element in this list represents a phrase and identifies a text and audio component to synchronize during playback.

Declaration
public List<SmilPar> Pars { get; }
Property type: List<SmilPar>
View Source

Seqs

Gets the list of the media objects which are to be rendered sequentially. This list represents a sequence of nested containers such as sections, asides, headers, and footnotes. It allows the structure inherent in these containers to be retained in the media overlay document.

Declaration
public List<SmilSeq> Seqs { get; }
Property type: List<SmilSeq>