Interface IMediaOverlayMetadata

Represents metadata found in the OPF related to EPUB media overlays.

interface IMediaOverlayMetadata {
    getActiveClassName(): string;
    getDurationMs(): number;
    getNarrator(): string;
    getPlaybackActiveClassName(): string;
}

Methods

getActiveClassName

getActiveClassName(): string
Author-defined CSS class name to apply to the currently-playing EPUB Content Document element.

Returns string

getDurationMs

getDurationMs(): number
The duration of the entire presentation. The specified durations account for the audio clips known at authoring time, and so exclude live streaming from external resources and speech synthesis.

Returns number

getNarrator

getNarrator(): string
Name of the narrator.

Returns string

getPlaybackActiveClassName

getPlaybackActiveClassName(): string
Author-defined CSS class name to apply to the EPUB Content Document's document element when playback is active.

Returns string