Media Overlays Metadata Vocabulary

5 October 2016

Document history

Editors

Markus Gylling, International Digital Publishing Forum (IDPF)

Matt Garrish, Invited Expert

Copyright © 2010-2016 International Digital Publishing Forum™

All rights reserved. This work is protected under Title 17 of the United States Code. Reproduction and dissemination of this work with changes is prohibited except with the written permission of the International Digital Publishing Forum (IDPF).

EPUB is a registered trademark of the International Digital Publishing Forum.

Status of this Document

This document is subject to change at any time. The terms defined herein will never be removed, but may be deprecated.

Any use of terms marked [draft] should be considered experimental.

Deprecated term are identified by the label [deprecated]. These terms are no longer recommended for use.

Requests for additions, modifications and clarifications can be made through the Issue Tracker. Pull requests are also welcome.

Refer to the IDPF Issue Reporting Guidelines for more information about the change request process.

  1 Overview

  1.1 Purpose and Scope

This section is informative

This vocabulary defines a set of properties for describing Media Overlays [MediaOverlays3] in the Package Document metadata [Packages3].

This vocabulary is a companion to the EPUB Media Overlays 3 [MediaOverlays3] specification and is intended to be read in conjunction with that document.

  1.2 Referencing

The base IRI for referencing this vocabulary is http://www.idpf.org/epub/vocab/overlays/#.

The prefix "media:" is reserved for use [Packages3] with properties in this vocabulary and does not have to be declared in the Package Document.

  1.3 Terminology

Terms with meanings specific to EPUB 3 are capitalized in this document (e.g., "Author", "Reading System"). A complete list of these terms and definitions is provided in [EPUB3].

Only the first instance of a term in a section is linked to its definition.

  1.4 Conformance Statements

The keywords MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL in this document are to be interpreted as described in [RFC2119].

All sections of this specification are normative except where identified by the informative status label "This section is informative". The application of informative status to sections and appendices applies to all child content and subsections they may contain.

All examples in this specification are informative.

  2 Media Overlays Properties

  2.1 active-class

Name: active-class
Description: Author-defined CSS class name to apply to the currently-playing EPUB Content Document element.
Allowed value(s): xsd:string
Cardinality: Zero or one
Example: <meta property="media:active-class">-epub-media-overlay-active</meta>

  2.2 duration

Name: duration
Description: The duration of the entire presentation or of a specific Media Overlay. The specified durations account for the audio clips known at authoring time, and so exclude live streaming from external resources and speech synthesis.
Allowed value(s):

A clock value.

must be a [SMIL] clock value.

Cardinality: Exactly one for a given Rendition and for each Media Overlay.
Example: <meta property="media:duration">1:36:20</meta>

  2.3 narrator

Name: narrator
Description: Name of the narrator.
Allowed value(s): xsd:string
Cardinality: Zero or more
Example: <meta property="media:narrator">Joe Speaker</meta>

  2.4 playback-active-class

Name: playback-active-class
Description: Author-defined CSS class name to apply to the EPUB Content Document's document element when playback is active.
Allowed value(s): xsd:string
Cardinality: Zero or one
Example: <meta property="media:playback-active-class">-epub-media-overlay-playing</meta>

  References

Normative References

[EPUB3] EPUB 3 .

[MediaOverlays3] EPUB Media Overlays 3 .

[Packages3] EPUB Packages 3 .

[SMIL] SMIL Version 3.0 . D. Bulterman, et al. 01 December 2008.