Class EpubNarrationPhrase

Represents a single phrase within a narration sequence.

Inheritance

object

EpubNarrationPhrase

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: VersOne.Epub

Assembly: VersOne.Epub.dll

Syntax

public class EpubNarrationPhrase

Constructors

EpubNarrationPhrase(EpubLocalTextContentFile, string?, EpubContentFile?, EpubNarrationTimestamp?, EpubNarrationTimestamp?)

Initializes a new instance of the EpubNarrationPhrase class.

Declaration

public EpubNarrationPhrase(EpubLocalTextContentFile textContentFile, string? textContentAnchor, EpubContentFile? audioContentFile, EpubNarrationTimestamp? audioContentBegin, EpubNarrationTimestamp? audioContentEnd)

Parameters

Type	Name	Description
EpubLocalTextContentFile	textContentFile	The text content file containing the phrase that corresponds to the narration in the audio clip.
string	textContentAnchor	An HTML anchor of the phrase that corresponds to the narration in the audio clip or null if the audio clip contains the narration for the whole text content file.
EpubContentFile	audioContentFile	An audio content file containing the narration for this phrase or null if the phrase is intended to be narrated via a Text-to-Speech (TTS) system.
EpubNarrationTimestamp?	audioContentBegin	The timestamp that represents the beginning of the audio clip in the audioContentFile or null if the audio content file needs to be played from the beginning of the file.
EpubNarrationTimestamp?	audioContentEnd	The timestamp that represents the end of the audio clip in the audioContentFile or null if the audio content file needs to be played until the end of the file.

Exceptions

Type	Condition
ArgumentNullException	The textContentFile parameter is null.

Properties

AudioContentBegin

Gets the timestamp that represents the beginning of the audio clip in the AudioContentFile or null if the audio content file needs to be played from the beginning of the file.

Declaration

public EpubNarrationTimestamp? AudioContentBegin { get; }

Property type: EpubNarrationTimestamp?

AudioContentEnd

Gets the timestamp that represents the end of the audio clip in the AudioContentFile or null if the audio content file needs to be played until the end of the file.

Declaration

public EpubNarrationTimestamp? AudioContentEnd { get; }

Property type: EpubNarrationTimestamp?

AudioContentFile

Gets an audio content file containing the narration for this phrase or null if the phrase is intended to be narrated via a Text-to-Speech (TTS) system.

Declaration

public EpubContentFile? AudioContentFile { get; }

Property type: EpubContentFile

TextContentAnchor

Gets an HTML anchor of the phrase that corresponds to the narration in the audio clip or null if the audio clip contains the narration for the whole text content file.

Declaration

public string? TextContentAnchor { get; }

Property type: string

TextContentFile

Gets the text content file containing the phrase that corresponds to the narration in the audio clip.

Declaration

public EpubLocalTextContentFile TextContentFile { get; }

Property type: EpubLocalTextContentFile