# EpubMediaOverlay

Bounded ordered narration for one XHTML or SVG document. Audio is retained, not decoded.

Class 

`OfficeIMO.Epub`

**Namespace**

`OfficeIMO.Epub`

**Assembly**

`OfficeIMO.Epub`

**Source revision**

`3b680b1b6fb1` with working tree changes

**Source**

[EpubMediaOverlay.cs:6](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Epub/Authoring/EpubMediaOverlay.cs#L6)

**Modifiers**

sealed

Bounded ordered narration for one XHTML or SVG document. Audio is retained, not decoded.

## Inheritance

- object
- EpubMediaOverlay

## Usage

Explore 2 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

### Accepted by parameters 2

- Method [EpubPublication.AddMediaOverlay](/api/epub/officeimo-epub-epubpublication/#method-addmediaoverlay-string-string-string-officeimo-epub-epubmediaoverlay-threading-cancellationtoken) parameter `overlay`
- Method [EpubPublication.ReplaceMediaOverlay](/api/epub/officeimo-epub-epubpublication/#method-replacemediaoverlay-string-officeimo-epub-epubmediaoverlay-threading-cancellationtoken) parameter `overlay`

Filter members 

Show inherited

## Constructors

`public EpubMediaOverlay()` [#](#constructor-ctor)

[EpubMediaOverlay.cs:6](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Epub/Authoring/EpubMediaOverlay.cs#L6)

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public IReadOnlyList<EpubMediaOverlayCue> Cues { get; set; }` [#](#property-cues)

[EpubMediaOverlay.cs:6](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Epub/Authoring/EpubMediaOverlay.cs#L6)

One to 10,000 cues in playback order. Text targets must be distinct and in document order.

`public IReadOnlyList<EpubMediaOverlayNode> Nodes { get; set; }` [#](#property-nodes)

[EpubMediaOverlay.cs:8](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Epub/Authoring/EpubMediaOverlay.cs#L8)

Optional tree of cues and sequences instead of Cues. At most 10,000 total nodes and 32 nested sequences.

`public IReadOnlyDictionary<string, TimeSpan> AudioDurations { get; set; }` [#](#property-audiodurations)

[EpubMediaOverlay.cs:13](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Epub/Authoring/EpubMediaOverlay.cs#L13)

Caller-measured duration of each referenced audio resource, keyed by manifest id. These values bound clip offsets; they are not independently verified against encoded media.

<!-- PowerForge markdown artifact sha256:34493F3DC15C67F748C6EF90DE5BC1F4E325FE5766B5CDDD3C9572EAFF1186CF -->
