API for Media Resources 1.0

Abstract

This specification defines an API to access metadata information related to media resources on the Web. The overall purpose is to provide developers with a convenient access to metadata information stored in different metadata formats. The API provides means to access the set of metadata properties defined in the Ontology for Media Resources 1.0 specification. These properties are used as a pivot vocabulary in this API. The core of this specification is the definition of API interfaces for retrieving metadata information in synchronous and asynchronous. It also defines interfaces for structured return types along with the specification of the behavior of an API implementation.

4. API Description

This API defines a number of interfaces using [WEBIDL]. These can be grouped in the following categories:

An interface defining the actual retrieval operations for metadata, called MediaResource, and provided in both synchronous and asynchronous versions (see Section 4.1, Section 4.2 and Section 4.3)
An interface defining the data structure of response objects/metadata annotations, called MediaAnnotation and its specializations (see Section 4.4 and Section 4.5)
An interface defining a data structure for metadata sources, called MetadataSource (see Section 4.6)

Next, the different interfaces and exposed operations are discussed. Implementations of this API must support asynchronous mode of operation, may support the synchronous one and must support the interfaces defined in this document. Instead of exceptions, a status code indicating the state of processing (see Section 4.7) is returned (in the synchronous API) or provided via a callback function (in the asynchronous API) in case an error occurs.

Then, the interfaces for the return types, i.e., MediaAnnotation and its specializations, and MetadataSource are defined.

The IDL fragment in Appendix A of this specification must be interpreted as required for conforming IDL fragments, as described in the �Web IDL� specification. [WEBIDL]

4.1 `MediaResource` interface

The MediaResource interface is the core of this API and provides operations to access the metadata properties of a specific media resource. Here, a clear separation between asynchronous and synchronous mode of operation has been achieved by defining two implementing interfaces (derived from MediaResource), the AsyncMediaResource and the SyncMediaResource interface. Objects of these interfaces will be created by calling createMediaResource of the MediaResource interface. The actual connection to a specified metadata source will be created with the execution of the getMediaProperty operation of AsyncMediaResource or SyncMediaResource interface. The mediaResource argument identifies the media resource, for which the implementation of this API should try to find relevant metadata sources. Optionally, references to metadata sources can be passed using an array of objects, each implementing the MetadataSource interface (see Section 4.6).

interface MediaResource {
    short         getSupportedModes ();
    MediaResource createMediaResource (DOMString mediaResource, optional MetadataSource[] metadataSources, optional short mode);
};

4.1.1 Methods

createMediaResource

This operation instantiates an object of either AsyncMediaResource or SyncMediaResource interface. Further, it allows to set the specific media resource and metadata sources to which this API is applied.

Parameter	Type	Nullable	Optional	Description
mediaResource	`DOMString`	?	?	This attribute must set the specific media resource that should be processed by the API.
metadataSources	`MetadataSource[]`	?	?	This attribute should specify additional metadata sources.
mode	`short`	?	?	This attribute should specify the desired mode of operation. `1` for asynchronous and `2` for synchronous mode should be used. In the case the mode argument is omitted, and the implementation supports both modes, the asynchronous mode will be used.

No exceptions.

Return type: MediaResource

getSupportedModes

This operation is called to identify the implemented mode. The return codes should be as follows: 1 for asynchronous, 2 for synchronous and 3 for both modes.

No parameters.

No exceptions.

Return type: short

4.1.2 Examples in Javascript

Example for getSupportedModes:

ma = new MediaResource();
var mode = ma.getSupportedModes();

/** Resulting in:
 * { "supportedModes" : 3 }
 */

Example for createMediaResource:

metadataSources = new MetadataSource[2];
metadataSources[0] = new MetadataSource(
                         "http://www.w3.org/2008/WebVideo/Annotations/drafts/metadata_formats/DC_example1.xml","dc");
metadataSources[1] = new MetadataSource(
                         "http://www.w3.org/2008/WebVideo/Annotations/wiki/images/9/93/MAWG-Stockholm-20090626.JPG","exif");

mediaResource = new MediaResource();

if (mediaResource.getSupportedModes() == 1 || mediaResource.getSupportedModes() == 3) {
    aSyncObject = mediaResource.createMediaResource(
                         "http://www.w3.org/2008/WebVideo/Annotations/wiki/images/9/93/MAWG-Stockholm-20090626.JPG",
                         metadataSources, 1);
                             
} else if (mediaResource.getSupportedModes() == 2 || mediaResource.getSupportedModes() == 3)  {
    syncObject = mediaResource.createMediaResource(
                         "http://www.w3.org/2008/WebVideo/Annotations/wiki/images/9/93/MAWG-Stockholm-20090626.JPG",
                         metadataSources, 2);
}

4.2 `AsyncMediaResource` interface

The AsyncMediaResource interface provides a number of operations that allow accessing the metadata of a media resource. This interface must be implemented.

Next, we give the Web IDL description of the AsyncMediaResource interface and describe the different operations that are part of it.

In this section the MediaAnnotations interface is used in the interface definitions. It serves as a container to hold general values about properties enabling an iteration over a set of different properties. Its definition can be found in Section 4.4

interface AsyncMediaResource : MediaResource {
    void getMediaProperty (DOMString[] propertyNames, PropertyCallback successCallback, ErrorCallback errorCallback,
       optional DOMString fragment, optional DOMString sourceFormat, optional DOMString language);
    void getOriginalMetadata (DOMString sourceFormat, MetadataCallback successCallback, ErrorCallback errorCallback);
};

4.2.1 Methods

getMediaProperty

This operation allows retrieval of the value of a specific property, several or all properties in an asynchronous manner. The specific property is passed as an argument and a list of objects is returned that hold the values according to the requested property. These objects implement the MediaAnnotation interface, described in Section 4.4. Depending on the requested property, the returned objects implement a different subtypes (inheriting from the MediaAnnotation interface). For example, requesting "title" gives back an array of objects implementing the Title interface, requesting "creator" results in objects implementing the Creator interface and so on. These interfaces are described in Section 4.5. An example can be found here.

Parameter	Type	Nullable	Optional	Description
propertyNames	`DOMString[]`	?	?	This argument identifies an array containing the properties for which the values need to be retrieved. For an empty array all properties carrying values will be retrieved.
successCallback	`PropertyCallback`	?	?	This argument holds a callback object for asynchronous requests to the property. The `successCallback` object implements the `PropertyCallback` interface and holds a `handleEvent` operation that needs to be called once all data for the requested property is gathered. This `handleEvent` operation needs to be called with a new `MediaAnnotation` array.
errorCallback	`ErrorCallback`	?	?	This argument holds a callback object for failure of asynchronous requests to the property. The `errorCallback` object implements the `ErrorCallback` interface and holds a `handleEvent` operation that needs to be called if an attempt fails. This `handleEvent` operation needs to be called with a new DOMString representing the status code of the error (see Section 4.7 for details).
fragment	`DOMString`	?	?	This argument contains a URI identifying the specific media fragment for which the metadata is requested. The URI must conform to the URI for Media Fragment [MEDIA-FRAGMENTS] specification. This parameter is optional.
sourceFormat	`DOMString`	?	?	This argument identifies a specific metadata format. It should use the metadata format identifiers defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]. If a metadata format is defined, only the metadata available in the specified metadata format are retrieved. This parameter is optional.
language	`DOMString`	?	?	This argument allows to identify the language of the metadata. Values for the metadata will only be returned if it is available in the specified language. Recommended best practice is to use BCP 47 [BCP47]. This parameter is optional.

No exceptions.

Return type: void

getOriginalMetadata

This operation allows retrieval of the original metadata according to the specified source format in an asynchronous manner. An example can be found here.

Parameter	Type	Nullable	Optional	Description
sourceFormat	`DOMString`	?	?	This argument identifies a specific metadata format. It should use the metadata format identifiers defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]. If a metadata format is defined, only the metadata available in the specified metadata format are retrieved.
successCallback	`MetadataCallback`	?	?	This argument holds a callback object for asynchronous requests for the original metadata. The `successCallback` object implements the `MetadataCallback` interface and holds a `handleEvent` operation that needs to be called once all properties having values are listed. This `handleEvent` operation needs to be called with a new DOMString array holding the original metadata.
errorCallback	`ErrorCallback`	?	?	This argument holds a callback object for failure of asynchronous requests for the original metadata. The `errorCallback` object implements the `ErrorCallback` interface and holds a `handleEvent` operation that needs to be called if an attempt fails. This `handleEvent` operation needs to be called with a new DOMString representing the status code of the error (see Section 4.7 for details).

No exceptions.

Return type: void

4.2.2 Callback interfaces

4.2.2.1 `PropertyCallback` interface

The PropertyCallback interface holds a handleEvent operation that needs to be called once all data for the requested property has been gathered.

interface PropertyCallback {
    void handleEvent (MediaAnnotation[] mediaAnnotations);
};

4.2.2.1.1 Methods

handleEvent

This operation is called when all data is gathered corresponding to a request for values of one or more properties.

Parameter	Type	Nullable	Optional	Description
mediaAnnotations	`MediaAnnotation[]`	?	?	This argument holds a list of objects with values according to the requested property. These objects implement the `MediaAnnotation` interface, described in Section 4.4. Depending on the requested property, the returned objects implement a different subtypes (inheriting from the `MediaAnnotation` interface).

No exceptions.

Return type: void

4.2.2.2 `MetadataCallback` interface

The MetadataCallback interface holds a handleEvent operation that needs to be called once the requested metadata has been gathered.

interface MetadataCallback {
    void handleEvent (DOMString[] metadata);
};

4.2.2.2.1 Methods

handleEvent

This operation is called when all data is gathered corresponding to a request for the original metadata.

Parameter	Type	Nullable	Optional	Description
metadata	`DOMString[]`	?	?	This argument holds a list of DOMStrings representing the original metadata. Note that, multiple metadata instances can exist (e.g., one Dublin Core and one MPEG-7 document).

No exceptions.

Return type: void

4.2.3 Examples in Javascript

Example for asynchronous getMediaProperty:

aSyncMediaResource = mediaResource.createMediaResource("http://www.imdb.com/title/tt0133152/", new Array(), 1);
aSyncMediaResource.getMediaProperty(["title"], successCallback, errorCallback, "", "", "");
                                
function successCallback(MediaAnnotation[] mediaAnnotations) {
    ...
}

/** Resulting in:
 * [ { "Title" : {
 *         "propertyName" : "title",
 *         "value" : "Planet of the apes",
 *         "language" : en-us",
 *         ...
 *         "statusCode" : 200
 *         }
 * },
 * { "Title" : {
 *         "propertyName" : "title",
 *         "value" : "Monkey Planet",
 *         "language" : en-us",
 *         ...,
 *         "statusCode" : 200
 *         }
 * },
 * { ...
 * } ]
 */
                
function errorCallback(DOMString error) {
    ...
}

/** Resulting in:
 * { error: { "statusCode" : 200 } }
 */

Example for asynchronous getOriginalMetadata :

aSyncMediaResource = mediaResource.createMediaResource(
                         "http://www.w3.org/2008/WebVideo/Annotations/wiki/images/9/93/MAWG-Stockholm-20090626.JPG",
                          new Array(), 1);
aSyncMediaResource.getOriginalMetadata("dc", successCallback, errorCallback);

function successCallback(DOMString[] metadata) {
    ...
}

/** Resulting in:
 * [ { "statusCode" : 200
 * },
 * {"originalMetadata" : "<metadata xmlns='http://example.org/myapp/'
 *                                        xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 *                                        xsi:schemaLocation='http://example.org/myapp/ http://example.org/myapp/schema.xsd'
 *                                        xmlns:dc='http://purl.org/dc/elements/1.1/'>
 *                                          <dc:title>DC title</dc:title>
 *                                  </metadata>"
 * } ]
 */

                                                
function errorCallback(DOMString error) {
   ...
}

/** Resulting in:
 * { error: { "statusCode" : 200 } }
 */

4.3 `SyncMediaResource` interface

The SyncMediaResource interface provides a number of operations to access the metadata of a media resource. This interface may be implemented.

Next, we give the Web IDL description of the SyncMediaResource interface for synchronous requests and describe the different operations that are part of it. The MediaResource defines a constructor that can be called to construct the object based on an identifier of the media resource and optionally some metadata sources.

interface SyncMediaResource : MediaResource {
    MediaAnnotation[] getMediaProperty (DOMString[] propertyNames, optional DOMString fragment,
       optional DOMString sourceFormat, optional DOMString language);
    DOMString[]       getOriginalMetadata (DOMString sourceFormat);
};

4.3.1 Methods

getMediaProperty

This operation allows retrieval of the metadata of a specific property, several or all properties in a synchronous manner. The passed array holds the requested properties and a array of objects is returned. If the array is empty, every property holding values will be requested and returned. The returned objects implement the MediaAnnotation interface (see Section 4.3 ). Depending on the requested property, the returned objects implement different subtypes (inheriting from the MediaAnnotation interface). For example, requesting "title" gives back an array of objects implementing the Title interface, requesting "creator" results in objects implementing the Creator interface and so on. These subtypes are described in Section 4.4. The operation returns a MediaAnnotation array holding the requested properties. If an error occurs during retrieval, a MediaAnnotation object with the corresponding status code (e.g., 400, 404 or 415) will be generated and inserted at the first position of the array. An example can be found here.

Parameter	Type	Nullable	Optional	Description
propertyNames	`DOMString[]`	?	?	This argument holds the requested properties as an array. If the array is empty, each property holding values will be returned.
fragment	`DOMString`	?	?	This argument contains a URI identifying the specific media fragment for which the metadata is requested. The URI must conform to the URI for Media Fragment [MEDIA-FRAGMENTS] specification. This parameter is optional.
sourceFormat	`DOMString`	?	?	This argument identifies a specific metadata format. It should use the metadata format identifiers defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]. If a metadata format is defined, only the metadata available in the specified metadata format is retrieved. This parameter is optional.
language	`DOMString`	?	?	This argument allows to identify the language of the metadata. Values for the metadata will only be returned if it is available in the specified language. Recommended best practice is to use BCP 47 [BCP47]. This parameter is optional.

No exceptions.

Return type: MediaAnnotation[]

getOriginalMetadata

This operation allows retrieval of the original metadata according to the specified source format in a synchronous manner. The operation returns a DOMString array holding the status code of the request at the first and the original metadata at the second position. An example can be found here.

Parameter	Type	Nullable	Optional	Description
sourceFormat	`DOMString`	?	?	This argument identifies a specific metadata format. It should use the metadata format identifiers defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]. If a metadata format is defined, only the metadata available in the specified metadata format is retrieved.

No exceptions.

Return type: DOMString[]

4.3.2 Examples in Javascript

The examples in this section use getMediaProperty() to get an object implementing the MediaAnnotation interface. The noErrorStatus function ensures that no error is present and the requested properties carry values.

We give some JavaScript examples on how to use the synchronous MediaResource interface and it's operations.

Example for synchronous getMediaProperty:

syncMediaResource = mediaResource.createMediaResource("http://www.imdb.com/title/tt0133152/",
                          new Array(), 2);
title = syncMediaResource.getMediaProperty(["title"], "", "", "");

if (noErrorStatus(title[0].statusCode) == true) {
   ...
}                                                

/** Resulting in:
 * [ { "Title" : {
 *         "propertyName" : "title",
 *         "value" : "Planet of the apes",
 *         "language" : en-us",
 *         ...,
 *         "statusCode" : 200
 *         }
 * },
 * { "Title" : {
 *         "propertyName" : "title",
 *         "value" : "Planet der Affen",
 *         "language" : "de-de",
 *         ...,
 *         "statusCode" : 200
 *         }
 * },
 * { ...
 * } ]
 */

Example for synchronous getOriginalMetadata:

syncMediaResource = mediaResource.createMediaResource("http://www.w3.org/2008/WebVideo/Annotations/wiki/images/9/93/MAWG-Stockholm-20090626.JPG",
                         new Array(), 2);
dcMetadata = syncMediaResource.getOriginalMetadata("DC");

if (noErrorStatus(dcMetadata[0].statusCode) == true) {
    ...
}

/** Resulting in:
 * [ { "statusCode" : 200
 * },
 * {"originalMetadata" : "<metadata xmlns='http://example.org/myapp/'
 *                                        xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 *                                        xsi:schemaLocation='http://example.org/myapp/ http://example.org/myapp/schema.xsd'
 *                                        xmlns:dc='http://purl.org/dc/elements/1.1/'>
 *                                          <dc:title>DC title</dc:title>
 *                                  </metadata>"
 * } ]
 */

4.4 `MediaAnnotation` interface

MediaAnnotation interface is used as the return type of MediaResource.getMediaProperty operation. It is a container for holding general values about metadata properties.

As several metadata properties are defined as complex types, specific derived types of MediaAnnotation have been defined, adding their specific attributes. However, MediaAnnotation can be used as a generic return type to access a printable string representation of the property (in the value attribute). It also includes a status code. In case of general errors, the first element of the returned MediaAnnotation array contains the global error code, otherwise the status can be given for each of the returned properties.

The following design considerations have been used for specifying the derived interfaces for each of the metadata properties:

For each metadata property, an interface is derived from MediaAnnotation, adding typed attributes according to the specification in the ontology document.
This API must fill value with a printable string representation, it is recommended to follow these steps:
- use a name/label if present
- for a URI
  - if a URI identifies a value known by this API, use the appropriate label
  - dereference a URI to obtain a label, if possible
  - return the URI
- create a string from the values of the set of attributes (e.g. numeric values)
This approach possibly duplicates a string that is found in another attribute in the value attribute. This is considered as an acceptable amount of redundancy for the benefit of having a generic value field for all metadata properties that can be used regardless of the specific metadata property and data type of the attributes.
If an attribute has type URI|string, the interface shall have two attributes, one with "Link" and one with "Label" appended to the attribute name, representing the URI and string respectively
For consistency, this approach is also followed if the attribute has only either URI or string as type.
This approach allows for user extensions by deriving from MediaAnnotation or one of the derived interfaces for one of the metadata properties.

interface MediaAnnotation {
    attribute DOMString propertyName;
    attribute DOMString value;
    attribute DOMString language;
    attribute DOMString sourceFormat;
    attribute DOMString fragmentIdentifier;
    attribute DOMString mappingType;
    attribute short     statusCode;
};

4.4.1 Attributes

fragmentIdentifier of type DOMString: This attribute should be an URI determining the fragment for which the metadata is relevant.
No exceptions.
language of type DOMString: This attribute should hold the language of the metadata. The attribute is empty if language is not applicable for a specific property. Recommended best practice is to use BCP 47 [BCP47].
No exceptions.
mappingType of type DOMString: This attribute specifies the kind of mapping as discussed in the semantic level mappings. The value of this attribute should be one of the mapping characteristics.
No exceptions.
propertyName of type DOMString: The name of the property must be specified and should correspond to the property names defined in the Ontology for Media Resources 1.0 specification[MEDIA-ONTOLOGY].
sourceFormat of type DOMString: This attribute allows to specify the metadata source from which the metadata was retrieved. It should use the metadata format identifiers defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY].
No exceptions.
statusCode of type short: This attribute must specify the status code for the associated property (e.g., 264 indicating a structured return value).
No exceptions.
value of type DOMString: This attribute must be filled with an printable string representation.
No exceptions.

4.4.2 Example in JavaScript

The noErrorStatus function ensures that no error is present and the requested properties carry values. The MediaAnnotation interface will be never instantiated - only instances of the derived interfaces will be created. These must be filled at least with the parameters specified in the MediaAnnotation interface and may be filled with the specific attributes.

mediaAnnotation = image.getMediaProperty(["title"], "", "", "");

if (noErrorStatus(mediaAnnotation[0].statusCode) == true) {                    
   ...
}

/** Resulting in:
 * [ { "Title" : {
 *         "propertyName" : "title",
 *         "value" : "Gone with the Wind",
 *         "language" : "en-us",
 *         "sourceFormat" : "mpeg7",
 *         "fragmentIdentifier" : "http://www.example.com/video.ogv#t=10,20",
 *         "mappingType" : "Exact match",
 *         "statusCode" : 200
 *         } 
 * } ]

4.5 Properties

This section describes the different properties that can be requested through the MediaResource.getMediaProperty() operation. When invoking this operation, objects implementing the MediaAnnotation interface are returned that represent the specified property. All properties are represented with an interface inherited from the MediaAnnotation interface (following the design guidelines described above).

Several of the following return type interfaces can hold the value of the property as both URI (i.e., a pointer to a controlled vocabulary) or as free text. The URI is preferred, and the respective attribute of the MediaAnnotation interface (or specialized type) shall be filled whenever possible (i.e., when the information is included in or can be constructed from the source metadata).

In the following, for each property, a (synchronous) JavaScript example illustrates the usage of the property specific attributes. In any case, the general attributes of the MediaAnnotation interface could be also requested.

4.5.1 Identification Properties

4.5.1.1 Identifier

When the MediaResource.getMediaProperty operation is invoked with "identifier" as a value of the propertyNames parameter, an object implementing the Identifier interface is returned representing the identifier property (defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY].

interface Identifier : MediaAnnotation {
    attribute DOMString identifierLink;
};

4.5.1.1.1 Attributes

identifierLink of type DOMString: This attribute holds a URI identifying the media resource.
No exceptions.

4.5.1.1.2 Example in JavaScript

id = image.getMediaProperty(["identifier"]);
                                     
/** Resulting in:
 * [ { "Identifier" : {
 *         "propertyName" : "identifier",
 *         "identifierLink" : "urn:uuid:36a87260-1102-11df-8a39-0800200c9a66",                    
 *         "statusCode" : 200
 *         } 
 * } ]
 */

4.5.1.2 Title

When the MediaResource.getMediaProperty operation is invoked with "title" as a value of the propertyNames parameter, an object implementing the Title interface is returned representing the title property (defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY].

interface Title : MediaAnnotation {
    attribute DOMString titleLabel;
    attribute DOMString typeLink;
    attribute DOMString typeLabel;
};

4.5.1.2.1 Attributes

titleLabel of type DOMString: This attribute hold the title as a plain string.
No exceptions.
typeLabel of type DOMString: This attribute holds the type of the title as a plain string.
No exceptions.
typeLink of type DOMString: This attribute holds the type of the title as a URI.
No exceptions.

4.5.1.2.2 Example in JavaScript

title = song.getMediaProperty(["title"]);
                    
/** Resulting in:
 * [ { "Title" : {
 *         "propertyName" : "title",
 *         "titleLabel" : "Artificial Horizon" ,
 *         "typeLink" : "http://www.ebu.ch/metadata/cs/ebu_ObjectTypeCodeCS.xml#21",
 *         "typeLabel" : "Album title",
 *         "statusCode" : 200
 *         }
 * } ]
 */

4.5.1.3 Language

When the MediaResource.getMediaProperty operation is invoked with "language" as a value of the propertyNames parameter, an object implementing the Language interface is returned representing the language property (defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY].

interface Language : MediaAnnotation {
    attribute DOMString languageLink;
    attribute DOMString languageLabel;
};

4.5.1.3.1 Attributes

languageLabel of type DOMString: This attribute represents the language of the media resource as a plain string, which can be filtered on in the getMediaProperty operation. Recommended best practice is to use BCP 47 [BCP47].
No exceptions.
languageLink of type DOMString: This attribute represents the language of the media resource as a URI.
No exceptions.

4.5.1.3.2 Example in JavaScript

language = video.getMediaProperty(["language"]);
        
/** Resulting in:
 * [ { "Language" : {
 *         "propertyName" : "language",
 *         "languageLabel" : "en-us",                    
 *         "statusCode" : 200
 *         }
 * } ]
 */

4.5.1.4 Locator

When the MediaResource.getMediaProperty operation is invoked with "locator" as a value of the propertyNames parameter, an object implementing the Locator interface is returned representing the locator property (defined inthe Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY].

interface Locator : MediaAnnotation {
    attribute DOMString locatorLink;
};

4.5.1.4.1 Attributes

locatorLink of type DOMString: This attribute specifies the location of the media resource by a URI.
No exceptions.

4.5.1.4.2 Example in JavaScript

locator = image.getMediaProperty(["locator"]);

/** Resulting in:
 * [ { "Locator" : {
 *         "propertyName" : "locator",
 *         "locatorLink" : "http://www.w3.org/2008/WebVideo/Annotations/wiki/images/9/93/MAWG-Stockholm-20090626.JPG",                    
 *         "statusCode" : 200
 *         } 
 * } ]
 */

4.5.2 Creation Properties

4.5.2.1 Contributor

When the MediaResource.getMediaProperty operation is invoked with "contributor" as a value of the propertyNames parameter, an object implementing the Contributor interface is returned representing the contributor property (defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY].

interface Contributor : MediaAnnotation {
    attribute DOMString contributorLink;
    attribute DOMString contributorLabel;
    attribute DOMString roleLink;
    attribute DOMString roleLabel;
};

4.5.2.1.1 Attributes

contributorLabel of type DOMString: This attribute represents the contributor (i.e., the agent making the contribution) as a plain string
No exceptions.
contributorLink of type DOMString: This attribute represents the contributor (i.e., the agent making the contribution) as a URI.
No exceptions.
roleLabel of type DOMString: This attribute represents the role of the contributor as a plain string.
No exceptions.
roleLink of type DOMString: This attribute represents the role of the contributor as URI.
No exceptions.

4.5.2.1.2 Example in JavaScript

contributor = video.getMediaProperty(["contributor"]);

/** Resulting in:
 * [ { "Contributor" : {
 *         "propertyName" : "contributor",
 *         "contributorLink" : "http://en.wikipedia.org/wiki/Tim_Burton",
 *         "contributorLabel" : "Tim Burton",
 *         "roleLink" : "http://www.imdb.com/name/nm0000318/",
 *         "roleLabel" : "director",                    
 *         "statusCode" : 200
 *         } 
 * } ]
 */

4.5.2.2 Creator

When the MediaResource.getMediaProperty operation is invoked with "creator" as a value of the propertyNames parameter, an object implementing the Creator interface is returned representing the creator property (defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY].

interface Creator : MediaAnnotation {
    attribute DOMString creatorLink;
    attribute DOMString creatorLabel;
    attribute DOMString roleLink;
    attribute DOMString roleLabel;
};

4.5.2.2.1 Attributes

creatorLabel of type DOMString: This attribute represents the creator (i.e., the agent participating in the creation of the media resource) as a plain string.
No exceptions.
creatorLink of type DOMString: This attribute represents the creator (i.e., the agent participating in the creation of the media resource) as a URI.
No exceptions.
roleLabel of type DOMString: This attribute represents the role of the creator as a plain string.
No exceptions.
roleLink of type DOMString: This attribute represents the role of the creator as URI.
No exceptions.

4.5.2.2.2 Example in JavaScript

creator = video.getMediaProperty(["creator"]);

/** Resulting in:
 * [ { "Creator" : {
 *         "propertyName" : "creator",
 *         "creatorLink" : "http://dbpedia.org/resource/William_Shakespeare",
 *         "creatorLabel" : "William Shakespeare",
 *         "roleLink" : "http://www.ebu.ch/metadata/cs/ebu_RoleCodeCS.xml#22.5",
 *         "roleLabel" : "playwright",                    
 *         "statusCode" : 200
 *         }
 * } ]
 */

4.5.2.3 MADate

When the MediaResource.getMediaProperty operation is invoked with "date" as a value of the propertyNames parameter, an object implementing the Date interface is returned representing the date property (defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]). This property has been renamed from "Date" into "MADate" in order to avoid naming conflicts with other objects named "Date" in web applications.

interface MADate : MediaAnnotation {
    attribute DOMString date;
    attribute DOMString typeLink;
    attribute DOMString typeLabel;
};

4.5.2.3.1 Attributes

date of type DOMString: This attribute represents a date related to the media resource. A date value must be represented using one of the specific date/time data types of XML Schema, depending on the available precision: gYear gYearMonth, date, dateTime, or dateTimeStamp.
No exceptions.
typeLabel of type DOMString: This attribute defines the category of date (e.g. creation date, broadcast date, release date, date recorded and date edited) as a plain string.
No exceptions.
typeLink of type DOMString: This attribute defines the category of date (e.g. creation date, broadcast date, release date, date recorded and date edited) as a URI.
No exceptions.

4.5.2.3.2 Example in JavaScript

maDate = video.getMediaProperty(["date"]);

/** Resulting in:
 * [ { "MADate" : {
 *         "propertyName" : "date",
 *         "date": "2009-06-26T15:30:00",
 *         "typeLink" : "urn:smpte:ul:06.0E.2B.34.01.01.01.02.07.02.01.10.02.03.00.00",
 *         "typeLabel" : "modification date",
 *         "statusCode" : 200
 *         }
 * } ]
 */

4.5.2.4 Location

When the MediaResource.getMediaProperty operation is invoked with "location" as a value of the propertyNames parameter, an object implementing the Location interface is returned representing the location property (defined inthe Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]).

interface Location : MediaAnnotation {
    attribute DOMString locationLink;
    attribute DOMString locationLabel;
    attribute double    longitude;
    attribute double    latitude;
    attribute double    altitude;
    attribute DOMString coordinateSystemLabel;
    attribute DOMString coordinateSystemLink;
};

4.5.2.4.1 Attributes

altitude of type double: This attribute holds the altitude of the location, w.r.t. the coordinate system specified by the coordiateSystem attribute.
No exceptions.
coordinateSystemLabel of type DOMString: This attribute identified the coordinate system used by its name.
No exceptions.
coordinateSystemLink of type DOMString: This attribute identified the coordinate system used by a URI.
No exceptions.
latitude of type double: This attribute holds the latitude of the location, w.r.t. the coordinate system specified by the coordiateSystem attribute.
No exceptions.
locationLabel of type DOMString: This attribute identifies the location by its name as a plain string.
No exceptions.
locationLink of type DOMString: This attribute identifies the location as a URI.
No exceptions.
longitude of type double: This attribute holds the longitude of the location, w.r.t. the coordinate system specified by the coordiateSystem attribute.
No exceptions.

4.5.2.4.2 Example in JavaScript

location = video.getMediaProperty(["location"]);

/** Resulting in:
 * [ { "Location" : {
 *         "propertyName" : "location",
 *         "locationLink" : "http://en.wikipedia.org/wiki/San_Jose,_California",
 *         "locationLabel" : "San Jose",
 *         "longitude" : 37.33986481118008,
 *         "latitude" : -121.88507080078125,
 *         "altitude" : 0,
 *         "coordinateSystemLabel" : "WGS84",
 *         "coordinateSystemLink" : "http://www.w3.org/2003/01/geo/wgs84_pos#Point",
 *         "statusCode" : 200
 *         }
 * } ]
 */

4.5.3 Content Properties

4.5.3.1 Description

When the MediaResource.getMediaProperty operation is invoked with "description" as a value of the propertyNames parameter, an object implementing the Description interface is returned representing the description property (defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]).

interface Description : MediaAnnotation {
    attribute DOMString descriptionLabel;
};

4.5.3.1.1 Attributes

descriptionLabel of type DOMString: This attribute contains a description of the content of the media resource.
No exceptions.

4.5.3.1.2 Example in Javascript

description = image.getMediaProperty(["description"]);

/** Resulting in:
 * [ { "Description" : {
 *         "propertyName" : "description",
 *         "descriptionLabel" : "Group picture of the W3C MAWG at the F2F meeting in Stockholm.",
 *         "statusCode" : 200
 *         }
 * } ]
 */

4.5.3.2 Keyword

When the MediaResource.getMediaProperty operation is invoked with "keyword" as a value of the propertyNames parameter, an object implementing the Keyword interface is returned representing the keyword property (defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]).

interface Keyword : MediaAnnotation {
    attribute DOMString keywordLabel;
    attribute DOMString keywordLink;
};

4.5.3.2.1 Attributes

keywordLabel of type DOMString: This attribute contains a keyword describing the content as a plain string.
No exceptions.
keywordLink of type DOMString: This attribute contains a URI representing a keyword describing the content.
No exceptions.

4.5.3.2.2 Example in Javascript

keyword = image.getMediaProperty(["keyword"]);

/** Resulting in:
 * [ { "Keyword" : {
 *         "propertyName" : "keyword",
 *         "keywordLabel" : "meeting with people from outside the organisation",
 *         "keywordLink" : "http://sw.opencyc.org/2008/06/10/concept/en/MeetingWithOrganizationalOutsiders",                    
 *         "statusCode" : 200
 *         }
 * }, 
 * { "Keyword" : {
 *         "propertyName" : "keyword",
 *         "keywordLabel" : "standardisation",
 *         "keywordLink" : "http://purl.org/vocabularies/princeton/wn30/synset-standardization-noun-1",                    
 *         "statusCode" : 200
 *         } 
 * } ]
 */

4.5.3.3 Genre

When the MediaResource.getMediaProperty operation is invoked with "genre" as a value of the propertyNames parameter, an object implementing the Genre interface is returned representing the genre property (defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]).

interface Genre : MediaAnnotation {
    attribute DOMString genreLabel;
    attribute DOMString genreLink;
};

4.5.3.3.1 Attributes

genreLabel of type DOMString: This attribute represents the genre of the media resource as a plain string.
No exceptions.
genreLink of type DOMString: This attribute represents the genre of the media resource as a URI.
No exceptions.

4.5.3.3.2 Example in Javascript

genre = image.getMediaProperty(["genre"]);

/** Resulting in:
 * [ { "Genre" : {
 *         "propertyName" : "genre",
 *         "genreLabel" : "Sports",
 *         "genreLink" : "http://www.ebu.ch/metadata/cs/ebu_ContentGenreCS.xml#3.1.1.9"                    
 *         "statusCode" : 200
 *         } 
 * } ]
 */

4.5.3.4 Rating

When the MediaResource.getMediaProperty operation is invoked with "rating" as a value of the propertyNames parameter, an object implementing the Rating interface is returned representing the rating property (defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]).

interface Rating : MediaAnnotation {
    attribute double    ratingValue;
    attribute DOMString ratingSystemLabel;
    attribute DOMString ratingSystemLink;
    attribute double    minimum;
    attribute double    maximum;
};

4.5.3.4.1 Attributes

maximum of type double: This attribute specifies the maximum rating value in the rating system.
No exceptions.
minimum of type double: This attribute specifies the minimum rating value in the rating system.
No exceptions.
ratingSystemLabel of type DOMString: This attribute identifies the rating system by a plain string.
No exceptions.
ratingSystemLink of type DOMString: This attribute identifies the rating system as a URI.
No exceptions.
ratingValue of type double: This attribute contains the value of the rating.
No exceptions.

4.5.3.4.2 Example in Javascript

rating = image.getMediaProperty(["rating"]);

/** Resulting in:
 * [ { "Rating" : {
 *         "propertyName" : "rating",
 *         "ratingValue" : 10.0,
 *         "ratingSystemLabel" : "John Doe",
 *         "ratingSystemLink" : "http://individuals.example.com/JohnDoe",
 *         "minimum" : 0,
 *         "maximum" : 10.0,                    
 *         "statusCode" : 200
 *         } 
 * } ]
 */

4.5.4 Relational Properties

4.5.4.1 Relation

When the MediaResource.getMediaProperty operation is invoked with "relation" as a value of the propertyNames parameter, an object implementing the Relation interface is returned representing the relation property (defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]).

interface Relation : MediaAnnotation {
    attribute DOMString targetLink;
    attribute DOMString targetLabel;
    attribute DOMString typeLink;
    attribute DOMString typeLabel;
};

4.5.4.1.1 Attributes

targetLabel of type DOMString: This attribute identifies the related resource by a plain string.
No exceptions.
targetLink of type DOMString: This attribute identifies the related resource by a URI.
No exceptions.
typeLabel of type DOMString: This attribute specifies the type of relationship by a plain string.
No exceptions.
typeLink of type DOMString: This attribute specifies the type of relationship by a URI.
No exceptions.

4.5.4.1.2 Example in Javascript

relation = image.getMediaProperty(["relation"]);

/** Resulting in:
 * [ { "Relation" : {
 *         "propertyName" : "relation",
 *         "targetLink" : "http://www.w3.org/2008/WebVideo/Annotations/wiki/Image:MAWG-Stockholm-20090626_thumb.JPG",
 *         "targetLabel" : "Group picture of MAWG in Stockholm",
 *         "typeLink" : "http://www.ebu.ch/metadata/cs/ebu_HowRelatedCS.xml#19",
 *         "typeLabel" : "thumbnail",                    
 *         "statusCode" : 200
 *         }
 * } ]
 */

4.5.4.2 Collection

When the MediaResource.getMediaProperty operation is invoked with "collection" as a value of the propertyNames parameter, an object implementing the Collection interface is returned representing the collection property (defined inthe Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]).

interface Collection : MediaAnnotation {
    attribute DOMString collectionLink;
    attribute DOMString collectionLabel;
};

4.5.4.2.1 Attributes

collectionLabel of type DOMString: This attribute holds the name of the collection from which the media resource originates as a plain string.
No exceptions.
collectionLink of type DOMString: This attribute holds the name of the collection from which the media resource originates as URI.
No exceptions.

4.5.4.2.2 Example in Javascript

collection = image.getMediaProperty(["collection"]);

/** Resulting in:
 * [ { "Collection" : {
 *         "propertyName" : "collection",
 *         "collectionLink" : "http://individuals.example.com/JohnDoe/myWorkPictures/",
 *         "collectionLabel" : "My Work Pictures",                    
 *         "statusCode" : 200
 *         } 
 * } ]
 */

4.5.5 Rights Properties

4.5.5.1 Copyright

When the MediaResource.getMediaProperty operation is invoked with "copyright" as a value of the propertyNames parameter, an object implementing the Copyright interface is returned representing the copyright property (defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]).

interface Copyright : MediaAnnotation {
    attribute DOMString copyrightLabel;
    attribute DOMString holderLabel;
    attribute DOMString holderLink;
};

4.5.5.1.1 Attributes

copyrightLabel of type DOMString: This attribute contains the copyright statement as a plain string.
No exceptions.
holderLabel of type DOMString: This attribute identifies the copyright holder by a plain string.
No exceptions.
holderLink of type DOMString: This attribute identified the copyright holder by a URI.
No exceptions.

4.5.5.1.2 Example in Javascript

copyright = image.getMediaProperty(["copyright"]);

/** Resulting in:
 * [ { "Copyright" : {
 *         "propertyName" : "copyright",
 *         "copyrightLabel" : "All images in the collection are copyrighted by John Doe.",
 *         "holderLabel" : "John Doe",
 *         "holderLink" : "http://individuals.example.com/JohnDoe",                    
 *         "statusCode" : 200
 *         } 
 * } ]
 */

4.5.5.2 Policy

When the MediaResource.getMediaProperty operation is invoked with "policy" as a value of the propertyNames parameter, an object implementing the Policy interface is returned representing the policy property (defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]).

interface Policy : MediaAnnotation {
    attribute DOMString statementLink;
    attribute DOMString statementLabel;
    attribute DOMString typeLink;
    attribute DOMString typeLabel;
};

4.5.5.2.1 Attributes

statementLabel of type DOMString: This attribute contains a plain string of the policy statement.
No exceptions.
statementLink of type DOMString: This attribute contains a URI of the policy statement.
No exceptions.
typeLabel of type DOMString: This attribute identifies the type of the policy as a URI as a plain string.
No exceptions.
typeLink of type DOMString: This attribute identifies the type of the policy as a URI.
No exceptions.

4.5.5.2.2 Example in Javascript

policy = image.getMediaProperty(["policy"]);

/** Resulting in:
 * [ { "Policy" : {
 *         "propertyName" : "policy",
 *         "statementLink" : "http://creativecommons.org/licenses/by/2.5/",
 *         "statementLabel" : "Attribution 2.5 Generic (CC BY 2.5)",
 *         "typeLabel" : "license",                    
 *         "statusCode" : 200
 *         }
 * } ]
 */

4.5.6 Distribution Properties

4.5.6.1 Publisher

When the MediaResource.getMediaProperty operation is invoked with "publisher" as a value of the propertyNames parameter, an object implementing the Publisher interface is returned representing the publisher property (defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]).

interface Publisher : MediaAnnotation {
    attribute DOMString publisherLink;
    attribute DOMString publisherLabel;
};

4.5.6.1.1 Attributes

publisherLabel of type DOMString: This attribute represents the publisher as a plain string.
No exceptions.
publisherLink of type DOMString: This attribute represents the publisher as a URI.
No exceptions.

4.5.6.1.2 Example in Javascript

publisher = image.getMediaProperty(["publisher"]);

/** Resulting in:
 * [ { "Publisher" : {
 *         "propertyName" : "publisher",
 *         "publisherLabel" : "ACME",
 *         "publisherLink" : "http://company.example.com/ACME",                    
 *         "statusCode" : 200
 *         } 
 * } ]
 */

4.5.6.2 TargetAudience

When the MediaResource.getMediaProperty operation is invoked with "targetAudience" as a value of the propertyNames parameter, an object implementing the TargetAudience interface is returned representing the targetAudience property (defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]).

interface TargetAudience : MediaAnnotation {
    attribute DOMString audienceLink;
    attribute DOMString audienceLabel;
    attribute DOMString classificationSystemLink;
    attribute DOMString classificationSystemLabel;
};

4.5.6.2.1 Attributes

audienceLabel of type DOMString: This attribute identifies the target audience by a plain string.
No exceptions.
audienceLink of type DOMString: This attribute identifies the target audience by a URI.
No exceptions.
classificationSystemLabel of type DOMString: This attribute specifies the classification system by a plain string.
No exceptions.
classificationSystemLink of type DOMString: This attribute specifies the classification system by a URI.
No exceptions.

4.5.6.2.2 Example in Javascript

targetAudience = image.getMediaProperty(["targetAudience"]);

/** Resulting in:
 * [ { "TargetAudience" : {
 *         "propertyName" : "targetAudience",
 *         "audienceLink" : "http://www.mpaa.org/ratings/what-each-rating-means#NC-17",
 *         "audienceLabel" : "No One 17 and Under Admitted",
 *         "classificationSystemLink" : "http://www.mpaa.org/ratings",
 *         "classificationSystemLabel" : "MPAA",                    
 *         "statusCode" : 200
 *         }
 * } ]
 */

4.5.7 Fragments Properties

4.5.7.1 Fragment

When the MediaResource.getMediaProperty operation is invoked with "fragment" as a value of the propertyNames parameter, an object implementing the Fragment interface is returned representing the fragment property (defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]).

interface Fragment : MediaAnnotation {
    attribute DOMString identifier;
    attribute DOMString roleLink;
    attribute DOMString roleLabel;
};

4.5.7.1.1 Attributes

identifier of type DOMString: This attribute identifies the fragment as Media Fragment URI (temporal, spatial or track).
No exceptions.
roleLabel of type DOMString: This attribute identifies the role of the fragment as a plain string, which can be filtered on in the getMediaProperty operation.
No exceptions.
roleLink of type DOMString: This attribute identifies the role of the fragment as a URI, which can be filtered on in the getMediaProperty operation.
No exceptions.

4.5.7.1.2 Example in Javascript

fragment = movie.getMediaProperty(["fragment"]);

/** Resulting in:
 * [ { "Fragment" : {
 *         "propertyName" : "fragment",
 *         "identifier" : "http://www.example.com/video.ogv#t=10,20",
 *         "roleLabel" : "chapter",                    
 *         "statusCode" : 200
 *         }
 * } ]
 */

4.5.7.2 NamedFragment

When the MediaResource.getMediaProperty operation is invoked with "namedFragment" as a value of the propertyNames parameter, an object implementing the NamedFragment interface is returned representing the namedFragment property (defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]).

interface NamedFragment : MediaAnnotation {
    attribute DOMString identifier;
    attribute DOMString label;
};

4.5.7.2.1 Attributes

identifier of type DOMString: This attribute identifies a named fragment by a Media Fragment URI.
No exceptions.
label of type DOMString: This attribute contains a plain text label of a named media fragment, which can be used to contruct a Media Fragment URI fro a named fragment.
No exceptions.

4.5.7.2.2 Example in Javascript

namedFragment = movie.getMediaProperty(["namedFragment"]);

/** Resulting in:
 * [ { "NamedFragment" : {
 *         "propertyName" : "namedFragment",
 *         "identifier" : "http://www.example.com/video.ogv#t=30,35",
 *         "label" : "kissScene",
 *         "statusCode" : 200
 *         } 
 * } ]
 */

4.5.8 Technical Properties

4.5.8.1 FrameSize

When the MediaResource.getMediaProperty operation is invoked with "frameSize" as a value of the propertyNames parameter, an object implementing the FrameSize interface is returned representing the frameSize property (defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]).

interface FrameSize : MediaAnnotation {
    attribute double    width;
    attribute double    height;
    attribute DOMString unit;
};

4.5.8.1.1 Attributes

height of type double: This attribute represents the height of the frame.
No exceptions.
unit of type DOMString: This attribute represents the unit of the frame width/height. The default value is pixels.
No exceptions.
width of type double: This attribute represents the width of the frame.
No exceptions.

4.5.8.1.2 Example in Javascript

frameSize = image.getMediaProperty(["frameSize"]);

/** Resulting in:
 * [ { "FrameSize" : {
 *         "propertyName" : "framesize",
 *         "width" : 3072,
 *         "height" : 2304,
 *         "unit" : "pixels",                    
 *         "statusCode" : 200
 *         } 
 * } ]
 */

4.5.8.2 Compression

When the MediaResource.getMediaProperty operation is invoked with "compression" as a value of the propertyNames parameter, an object implementing the Compression interface is returned representing the compression property (defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]).

interface FrameSize : MediaAnnotation {
    attribute DOMString compressionLink;
    attribute DOMString compressionLabel;
};

4.5.8.2.1 Attributes

compressionLabel of type DOMString: This attribute specifies the compression type of the media resource as a plain string.
No exceptions.
compressionLink of type DOMString: This attribute specifies the compression type of the media resource by a URI.
No exceptions.

4.5.8.2.2 Example in Javascript

compression = video.getMediaProperty(["compression"]);

/** Resulting in:
 * [ { "Compression" : {
 *         "propertyName" : "compression",
 *         "compressionLabel" : "H.264/AVC",
 *         "compressionLink" : "urn:example-org:codingnames2010#ITU-H264",                    
 *         "statusCode" : 200
 *         } 
 * } ]
 */

4.5.8.3 Duration

When the MediaResource.getMediaProperty operation is invoked with "duration" as a value of the propertyNames parameter, an object implementing the Duration interface is returned representing the duration property (defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]).

interface Duration : MediaAnnotation {
    attribute double duration;
};

4.5.8.3.1 Attributes

duration of type double: This attribute represents the duration of the media resource (in seconds) as an double value.
No exceptions.

4.5.8.3.2 Example in Javascript

duration = video.getMediaProperty(["duration"]);
                    
/** Resulting in:
 * [ { "Duration" : {
 *         "propertyName" : "duration",
 *         "duration" : 3600,                    
 *         "statusCode" : 200
 *         } 
 * } ]
 */

4.5.8.4 Format

When the MediaResource.getMediaProperty operation is invoked with "format" as a value of the propertyNames parameter, an object implementing the Format interface is returned representing the format property (defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]).

interface Format : MediaAnnotation {
    attribute DOMString formatLink;
    attribute DOMString formatLabel;
};

4.5.8.4.1 Attributes

formatLabel of type DOMString: This attribute specifies the MIME type of the media resource.
No exceptions.
formatLink of type DOMString: This attribute identifies the MIME type of the media resource by a URI.
No exceptions.

4.5.8.4.2 Example in Javascript

format = image.getMediaProperty(["format"]);

/** Resulting in:
 * [ { "Format" : {
 *         "propertyName" : "format",
 *         "formatLabel" : "image/jpeg",
 *         "formatLink" : "http://dbpedia.org/resource/JPEG",                    
 *         "statusCode" : 200
 *         } 
 * } ]
 */

4.5.8.5 SamplingRate

When the MediaResource.getMediaProperty operation is invoked with "samplingRate" as a value of the propertyNames parameter, an object implementing the SamplingRate interface is returned representing the samplingRate property (defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]).

interface SamplingRate : MediaAnnotation {
    attribute double samplingRate;
};

4.5.8.5.1 Attributes

samplingRate of type double: This attribute specifies the samplingrate (in Hz) as a double.
No exceptions.

4.5.8.5.2 Example in Javascript

samplingrate = audio.getMediaProperty(["samplingRate"]);

/** Resulting in:
 * [ { "SamplingRate" : {
 *         "propertyName" : "samplingRate",
 *         "samplingRate" : 44100,                    
 *         "statusCode" : 200
 *         } 
 * } ]
 */

4.5.8.6 FrameRate

When the MediaResource.getMediaProperty operation is invoked with "frameRate" as a value of the propertyNames parameter, an object implementing the FrameRate interface is returned representing the frameRate property (defined inthe Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]).

interface FrameRate : MediaAnnotation {
    attribute double frameRate;
};

4.5.8.6.1 Attributes

frameRate of type double: This attribute specifies the framerate (in fps) as a double value.
No exceptions.

4.5.8.6.2 Example in Javascript

framerate = video.getMediaProperty(["frameRate"]);

/** Resulting in:
 * [ { "FrameRate" : {
 *         "propertyName" : "frameRate",
 *         "frameRate" : 30,                    
 *         "statusCode" : 200
 *         } 
 * } ]
 */

4.5.8.7 AverageBitRate

When the MediaResource.getMediaProperty operation is invoked with "averageBitRate" as a value of the propertyNames parameter, an object implementing the AverageBitRate interface is returned representing the averageBitRate property (defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]).

interface AverageBitRate : MediaAnnotation {
    attribute double averageBitRate;
};

4.5.8.7.1 Attributes

averageBitRate of type double: This attribute specifies the average bitrate (in kbps) as a double value.
No exceptions.

4.5.8.7.2 Example in Javascript

bitrate = video.getMediaProperty(["averageBitRate"]);

/** Resulting in:
 * [ { "AverageBitRate" : {
 *         "propertyName" : "averageBitRate",
 *         "averageBitRate" : 45.06,                    
 *         "statusCode" : 200
 *         }
 * } ]
 */

4.5.8.8 NumTracks

When the MediaResource.getMediaProperty operation is invoked with "numTracks" as a value of the propertyNames parameter, an object implementing the NumTracks interface is returned representing the numTracks property (defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY]).

interface NumTracks : MediaAnnotation {
    attribute short     number;
    attribute DOMString typeString;
};

4.5.8.8.1 Attributes

number of type short: This attribute specifies the number of tracks as an integer value.
No exceptions.
typeString of type DOMString: This attribute specifies the type of the tracks that are counted as a plain string (e.g., audio, subtitle).
No exceptions.

4.5.8.8.2 Example in Javascript

numTracks = video.getMediaProperty(["numTracks"]);

/** Resulting in:
 * [ { "NumTracks" : {
 *         "propertyName" : "numTracks",
 *         "number" : 2,
 *         "typeString" : "audio",                    
 *         "statusCode" : 200
 *         }
 * } ]
 */

4.6 `MetadataSource` interface

MetadataSource interface is used to identify other metadata sources.

interface MetadataSource {
    attribute DOMString metadataSource;
    attribute DOMString sourceFormat;
};

4.6.1 Attributes

metadataSource of type DOMString: An URI identifying the metadata source.
No exceptions.
sourceFormat of type DOMString: The name of the actual metadata format. It should use the metadata format identifiers defined in the Ontology for Media Resources 1.0 specification [MEDIA-ONTOLOGY].
No exceptions.

4.6.2 Examples in Javascript

metadataSource = new MetadataSource("http://www.w3.org/2008/WebVideo/Annotations/drafts/metadata_formats/DC_example1.xml","dc");

4.7 API Status Codes

This section introduces a set of status codes for the defined API to indicate the system behavior. As described in section 4.4, the status code is returned as one of the attributes of the MediaAnnotation object returned by a method call to the API. These status codes are used on the API level, and applied to either client side or server side implementations.

Numerical Code	Textual Description	Example
200	OK	property delivered correctly
204	No Content	property retrieved without content
206	Partial Content	only a subset of the available data stored in the result set
400	Bad Request	syntactical error
404	Not Found	the queries resource is not found
415	Unsupported Media Type	get duration call on an image data store
462	Property not defined in Source Format	location is not defined in MediaRSS
500	Internal Server Error	internal library (e.g., extractor) crashes
562	Property not supported	a subset of properties implemented

6. Implementation Notes

This section contains recommendations for implementators for handling missing or multiple identifiers of media resources/fragments as well as for interoperability of implementations.

6.1 Multiple identifiers of media resources or fragments

In some source formats, it could be possible to identify the resource or one of its fragments in multiple ways, e.g. by one or more identifiers, fragment name or temporal/spatial fragment URIs. For example, there could be a temporal media fragment, which can be addressed by the time range, that also has an assigned ID.

In the RDF representation of the Ontology for Media Resources, this can be represented (as recommended in the guidelines) by using owl:sameAs. To ensure a similar behaviour in the API, an implementation should return all such identifiers in a response. If queries to properties of a fragment with multiple identifiers are made, the implementation should accept each of the alternative identifiers and return the same response for each of them.

6.2 Missing fragment identifiers

There are source formats, which may contain metadata about a fragment (e.g. a track) without specifying any kind of identifier for it. For the RDF representation this is not a problem, as blank nodes can be used. In an API implementation, a client requesting the list of fragments cannot query properties of a fragment in case there is no identifier.

An implementation should generate an identifier for the fragment in such a case and should ensure that it is valid for a sufficiently long time so that the client can use it in subsequent queries to properties of fragments. The identifier is not guaranteed to remain permanently valid.

This can be implemented in different ways, including the following:

In a session-aware environment (e.g., in the user agent, in a web service environment with session handling), the identifier could be bound to the session and remain valid at least for the duration of the session.
In a stateless environment, the identifier could be the same for all clients and remain valid a defined time after it has been last used (i.e., part of a query or response).
The identifier could be defined to be unique and permanent. In that case the implementation has to manage the assignment of identifiers to metadata sources.

6.3 Interoperability of Implementations

The API can be implemented in two different modes. The asynchronous mode is mandatory while the synchrounous one is optional. In this context, interoperability between these modes would be a desired feature in order to provide both processing modes based on the implementation of one mode only.

An implementation of the optional synchronous mode of the API (e.g. in a Web Service) is turned into the mandatory asynchronous communication by a wrapper. Therefore the required wrapper functionality is implemented in JavaScript using the Web Workers specification [WEBWORKERS] processing non-blocking scripts. A demo of the wrapper code can be downloaded from [MAWG-REPO]. First, the existing operations of the MediaResource interface are adapted in order to support the synchronous as well as asynchronous mode (mawg_api.js). Then, the implementation of the AsyncMediaResource interface wrapping the synchronous communication is added. Therefore, the two operations of the AsyncMediaResource interface (getMediaProperty and getOriginalMetadata) refer to the corresponding synchronous calls by Web Workers (media_property_worker.js, media_property_worker.js). Finally, the result of the synchronous communication is pushed forward to the synchronous operation by invoking a callback function.

Wrapping an asynchronous implementation by an synchronous call is infeasible in JavaScript since threads cannot be suspended and interact with concurrent ones. Nonetheless, another programming language (e.g. Java), can be used to warp asynchronous API calls in web service calls.

7. Security Considerations

This specification defines a API to access metadata information related to media resources on the Web. These APIs will provide means for requesting metadata information, which can already be accessed in one or different formats, either as separate document or embedded in media resources. As such, this API introduces no additional security issue.

One should nevertheless note that some metadata could be used to access personal information about someone without declaration of agreement. For example, temporal and geographic information about a media resource could indirectly provide information about its creator.

There are related activities and technical documents in W3C working on this topics, such as Policy Requirements [POLICY-REQS] in DAP WG, ODRL 1.1 [ODRL11], P3P 1.1 [P3P11] and PLING Wiki [PLING-WIKI].

A. Web IDL description

Follow this link to download the WebIDL description as IDL file.

interface MediaResource {
    short getSupportedModes();
    MediaResource createMediaResource(DOMString mediaResource,
                optional MetadataSource[] metadataSources, optional short mode);
};

interface AsyncMediaResource : MediaResource {
    void getMediaProperty(DOMString[] propertyNames, PropertyCallback successCallback, ErrorCallback errorCallback,
                optional DOMString fragment, optional DOMString sourceFormat, optional DOMString language );
    void getOriginalMetadata (DOMString sourceFormat, MetadataCallback successCallback, ErrorCallback errorCallback);
};

interface PropertyCallback {
    void handleEvent (MediaAnnotation[] mediaAnnotations);
};

interface MetadataCallback {
   void handleEvent (DOMString[] metadata);
};

interface ErrorCallback {
   void handleEvent (DOMString errorStatus);
};

interface SyncMediaResource : MediaResource {
    MediaAnnotation[] getMediaProperty(DOMString[] propertyNames,
                   optional DOMString fragment, optional DOMString sourceFormat,
                   optional DOMString language);
    DOMString[] getOriginalMetadata (DOMString sourceFormat);
};

interface MetadataSource {
   attribute DOMString metadataSource;
   attribute DOMString sourceFormat;
};

interface MediaAnnotation {
   attribute DOMString propertyName;
   attribute DOMString value;
   attribute DOMString language;
   attribute DOMString sourceFormat;
   attribute DOMString fragmentIdentifier;
   attribute DOMString mappingType;
   attribute short     statusCode;
};

interface Identifier : MediaAnnotation {
   attribute DOMString identifierLink;
};

interface Title : MediaAnnotation {
   attribute DOMString titleLabel;
   attribute DOMString typeLink;
   attribute DOMString typeLabel;
};

interface Language : MediaAnnotation {
   attribute DOMString languageLink;
   attribute DOMString languageLabel;
};  

interface Locator : MediaAnnotation {
   attribute DOMString locatorLink;
};

interface Contributor : MediaAnnotation {
   attribute DOMString contributorLink;
   attribute DOMString contributorLabel;
   attribute DOMString roleLink;
   attribute DOMString roleLabel;
};

interface Creator : MediaAnnotation {
   attribute DOMString creatorLink;
   attribute DOMString creatorLabel;
   attribute DOMString roleLink;
   attribute DOMString roleLabel;
};

interface MADate : MediaAnnotation {
   attribute DOMString date; 
   attribute DOMString typeLink;
   attribute DOMString typeLabel;
};

interface Location : MediaAnnotation {
   attribute DOMString locationLink;
   attribute DOMString locationLabel;
   attribute double    longitude;
   attribute double    latitude;
   attribute double    altitude;
   attribute DOMString coordinateSystemLabel;
   attribute DOMString coordinateSystemLink;
};

interface Description : MediaAnnotation {
   attribute DOMString descriptionLabel;
};

interface Keyword : MediaAnnotation {
   attribute DOMString keywordLink;
   attribute DOMString keywordLabel;
};

interface Genre : MediaAnnotation {
   attribute DOMString genreLink;
   attribute DOMString genreLabel;
};

interface Rating : MediaAnnotation {
   attribute double ratingValue;
   attribute DOMString ratingSystemLink;
   attribute DOMString ratingSystemLabel;
   attribute double    min;
   attribute double    max; 
};

interface Relation : MediaAnnotation {
   attribute DOMString targetLink;
   attribute DOMString targetLabel;
   attribute DOMString typeLink;
   attribute DOMString typeLabel;
};

interface Collection : MediaAnnotation {
    attribute DOMString collectionLink;
    attribute DOMString collectionLabel;
};

interface Copyright : MediaAnnotation {
   attribute DOMString copyrightLabel;
   attribute DOMString holderLink;
   attribute DOMString holderLabel;
};

interface Policy : MediaAnnotation {
   attribute DOMString statementLink;
   attribute DOMString statementLabel;
   attribute DOMString typeLink;
   attribute DOMString typeLabel;
};

interface Publisher : MediaAnnotation {
   attribute DOMString publisherLink;
   attribute DOMString publisherLabel;
};

interface TargetAudience : MediaAnnotation {
   attribute DOMString audienceLink;
   attribute DOMString audienceLabel;
   attribute DOMString classificationSystemLink;
   attribute DOMString classificationSystemLabel;
};

interface Fragment : MediaAnnotation {
   attribute DOMString identifier;
   attribute DOMString roleLink;
   attribute DOMString roleLabel;
};

interface NamedFragment : MediaAnnotation {
   attribute DOMString identifier;
   attribute DOMString label;
};

interface FrameSize : MediaAnnotation {
   attribute double width;
   attribute double height;
   attribute DOMString unit;
};

interface Compression : MediaAnnotation {
    attribute DOMString compressionLink;
    attribute DOMString compressionLabel;
};

interface Duration : MediaAnnotation {
    attribute double duration;
};

interface Format : MediaAnnotation {
    attribute DOMString formatLink;
    attribute DOMString formatLabel;
};

interface SamplingRate : MediaAnnotation {
    attribute double samplingRate;
};

interface FrameRate : MediaAnnotation {
   attribute double frameRate;
}; 

interface AverageBitRate : MediaAnnotation {
   attribute double averageBitRate;
};

interface NumTracks : MediaAnnotation {
    attribute short  number;
    attribute DOMString typeString;
};

B. Change log

Note: The following subsections lists all significant changes applied to the API for Media Resources 1.0 specification received in CR.

-- editorial changes ---

Updated References
Added Media Ontology Rec Normative ref and linked all references to it.
Corrected wrong error code (200 instead of 415 in section 4.2.3 Examples in Javascript
Multiples editing mis wording.
Added section 6. Implementation-Notes

Note: The following subsections lists all significant changes applied to the API for Media Resources 1.0 specification received in LC.

-- General changes ---

Added example of broadcast date to the createDate interface.
Removed type from the Identifier interface
Removed unused interfaces from the Web-IDL version of the API.
Added examples of the usage of the MediaResource interface.
Added asynchronous versions of all methods.

---[LC 2406] 2001-09-10 ---

Chris to add design consideration in section 2.

---[LC 2410] 2001-09-10 ---

Updated description of getOriginalData.

---[LC 2419] 2001-09-10 ---

Changed Media Resource to Media Resources.
Removed "Thereby".
Changed "are stored in the Media Ontology" to "are documented in the Ontology for Media Resources specification".
Changed "The JavaScript examples in this document will only work if the API is implemented by the browser.".
Changed "The API exists of a number of interfaces" to "The API has a number of interfaces".
Changed "Implementations of the API should provide objects implementing the different interfaces." to "Implementations of the API must implement the different interfaces.".
Corrected the link to Section 5.
Changed "optional" to "optional" for denoting the optional parameters
Added asynchronous versions of the getMediaProperty operation
Changed the name "getPropertyNamesWithValues" to "getPropertyNamesHavingValues".
Changed MAObject to MediaAnnotation.
Dropped method getSourceFormatsWithValues and removed references or descriptions of this.
Dropped method selectMediaResource and introduced a constructor.
Changed Language interface to MediaAnnotationLanguage, and added more information on the usage of it.
Removed "uri" from MAObject interface.
Removed the "suggested terms" since these are listed in the Ontology for Media Resources specification.
Changed the "Date" interface to "CreationDate" interface.
Changed "createdate" to "creationDate" in the example of the CreationDate interface.
Changed floats to doubles for the location property.
Corrected use of capitals for the properties.
Added references from the interfaces in this document to the core properties in the Ontology for Media Resources 1.0 specification.
Removed dots in example of FrameSize.
Added warning about access of geographical content.

---[LC 2394] 2001-09-10 ---

Changed "the API" to "this API".
Updated information on the Media Ontology Core Properties.
Mentioning of the Media Ontology was replaced by information on the Ontology for Media Resources 1.0 specification.
Changed "lies on" to "is".
Dropped "underlying".
Changed "to support" to "supporting".
Dropped the sentence "This document is being published with the aspiration to gather wide feedback on the yet available API design."
Added referenc to the figure.
Dropped "the" and added "and".
Changed "acces (establish connection, retrieval) of" to "acces (establish connection, retrieval) to".
Changed "by" to "with".
Changed "back-end of the web service" to "In the implementation of the web service".
Changed and split up the sentence " allows supporting a media repository (e.g. content provider's archive database, movie store) from which the user agent could directly retrieve metadata sources and which might have a custom metadata format not supported by a user agent.".
Replaced "as" with "than".
Updated the figure and the alt text.
Dropped the first "the".
Changed "the media ontology" to "the Media Ontology".
Changed "on" to "with" and "working" to "applied".
Changed "it is assumed" to "one needs at least".
Changed "The API exists of a number of interfaces" to "The API has a number of interfaces".
Added a colon in "specific operation getProperty".
Changed "to iterate" to "iteration".
Removed "Lastly".
Changed "offers a number of operations" to "provides a number of operations".
Changed "on" to "of".
Changed "getProperty" to "getMediaProperty".
Changed "getPropertyNamesWithValues" to "getPropertyNamesHavingValues".
Changed "getOriginalData" to "getOriginalMetadata".
Change "to retrieve" to "retrieval of".
Added space between "code(".
Changed "Requesting for the title" to "Requesting "title"".
Replaced "to refine" with "refining" and added a period.
Changed the order of the sentence: "Only if the metadata is available in the specified language, the values are returned".
The "type" attribute was removed from the "Identifier" interface.
Changed "Title" to "title".
Changed the description of the "link" attribute of the "CopyRight" interface to: "This attribute holds a URI, identifying the license if it is externally available.".
Removed "organization" from the "Policy" interface.
Changed "behaviour" to "behavior".
Changed "The set of status codes ..." to "Later versions of this document may include additional status codes or other changes.".
Changed "Ok" to "OK".
Removed random indentations.
Removed trailing whitespaces.
Removed redundant "Members of the Working Group are...".

The following subsection lists all significant changes applied to the API for Media Resources 1.0 specification. These have been decided during the 10th Face-to-face meeting hosted by Apple in Silicon Valley, Ca, USA.

Added description of iteration possibility (over various properties) to MediaAnnotation interface.
Added statusCode to WebIDL specification of MediaAnnotation interface.
Added BCP47 recommendation to language attribute of MediaAnnotation interface.
Changed description of value attribute.
Fixed broken link in sourceFormat description.
For all properties added return values, WebIDL description, deleted links and changed examples
Added recommendation for XML dateTime datatype
Merged Javascript Usage section with Web Service section
Added API Status Code section to API Description section
Conformance Section now in the beginning of the document (accordingly to Ontology for Media Resources 1.0)
Added note to Properties section
Deleted client-side in abstract / introduction
Rephrased last paragraph of introduction
Aligned terminology section (accordingly to Ontology for Media Resources 1.0)
Changed position and added caption of Figure 1
Added synchronous and asynchronous description to design consideration section
Changed synchronous specification of MediaResource (including examples)
Updated WebIDL specification of synchronous API
Changed "them agreeing to it" to "declaration of agreement" in Security Consideration
Inserted ontology CSS file to format Status Code Table
Updated usage examples for JavaScript
Updated usage examples for WebService
Changes in intro text of section 4
Added argument list to the definition of the methods of MediaResource IF
Updated parameter descriptions of getMediaProperty
Corrected text in sync examples
Dropped getPropertyNamesHavingValues from asynchronous interface
Updated asynchronous example (remove assumption about HTML5 video element exposing MediaResource Interface)
Dropped type and unstructuredValue from MediaAnnotation interface (as agreed at F2F)
Added introduction to MediaAnnotation definition section (text on design considerations drafted at F2F)
Revised intro to specific properties interfaces section
Dropped all references to getElementsByTagName in the examples
Changed description of attributes of interfaces derived from MediaAnnotation (can't enforce anything here, depends what is in the source file)
Added missing languageLink attribute of language
Changed ratingValue to double (according to ontology document)
Dropped type attribute of rating (does not exist in ontology document)
Updated examples for property return values
Deleted property named callback from async webidl
Updated MediaAnnotation and derived interface definitions in both sync and async WebIDL
Changed ordering of asynchronous interface section
Merged/Changed WebIDL specifications of Appendix
Added statusCode to all examples
Changed sub-interfaces to subtypes
Changed getMediaProperty description (not just requesting a specific property)
Minor change in MetadataCallback description
Simplified asynchronous getMediaProperty example (removed filtered callback)
Minor corrections to MediaAnnotation examples
Removed ECMAScript-specific extended attributes
Included official WebIDL reference
Changed WebIDL specification (constructor to createMediaResource) and corresponding sections
Added reference to Media Fragment specification
Fixed character issues in Acknowledgments section
Integrated direct use of ReSpec.js in dev space
Added text on preference of URIs to introduction text of Properties section (ACTION-405)
Integrated resolution on subtype filter and JSON responses (see meeting minutes (22.03.2011) for details)
Removed filter comment in property descriptions
Changed Date property description
Updated WebIDL description

The following subsection lists all significant changes applied to the API for Media Resources 1.0 specification. These have been decided during the 12th Face-to-face meeting hosted by JOANNEUM, Graz, Austria.

Changed definition of async mode.
Renamed status code 501 into 562 and changed textual description.
Removed HTTP references for the status code statement.

The following subsection lists all significant changes applied to the API for Media Resources 1.0 specification in preparation of the 3rd LC document.

Rephrased text async is default and sync is optional.
Updated Figure 1 on the basis of discussions with Tim Berners-Lee.
Changed introduction of section 4.
Changed description of Async- and SyncMediaResource.
Updated WebIDL specification.

C. Acknowledgements

This document is the work of the W3C Media Annotations Working Group.

Members of the Working Group are (at the time of writing, and by alphabetical order): Werner Bailer (JOANNEUM RESEARCH), Tobias B�rger ((public) Invited expert), Eric Carlson (Apple, Inc.), Pierre-Antoine Champin (Universit� de Lyon), Ashish Chawla ((public) Invited expert), Jaime Delgado (Universitat Polit�cnica de Catalunya), Jean-Pierre Evain ((public) Invited expert), Martin H�ffernig (JOANNEUM RESEARCH), Philip J�genstedt (Opera Software), Ralf Klamma ((public) Invited expert), WonSuk Lee (Samsung Electronics Co., Ltd.), V�ronique Malais� (Vrije Universiteit), Erik Mannens (IBBT), Hui Miao (Samsung Electronics Co., Ltd.), Thierry Michel (W3C/ERCIM), Frank Nack (University of Amsterdam), Soohong Daniel Park (Samsung Electronics Co., Ltd.), Silvia Pfeiffer (W3C Invited Experts), Chris Poppe (IBBT), Victor Rodr�guez (Universitat Polit�cnica de Catalunya), Felix Sasaki (Potsdam University of Applied Sciences), David Singer (Apple, Inc.), Florian Stegmaier ((public) Invited expert), John Strassner ((public) Invited expert), Joakim S�derberg (ERICSSON), Mari Carmen Su�rez-Figueroa ((public) Invited expert) Thai Wey Then (Apple, Inc.), Ruben Tous (Universitat Polit�cnica de Catalunya), Rapha�l Troncy (EURECOM), Vassilis Tzouvaras (K-Space), Davy Van Deursen (IBBT).

The people who have contributed to discussions on public-media-annotation@w3.org are also gratefully acknowledged.

D. References

D.1 Normative references

[MEDIA-FRAGMENTS]: Raphael Troncy; Erik Mannens; Silvia Pfeiffer and Davy Van Deursen. Media Fragments URI 1.0. W3C Proposed Recommendation 15 March 2012. URL: http://www.w3.org/TR/2012/PR-media-frags-20120315/
[MEDIA-ONTOLOGY]: WonSuk Lee; Werner Bailer; Tobias B�rger, etc. Media Fragments URI 1.0. W3C Recommendation 09 February 2012. URL: http://www.w3.org/TR/2012/REC-mediaont-10-20120209/
[RFC2119]: S. Bradner. Key words for use in RFCs to Indicate Requirement Levels. March 1997. Internet RFC 2119. URL: http://www.ietf.org/rfc/rfc2119.txt
[WEBIDL]: Cameron McCormack. Web IDL, 19 April 2012. W3C Candidate Recommendation. (Work in progress.) URL: http://www.w3.org/TR/2012/CR-WebIDL-20120419/

D.2 Informative references

[BCP47]: A. Phillips; M. Davis. Tags for Identifying Languages September 2009. IETF Best Current Practice. URL: http://tools.ietf.org/html/bcp47
[MAWG-REPO]: MAWG code repository. URL: http://sourceforge.net/projects/mawg
[MEDIA-ANNOT-REQS]: WonSuk Lee; Felix Sasaki; Tobias B�rger; V�ronique Malais�. Use Cases and Requirements for Ontology and API for Media Object 1.0.W3C Working Draft 21 January 2010. URL: http://www.w3.org/TR/2010/WD-media-annot-reqs-20100121/
[ODRL11]: Renato Iannella. Open Digital Rights Language (ODRL) Version 1.1. W3C Note. 19 September 2002. URL: http://www.w3.org/TR/odrl
[P3P11]: Matthias Schunter; Rigo Wenning. The Platform for Privacy Preferences 1.1 (P3P1.1) Specification. 13 November 2006. W3C Note. URL: http://www.w3.org/TR/2006/NOTE-P3P11-20061113
[PLING-WIKI]: Policy Languages Interest Group (PLING). PLING Wiki. URL: http://www.w3.org/Policy/pling/
[POLICY-REQS]: Laura Arribas; Paddy Byers; Marcin Hanclik; Frederick Hirsch; David Rogers. Device API Policy Requirements. 13 April 2010. W3C Editor's Draft. (Work in progress.) URL: http://dev.w3.org/2009/dap/policy-reqs/
[WEBWORKERS]: Ian Hickson. Web Workers 01 May 2012. W3C Candidate Recommendation. URL: http://www.w3.org/TR/workers/

API for Media Resources 1.0

W3C Proposed Recommendation 23 July 2013

Abstract

Status of This Document

Table of Contents

1. Introduction

1.1 Formats in scope

1.2 Formats out of scope

1.3 Terminology

2. Conformance

3. Design consideration

4. API Description

4.1 MediaResource interface

4.1.1 Methods

4.1.2 Examples in Javascript

4.2 AsyncMediaResource interface

4.2.1 Methods

4.2.2 Callback interfaces

4.2.2.1 PropertyCallback interface

4.2.2.1.1 Methods

4.2.2.2 MetadataCallback interface

4.2.2.2.1 Methods

4.2.3 Examples in Javascript

4.3 SyncMediaResource interface

4.3.1 Methods

4.3.2 Examples in Javascript

4.4 MediaAnnotation interface

4.4.1 Attributes

4.4.2 Example in JavaScript

4.5 Properties

4.5.1 Identification Properties

4.5.1.1 Identifier

4.5.1.1.1 Attributes

4.5.1.1.2 Example in JavaScript

4.5.1.2 Title

4.5.1.2.1 Attributes

4.5.1.2.2 Example in JavaScript

4.5.1.3 Language

4.5.1.3.1 Attributes

4.5.1.3.2 Example in JavaScript

4.5.1.4 Locator

4.5.1.4.1 Attributes

4.5.1.4.2 Example in JavaScript

4.5.2 Creation Properties

4.5.2.1 Contributor

4.5.2.1.1 Attributes

4.5.2.1.2 Example in JavaScript

4.5.2.2 Creator

4.5.2.2.1 Attributes

4.5.2.2.2 Example in JavaScript

4.5.2.3 MADate

4.5.2.3.1 Attributes

4.5.2.3.2 Example in JavaScript

4.5.2.4 Location

4.5.2.4.1 Attributes

4.5.2.4.2 Example in JavaScript

4.5.3 Content Properties

4.5.3.1 Description

4.5.3.1.1 Attributes

4.5.3.1.2 Example in Javascript

4.5.3.2 Keyword

4.5.3.2.1 Attributes

4.5.3.2.2 Example in Javascript

4.5.3.3 Genre

4.5.3.3.1 Attributes

4.5.3.3.2 Example in Javascript

4.5.3.4 Rating

4.5.3.4.1 Attributes

4.5.3.4.2 Example in Javascript

4.5.4 Relational Properties

4.5.4.1 Relation

4.5.4.1.1 Attributes

4.5.4.1.2 Example in Javascript

4.5.4.2 Collection

4.5.4.2.1 Attributes

4.5.4.2.2 Example in Javascript

4.5.5 Rights Properties

4.5.5.1 Copyright

4.5.5.1.1 Attributes

4.5.5.1.2 Example in Javascript

4.1 `MediaResource` interface

4.2 `AsyncMediaResource` interface

4.2.2.1 `PropertyCallback` interface

4.2.2.2 `MetadataCallback` interface

4.3 `SyncMediaResource` interface

4.4 `MediaAnnotation` interface

4.6 `MetadataSource` interface