Class Smil

Parsed content of a EPUB 3 media overlay document. This class corresponds to the <smil> element which is the root element for a media overlay document.

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

Inheritance

object

Smil

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: VersOne.Epub.Schema

Assembly: VersOne.Epub.dll

Syntax

public class Smil

Constructors

Smil(string?, SmilVersion, string?, SmilHead?, SmilBody)

Initializes a new instance of the Smil class.

Declaration

public Smil(string? id, SmilVersion version, string? epubPrefix, SmilHead? head, SmilBody body)

Parameters

Type	Name	Description
string	id	An optional identifier of this element.
SmilVersion	version	The version number of the SMIL specification to which this media overlay adheres. Currently, it must always be SMIL_3.
string	epubPrefix	Additional metadata vocabulary prefixes or null if there are no prefixes specified.
SmilHead	head	An optional media overlay head which acts as a container for metadata elements or null if the document doesn't specify any metadata.
SmilBody	body	The media overlay body which is the starting point for the presentation contained in the media overlay document.

Exceptions

Type	Condition
ArgumentNullException	The body parameter is null.

Properties

Body

Gets the media overlay body which is the starting point for the presentation contained in the media overlay document.

Declaration

public SmilBody Body { get; }

Property type: SmilBody

EpubPrefix

Gets additional metadata vocabulary prefixes or null if there are no prefixes specified.

Declaration

public string? EpubPrefix { get; }

Property type: string

Head

Gets an optional media overlay head which acts as a container for metadata elements or null if the document doesn't specify any metadata.

Declaration

public SmilHead? Head { get; }

Property type: SmilHead

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

Version

Gets the version number of the SMIL specification to which this media overlay adheres. Currently, it is always SMIL_3.

Declaration

public SmilVersion Version { get; }

Property type: SmilVersion