API for Media Resource 1.0

4.2.2.1.1 Methods

getProperty handleEvent

This operation with the is called when all data is gathered corresponding source format will return at least to a request for values of one object. or more properties. ✔

Parameter	Type	Nullable	Optional	Description
language mediaAnnotations	DOMString MediaAnnotation []	✘	✘	This argument allows to identify the language holds a list of objects with values according to the metadata. Only if requested property. These objects implement the metadata is available MediaAnnotation interface, described in Section 4.4 .Depending on the specified language, requested property, the values are returned. This parameter is optional . returned objects implement a different subtypes (inheriting from the MediaAnnotation interface).

No exceptions.

Return type: DOMString void []

4.2.2.2.1 Methods

handleEvent

This operation allows is called when all data is gathered corresponding to set the specific Media Resource and metadata sources a request for which the API applies. original metadata.

Parameter	Type	Nullable	Optional	Description
mediaResource 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.5.1.1.1 Attributes

value identifierLink of type DOMString

This attribute should represent holds a URI identifying the media resource.

No exceptions.

4.5.1.1.2 Example in JavaScript is as below: id

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

*/

3.5.2.1 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 contains holds the type of the title, which can be filtered on in the getProperty operation. title as a plain string.

No exceptions.

value typeLink of type DOMString

This attribute should hold holds the type of the title as a plain string. URI.

No exceptions.

4.5.1.2.2 Example in JavaScript is as below: title

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.1 Attributes

MediaResource.getProperty languageLabel method which has "Language" of type DOMString

This attribute represents the language of the media resource as a value of plain string, which can be filtered on in the propertyName getMediaProperty parameter. operation. Recommended best practice is to use BCP 47 [ BCP-47 BCP47 ]. ] interface { }; ].

No exceptions. 3.5.3.1 Attributes

value languageLink of type DOMString

This attribute should represent represents the language of the media resource as a plain string. URI.

No exceptions.

4.5.1.3.2 Example in JavaScript is as below: language

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

*/

3.5.4.1 4.5.1.4.1 Attributes

value locatorLink of type DOMString

This attribute should hold specifies the location of the media resource by a URI.

No exceptions.

4.5.1.4.2 Example in JavaScript is as below: locator

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
 *         } 
 * } ]

*/

3.6.1.1 4.5.2.1.1 Attributes

id contributorLabel of type DOMString

This attribute identifies represents the contributor. contributor (i.e., the agent making the contribution) as a plain string

No exceptions.

role contributorLink of type DOMString

This attribute defines represents the role, which can be filtered on in contributor (i.e., the getProperty operation. For agent making the latter contribution) as a number of suggested terms are defined: editor (EBU 11.1) actor (EBU 25.9) URI.

No exceptions. composer

featured_in roleLabel of type cinematographer DOMString director musicproducer

This attribute represents the role of the contributor as a plain string.

No exceptions. producer

screenplayer roleLink of type writer DOMString distributor (company) production company

This attribute represents the role of the contributor as URI.

No exceptions.

4.5.2.1.2 Example in JavaScript is as below: contributor

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
 *         } 
 * } ]

*/

3.6.2.1 4.5.2.2.1 Attributes

value creatorLabel of type DOMString

This attribute should hold an identifier for an author. 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 is as below: creator

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
 *         }
 * } ]

*/

3.6.3.1 4.5.2.3.1 Attributes

date of type DOMString

The exact format of this This attribute is currently undefined. represents 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.

type typeLabel of type DOMString

This attribute define defines the particular category of creation date (e.g. "release date", "date recorded" creation date, broadcast date, release date, date recorded and "date edited".), which can be filtered on in the date edited) as a plain string.

No exceptions.

getProperty typeLink operation. 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 is as below: createdate

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
 *         }
 * } ]

*/

3.6.4.1 4.5.2.4.1 Attributes

altitude of type Float double

This attribute holds the altitude value from of the location, w.r.t. the coordinate system defined in specified by the system . coordiateSystem attribute (default is WGS84).

No exceptions.

latitude coordinateSystemLabel of type Float DOMString

This attribute holds identified the latitude value from coordinate system defined in used by its name.

No exceptions.

coordinateSystemLink of type DOMString

This attribute identified the coordinate system . used by a URI.

No exceptions.

longitude latitude of type Float double

This attribute holds the longitude value from latitude of the location, w.r.t. the coordinate system defined in specified by the system . coordiateSystem attribute (default is WGS84).

No exceptions.

name locationLabel of type DOMString

This attribute holds a free text identifies the location by its name as a plain string.

No exceptions.

locationLink of type DOMString

This attribute identifies the location. location as a URI.

No exceptions.

system longitude of type DOMString double

This attribute holds the name longitude of location system. the location, w.r.t. the coordinate system specified by the coordiateSystem attribute (default is WGS84).

No exceptions.

4.5.2.4.2 Example in JavaScript is as below: location

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
 *         }
 * } ]

*/

3.7.1.1 4.5.3.1.1 Attributes

value descriptionLabel of type DOMString

This attribute should hold 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 *         } * } ]

*/

3.7.2.1 4.5.3.2.1 Attributes

value keywordLabel of type DOMString

This attribute should hold one keyword. 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://www.ontologyportal.org/WordNet#WN30Word-standardisation",                    *         "statusCode" : 200 *         }  * } ]

*/

3.7.3.1 4.5.3.3.1 Attributes

value genreLabel of type DOMString

This attribute should represent represents the genre of the media resource. 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 *         }  * } ]

*/

3.7.4.1 4.5.3.4.1 Attributes

issuer maximum of type DOMString double

This attribute identifies specifies the maximum rating person or organization value in the rating system.

No exceptions.

maximum minimum of type short double

This attribute specifies the maximum rating. minimum rating value in the rating system.

No exceptions.

minimum ratingSystemLabel of type short DOMString

This attribute specifies identifies the minimum rating. rating system by a plain string.

No exceptions.

type ratingSystemLink of type DOMString

This attribute specifies the type of the rating, which can be filtered on in identifies the getProperty operation. Examples are "Review Rating", "MPAA", "Personal Rating". rating system as a URI.

No exceptions.

value ratingValue of type short double

This attribute indicates contains the value of the average 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 *         }  * } ]

*/

3.8.1.1 4.5.4.1.1 Attributes

id targetLabel of type DOMString

This attribute identifies the entitiy. related resource by a plain string.

No exceptions.

relationship targetLink of type DOMString

This attribute specifies textual description of the relationship, which can be filtered on in identifies the related resource by a URI.

No exceptions.

getProperty typeLabel operation. For of type DOMString

This attribute specifies the latter type of relationship by a number plain string.

No exceptions.

typeLink of suggested terms are defined: 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 *         } * } ]

*/

3.8.2.1 4.5.4.2.1 Attributes

value collectionLabel of type DOMString

This attribute should hold holds the name of the collection from which the media resource originates. 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 *         }  * } ]

*/

3.9.1.1 4.5.5.1.1 Attributes

holder copyrightLabel of type array DOMString

This attribute contains the copyright statement as a plain string.

No exceptions.

holderLabel of type DOMString

This attribute denotes identifies the copyright holders. holder by a plain string.

No exceptions.

statement holderLink of type DOMString

This attribute should holds identified the copyright statement. 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 *         }  * } ]

*/

3.9.2.1 4.5.5.2.1 Attributes

link statementLabel of type DOMString

This attribute holds contains a link to plain string of the license if it is externally available. policy statement.

No exceptions.

organization statementLink of type DOMString

This attribute identifies the organization that issued contains a URI of the license. policy statement.

No exceptions.

type typeLabel of type DOMString

This attribute holds identifies the actual type of the policy, which can be filtered on in the getProperty operation. Examples are "license", "access", and "privacy". policy as a URI as a plain string.

No exceptions.

value typeLink of type DOMString

This attribute holds identifies the description type of the license. 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 *         } * } ]

*/

3.10.1.1 4.5.6.1.1 Attributes

value publisherLabel of type DOMString

This attribute should represent represents the name publisher as a plain string.

No exceptions.

publisherLink of type DOMString

This attribute represents the publisher. 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 *         }  * } ]

*/

3.10.2.1 4.5.6.2.1 Attributes

classification audienceLabel of type DOMString

This attribute defines identifies the actual classification. target audience by a plain string.

No exceptions.

issuer audienceLink of type DOMString

This attribute identifies the issuer of the classification. target audience by a URI.

No exceptions.

type classificationSystemLabel of type DOMString

This attribute specifies the type of the classification, which can be filtered on in the classification system by a plain string.

No exceptions.

getProperty classificationSystemLink operation. Examples are "Age group" and "Geographical". 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 *         } * } ]

*/

3.11.1.1 4.5.7.1.1 Attributes

id identifier of type DOMString

This attribute identifies the fragment. 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 holds identifies the role of the fragment, fragment as a URI, which can be filtered on in the getProperty 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 *         } * } ]

*/

3.11.2.1 4.5.7.2.1 Attributes

id identifier of type DOMString

This attribute identifies the fragment. a named fragment by a Media Fragment URI.

No exceptions.

name label of type DOMString

This attribute specifies the name given contains a plain text label of a named media fragment, which can be used to the 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 *         }  * } ]

*/

3.12.1.1 4.5.8.1.1 Attributes

height of type unsigned long double

This attribute represents the height of the frame.

No exceptions.

unit of type DOMString

This attribute represents the unit of the frame. frame width/height. The default value is pixels.

No exceptions.

width of type unsigned long 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 *         }  * } ]

*/

3.12.2.1 4.5.8.2.1 Attributes

value 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 *         }  * } ]

*/

3.12.3.1 4.5.8.3.1 Attributes

value duration of type unsigned long double

This attribute should represent represents the duration of the media resource (in secs). 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 *         }  * } ]

*/

3.12.4.1 4.5.8.4.1 Attributes

value formatLabel of type DOMString

This attribute specifies the MIME type as of the media resource.

No exceptions.

formatLink of type DOMString

This attribute identifies the MIME type of the media resource by a plain string. 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 *         }  * } ]

*/

3.12.5.1 4.5.8.5.1 Attributes

value samplingRate of type unsigned long double

This attribute specifies the samplingrate (in Hz). 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 *         }  * } ]

*/

3.12.6.1 4.5.8.6.1 Attributes

value frameRate of type float double

This attribute specifies the framerate (in fps). 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 *         }  * } ]

*/

3.12.7.1 4.5.8.7.1 Attributes

value averageBitRate of type float double

This attribute specifies the average bitrate (in kbps). kbps) as a double value.

No exceptions.

4.5.8.7.2 Example is as below: bitrate in Javascript

bitrate = video.getMediaProperty(["averageBitRate"]);
/** Resulting in:
 * [ { "AverageBitRate" : {
 *         "propertyName" : "averageBitRate",
 *         "averageBitRate" : 45.06,               
 *         "statusCode" : 200
 *         }
 * } ]

*/

3.12.8.1 4.5.8.8.1 Attributes

type number of type DOMString short

This attribute specifies the type number of the tracks e.g., "Songs", "Data streams". as an integer value.

No exceptions.

value typeString of type unsigned short DOMString

This attribute specifies the number type of tracks. 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 *         } * } ]

*/