Class SmilPar

Parsed content of a SMIL phrase which identifies a text and audio component to synchronize during playback. This class corresponds to the <par> element in a media overlay document.

See https://www.w3.org/publishing/epub32/epub-mediaoverlays.html#sec-smil-par-elem for more information.

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

Constructors

View Source

SmilPar(string?, List<Epub3StructuralSemanticsProperty>?, SmilText, SmilAudio?)

Initializes a new instance of the SmilPar class.

Declaration
public SmilPar(string? id, List<Epub3StructuralSemanticsProperty>? epubTypes, SmilText text, SmilAudio? audio)
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.
SmilText text

The reference to an element (typically, a textual element) in the EPUB content document.
SmilAudio audio

An optional reference to a clip of audio media.
Exceptions
Type Condition
ArgumentNullException

The text parameter is null.

Properties

View Source

Audio

Gets an optional reference to a clip of audio media.

Declaration
public SmilAudio? Audio { get; }
Property type: SmilAudio
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

Text

Gets the reference to an element (typically, a textual element) in the EPUB content document.

Declaration
public SmilText Text { get; }
Property type: SmilText