public class Metadata
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable
The following elements are optional and may appear as sub-elements of <channel>, <item>, <media:content> and/or <media:group>.
When an element appears at a shallow level, such as <channel> or <item>, it means that the element should be applied to every media object within its scope.
Duplicated elements appearing at deeper levels of the document tree have higher priority over other levels. For example, <media:content> level elements are favored over <item> level elements. The priority level is listed from strongest to weakest: <media:content>, <media:group>, <item>, <channel>.
Modifier and Type | Field and Description |
---|---|
private Category[] |
categories |
private java.lang.String |
copyright |
private java.net.URI |
copyrightUrl |
private Credit[] |
credits |
private java.lang.String |
description |
private java.lang.String |
descriptionType |
private Hash |
hash |
private java.lang.String[] |
keywords |
private Rating[] |
ratings |
private Restriction[] |
restrictions |
private static long |
serialVersionUID |
private Text[] |
text |
private Thumbnail[] |
thumbnail |
private java.lang.String |
title |
private java.lang.String |
titleType |
Constructor and Description |
---|
Metadata() |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
<media:copyright>
|
boolean |
equals(java.lang.Object obj) |
Category[] |
getCategories()
<media:category>
|
java.lang.String |
getCopyright()
<media:copyright>
|
java.net.URI |
getCopyrightUrl()
<media:copyright>
|
Credit[] |
getCredits()
<media:credit>
|
java.lang.String |
getDescription()
<media:description>
|
java.lang.String |
getDescriptionType()
<media:description>
|
Hash |
getHash()
<media:hash>
|
java.lang.String[] |
getKeywords()
<media:keywords>
|
Rating[] |
getRatings()
<media:rating>
|
Restriction[] |
getRestrictions()
<media:restriction>
|
Text[] |
getText()
<media:text>
|
Thumbnail[] |
getThumbnail()
<media:thumbnail>
|
java.lang.String |
getTitle()
<media:title>
|
java.lang.String |
getTitleType()
<media:title>
|
int |
hashCode() |
void |
setCategories(Category[] categories)
<media:category>
|
void |
setCopyright(java.lang.String copyright)
<media:copyright>
|
void |
setCopyrightUrl(java.net.URI copyrightUrl)
<media:copyright>
|
void |
setCredits(Credit[] credits)
<media:credit>
|
void |
setDescription(java.lang.String description)
<media:description>
|
void |
setDescriptionType(java.lang.String descriptionType)
<media:description>
|
void |
setHash(Hash hash)
<media:hash>
|
void |
setKeywords(java.lang.String[] keywords)
<media:keywords>
|
void |
setRatings(Rating[] ratings)
<media:rating>
|
void |
setRestrictions(Restriction[] restrictions)
<media:restriction>
|
void |
setText(Text[] text)
<media:text>
|
void |
setThumbnail(Thumbnail[] thumbnail)
<media:thumbnail>
|
void |
setTitle(java.lang.String title)
<media:title>
|
void |
setTitleType(java.lang.String titleType)
<media:title>
|
java.lang.String |
toString() |
private static final long serialVersionUID
private Hash hash
private java.lang.String copyright
private java.lang.String description
private java.lang.String descriptionType
private java.lang.String title
private java.lang.String titleType
private java.net.URI copyrightUrl
private Category[] categories
private Credit[] credits
private java.lang.String[] keywords
private Rating[] ratings
private Restriction[] restrictions
private Text[] text
private Thumbnail[] thumbnail
public void setCategories(Category[] categories)
Allows a taxonomy to be set that gives an indication of the type of media content, and its particular contents. It has 2 optional attributes.
<media:category scheme="http://search.yahoo.com/mrss/category_ schema">music/artist/album/song</media:category> <media:category scheme="http://dmoz.org" label="Ace Ventura - Pet Detective">Arts/Movies/Titles/A/Ace_Ventura_Series/Ace_Ventura_ -_Pet_Detective</media:category> <media:category scheme="urn:flickr:tags">ycantpark mobile</media:category>
scheme is the URI that identifies the categorization scheme. It is an optional attribute. If this attribute is not included, the default scheme is 'http://search.yahoo.com/mrss/category_schema'.
label is the human readable label that can be displayed in end user applications. It is an optional attribute.
categories
- categories for the itempublic Category[] getCategories()
Allows a taxonomy to be set that gives an indication of the type of media content, and its particular contents. It has 2 optional attributes.
<media:category scheme="http://search.yahoo.com/mrss/category_ schema">music/artist/album/song</media:category> <media:category scheme="http://dmoz.org" label="Ace Ventura - Pet Detective">Arts/Movies/Titles/A/Ace_Ventura_Series/Ace_Ventura_ -_Pet_Detective</media:category> <media:category scheme="urn:flickr:tags">ycantpark mobile</media:category>
scheme is the URI that identifies the categorization scheme. It is an optional attribute. If this attribute is not included, the default scheme is 'http://search.yahoo.com/mrss/category_schema'.
label is the human readable label that can be displayed in end user applications. It is an optional attribute.
public void setCopyright(java.lang.String copyright)
Copyright information for media object. It has 1 optional attribute.
<media:copyright url="http://blah.com/additional-info.html">2005 FooBar Media</media:copyright>
url is the url for a terms of use page or additional copyright information. If the media is operating under a Creative Commons license, the Creative Commons module should be used instead. It is an optional attribute.
copyright
- copyright textpublic java.lang.String getCopyright()
Copyright information for media object. It has 1 optional attribute.
<media:copyright url="http://blah.com/additional-info.html">2005 FooBar Media</media:copyright>
url is the url for a terms of use page or additional copyright information. If the media is operating under a Creative Commons license, the Creative Commons module should be used instead. It is an optional attribute.
public void setCopyrightUrl(java.net.URI copyrightUrl)
Copyright information for media object. It has 1 optional attribute.
<media:copyright url="http://blah.com/additional-info.html">2005 FooBar Media</media:copyright>
url is the url for a terms of use page or additional copyright information. If the media is operating under a Creative Commons license, the Creative Commons module should be used instead. It is an optional attribute.
copyrightUrl
- link to more copyright information.public java.net.URI getCopyrightUrl()
Copyright information for media object. It has 1 optional attribute.
<media:copyright url="http://blah.com/additional-info.html">2005 FooBar Media</media:copyright>
url is the url for a terms of use page or additional copyright information. If the media is operating under a Creative Commons license, the Creative Commons module should be used instead. It is an optional attribute.
public void setCredits(Credit[] credits)
Notable entity and the contribution to the creation of the media object. Current entities can include people, companies, locations, etc. Specific entities can have multiple roles, and several entities can have the same role. These should appear as distinct <media:credit> elements. It has 2 optional attributes.
<media:credit role="producer" scheme="urn:ebu">entity name</media:credit>
role specifies the role the entity played. Must be lowercase. It is an optional attribute.
scheme is the URI that identifies the role scheme. It is an optional attribute. If this attribute is not included, the default scheme is 'urn:ebu'. See: European Broadcasting Union Role Codes.
Example roles:
actor anchor person author choreographer composer conductor director editor graphic designer grip illustrator lyricist music arranger music group musician orchestra performer photographer producer reporter vocalist
Additional roles: European Broadcasting Union Role Codes
credits
- credits for the item.public Credit[] getCredits()
Notable entity and the contribution to the creation of the media object. Current entities can include people, companies, locations, etc. Specific entities can have multiple roles, and several entities can have the same role. These should appear as distinct <media:credit> elements. It has 2 optional attributes.
<media:credit role="producer" scheme="urn:ebu">entity name</media:credit>
role specifies the role the entity played. Must be lowercase. It is an optional attribute.
scheme is the URI that identifies the role scheme. It is an optional attribute. If this attribute is not included, the default scheme is 'urn:ebu'. See: European Broadcasting Union Role Codes.
Example roles:
actor anchor person author choreographer composer conductor director editor graphic designer grip illustrator lyricist music arranger music group musician orchestra performer photographer producer reporter vocalist
Additional roles: European Broadcasting Union Role Codes
public void setDescription(java.lang.String description)
Short description describing the media object typically a sentence in length. It has 1 optional attribute.
<media:description type="plain">This was some really bizarre band I listened to as a young lad.</media:description>
type specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional attribute.
description
- value of the descriptionpublic java.lang.String getDescription()
Short description describing the media object typically a sentence in length. It has 1 optional attribute.
<media:description type="plain">This was some really bizarre band I listened to as a young lad.</media:description>
type specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional attribute.
public void setDescriptionType(java.lang.String descriptionType)
Short description describing the media object typically a sentence in length. It has 1 optional attribute.
<media:description type="plain">This was some really bizarre band I listened to as a young lad.</media:description>
type specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional attribute.
descriptionType
- type of the description.public java.lang.String getDescriptionType()
Short description describing the media object typically a sentence in length. It has 1 optional attribute.
<media:description type="plain">This was some really bizarre band I listened to as a young lad.</media:description>
type specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional attribute.
public void setHash(Hash hash)
This is the hash of the binary media file. It can appear multiple times as long as each instance is a different algo. It has 1 optional attribute.
<media:hash algo="md5">dfdec888b72151965a34b4b59031290a</media:hash>
algo indicates the algorithm used to create the hash. Possible values are 'md5' and 'sha-1'. Default value is 'md5'. It is an optional attribute.
hash
- sets the hash for the item.public Hash getHash()
This is the hash of the binary media file. It can appear multiple times as long as each instance is a different algo. It has 1 optional attribute.
<media:hash algo="md5">dfdec888b72151965a34b4b59031290a</media:hash>
algo indicates the algorithm used to create the hash. Possible values are 'md5' and 'sha-1'. Default value is 'md5'. It is an optional attribute.
public void setKeywords(java.lang.String[] keywords)
Highly relevant keywords describing the media object with typically a maximum of ten words. The keywords and phrases should be comma delimited.
<media:keywords>kitty, cat, big dog, yarn, fluffy</media:keywords>
keywords
- Array of keywordspublic java.lang.String[] getKeywords()
Highly relevant keywords describing the media object with typically a maximum of ten words. The keywords and phrases should be comma delimited.
<media:keywords>kitty, cat, big dog, yarn, fluffy</media:keywords>
public void setRatings(Rating[] ratings)
This allows the permissible audience to be declared. If this element is not included, it assumes that no restrictions are necessary. It has one optional attribute.
<media:rating scheme="urn:simple">adult</media:rating> <media:rating scheme="urn:icra">r (cz 1 lz 1 nz 1 oz 1 vz 1)</media:rating> <media:rating scheme="urn:mpaa">pg</media:rating> <media:rating scheme="urn:v-chip">tv-y7-fv</media:rating>
scheme is the URI that identifies the rating scheme. It is an optional attribute. If this attribute is not included, the default scheme is urn:simple (adult | nonadult).
ratings
- Ratings objectspublic Rating[] getRatings()
This allows the permissible audience to be declared. If this element is not included, it assumes that no restrictions are necessary. It has one optional attribute.
<media:rating scheme="urn:simple">adult</media:rating> <media:rating scheme="urn:icra">r (cz 1 lz 1 nz 1 oz 1 vz 1)</media:rating> <media:rating scheme="urn:mpaa">pg</media:rating> <media:rating scheme="urn:v-chip">tv-y7-fv</media:rating>
scheme is the URI that identifies the rating scheme. It is an optional attribute. If this attribute is not included, the default scheme is urn:simple (adult | nonadult).
public void setRestrictions(Restriction[] restrictions)
Allows restrictions to be placed on the aggregator rendering the media in the feed. Currently, restrictions are based on distributor (uri) and country codes. This element is purely informational and no obligation can be assumed or implied. Only one <media:restriction> element of the same type can be applied to a media object - all others will be ignored. Entities in this element should be space separated. To allow the producer to explicitly declare his/her intentions, two literals are reserved: 'all', 'none'. These literals can only be used once. This element has 1 required attribute, and 1 optional attribute (with strict requirements for its exclusion).
<media:restriction relationship="allow" type="country">au us</media:restriction>
relationship indicates the type of relationship that the restriction represents (allow | deny). In the example above, the media object should only be syndicated in Australia and the United States. It is a required attribute.
restrictions
- restrictions for the item.public Restriction[] getRestrictions()
Allows restrictions to be placed on the aggregator rendering the media in the feed. Currently, restrictions are based on distributor (uri) and country codes. This element is purely informational and no obligation can be assumed or implied. Only one <media:restriction> element of the same type can be applied to a media object - all others will be ignored. Entities in this element should be space separated. To allow the producer to explicitly declare his/her intentions, two literals are reserved: 'all', 'none'. These literals can only be used once. This element has 1 required attribute, and 1 optional attribute (with strict requirements for its exclusion).
<media:restriction relationship="allow" type="country">au us</media:restriction>
relationship indicates the type of relationship that the restriction represents (allow | deny). In the example above, the media object should only be syndicated in Australia and the United States. It is a required attribute.
public void setText(Text[] text)
Allows the inclusion of a text transcript, closed captioning, or lyrics of the media content. Many of these elements are permitted to provide a time series of text. In such cases, it is encouraged, but not required, that the elements be grouped by language and appear in time sequence order based on the start time. Elements can have overlapping start and end times. It has 4 optional attributes.
<media:text type="plain" lang="en" start="00:00:03.000" end="00:00:10.000"> Oh, say, can you see</media:text> <media:text type="plain" lang="en" start="00:00:10.000" end="00:00:17.000">By the dawn's early light</media:text>
type specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional attribute.
lang is the primary language encapsulated in the media object. Language codes possible are detailed in RFC 3066. This attribute is used similar to the xml:lang attribute detailed in the XML 1.0 Specification (Third Edition). It is an optional attribute.
start specifies the start time offset that the text starts being relevant to the media object. An example of this would be for closed captioning. It uses the NTP time code format (see: the time attribute used in <media:thumbnail>). It is an optional attribute.
end specifies the end time that the text is relevant. If this attribute is not provided, and a start time is used, it is expected that the end time is either the end of the clip or the start of the next <media:text> element.
text
- text objects for the item.public Text[] getText()
Allows the inclusion of a text transcript, closed captioning, or lyrics of the media content. Many of these elements are permitted to provide a time series of text. In such cases, it is encouraged, but not required, that the elements be grouped by language and appear in time sequence order based on the start time. Elements can have overlapping start and end times. It has 4 optional attributes.
<media:text type="plain" lang="en" start="00:00:03.000" end="00:00:10.000"> Oh, say, can you see</media:text> <media:text type="plain" lang="en" start="00:00:10.000" end="00:00:17.000">By the dawn's early light</media:text>
type specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional attribute.
lang is the primary language encapsulated in the media object. Language codes possible are detailed in RFC 3066. This attribute is used similar to the xml:lang attribute detailed in the XML 1.0 Specification (Third Edition). It is an optional attribute.
start specifies the start time offset that the text starts being relevant to the media object. An example of this would be for closed captioning. It uses the NTP time code format (see: the time attribute used in <media:thumbnail>). It is an optional attribute.
end specifies the end time that the text is relevant. If this attribute is not provided, and a start time is used, it is expected that the end time is either the end of the clip or the start of the next <media:text> element.
public void setThumbnail(Thumbnail[] thumbnail)
Allows particular images to be used as representative images for the media object. If multiple thumbnails are included, and time coding is not at play, it is assumed that the images are in order of importance. It has 1 required attribute and 3 optional attributes.
<media:thumbnail url="http://www.foo.com/keyframe.jpg" width="75" height="50" time="12:05:01.123" />
url specifies the url of the thumbnail. It is a required attribute.
height specifies the height of the thumbnail. It is an optional attribute.
width specifies the width of the thumbnail. It is an optional attribute.
time specifies the time offset in relation to the media object. Typically this is used when creating multiple keyframes within a single video. The format for this attribute should be in the DSM-CC's Normal Play Time (NTP) as used in RTSP [RFC 2326 3.6 Normal Play Time]. It is an optional attribute.
thumbnail
- thumbnails for the imagepublic Thumbnail[] getThumbnail()
Allows particular images to be used as representative images for the media object. If multiple thumbnails are included, and time coding is not at play, it is assumed that the images are in order of importance. It has 1 required attribute and 3 optional attributes.
<media:thumbnail url="http://www.foo.com/keyframe.jpg" width="75" height="50" time="12:05:01.123" />
url specifies the url of the thumbnail. It is a required attribute.
height specifies the height of the thumbnail. It is an optional attribute.
width specifies the width of the thumbnail. It is an optional attribute.
time specifies the time offset in relation to the media object. Typically this is used when creating multiple keyframes within a single video. The format for this attribute should be in the DSM-CC's Normal Play Time (NTP) as used in RTSP [RFC 2326 3.6 Normal Play Time]. It is an optional attribute.
public void setTitle(java.lang.String title)
The title of the particular media object. It has 1 optional attribute.
<media:title type="plain">The Judy's - The Moo Song</media:title>
type specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional attribute.
title
- Value of the titlepublic java.lang.String getTitle()
The title of the particular media object. It has 1 optional attribute.
<media:title type="plain">The Judy's - The Moo Song</media:title>
type specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional attribute.
public void setTitleType(java.lang.String titleType)
The title of the particular media object. It has 1 optional attribute.
<media:title type="plain">The Judy's - The Moo Song</media:title>
type specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional attribute.
titleType
- type of the title.public java.lang.String getTitleType()
The title of the particular media object. It has 1 optional attribute.
<media:title type="plain">The Judy's - The Moo Song</media:title>
type specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional attribute.
public java.lang.Object clone()
Copyright information for media object. It has 1 optional attribute.
<media:copyright url="http://blah.com/additional-info.html">2005 FooBar Media</media:copyright>
url is the url for a terms of use page or additional copyright information. If the media is operating under a Creative Commons license, the Creative Commons module should be used instead. It is an optional attribute.
clone
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object