Show / Hide Table of Contents

Class SmilAudio

Parsed content of the reference to a clip of audio media. This class corresponds to the <audio> element in a media overlay document.

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

Inheritance
object
SmilAudio
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 SmilAudio

Constructors

View Source

SmilAudio(string?, string, string?, string?)

Initializes a new instance of the SmilAudio class.

Declaration
public SmilAudio(string? id, string src, string? clipBegin, string? clipEnd)
Parameters
Type Name Description
string id

An optional identifier of this element.

string src

The relative or the absolute IRI of an audio file.

string clipBegin

An optional clock value (in the SMIL clock format) that specifies the offset into the physical media corresponding to the start point of an audio clip.

string clipEnd

An optional clock value (in the SMIL clock format) that specifies the offset into the physical media corresponding to the end point of an audio clip.

Exceptions
Type Condition
ArgumentNullException

The src parameter is null.

Properties

View Source

ClipBegin

Gets an optional clock value (in the SMIL clock format) that specifies the offset into the physical media corresponding to the start point of an audio clip.

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

ClipEnd

Gets an optional clock value (in the SMIL clock format) that specifies the offset into the physical media corresponding to the end point of an audio clip.

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

Src

Gets the relative or the absolute IRI of an audio file.

Declaration
public string Src { get; }
Property type: string
  • View Source
In this article
Back to top Generated by DocFX