Package com.rometools.modules.mediarss.types

Class Metadata

  • All Implemented Interfaces:
    Serializable, Cloneable
    public class Metadata
extends Object
implements Cloneable, Serializable
    Optional Elements

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

    See Also:
    Serialized Form

    • Constructor Detail

      • Metadata

        public Metadata()

    • Method Detail

      • getBackLinks

        public URL[] getBackLinks()

        <media:backLinks>

        Allows inclusion of all the URLs pointing to a media object. 

         <media:backLinks>
   <media:backLink>http://www.backlink1.com</media:backLink>
   <media:backLink>http://www.backlink2.com</media:backLink>
   <media:backLink>http://www.backlink3.com</media:backLink>
 </media:backLinks>
        Returns:
        array of backlink urls

      • setBackLinks

        public void setBackLinks​(URL[] backLinks)

        <media:backLinks>

        Allows inclusion of all the URLs pointing to a media object. 

         <media:backLinks>
   <media:backLink>http://www.backlink1.com</media:backLink>
   <media:backLink>http://www.backlink2.com</media:backLink>
   <media:backLink>http://www.backlink3.com</media:backLink>
 </media:backLinks>
        Parameters:
        backLinks - array of backlink urls

      • setCategories

        public void setCategories​(Category[] categories)

        <media:category>

        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.

        Parameters:
        categories - categories for the item

      • getCategories

        public Category[] getCategories()

        <media:category>

        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.

        Returns:
        categories for the item.

      • getComments

        public String[] getComments()

        <media:comments>

        Allows inclusion of all the comments a media object has received. 

         <media:comments>
   <media:comment>comment1</media:comment>
   <media:comment>comment2</media:comment>
   <media:comment>comment3</media:comment>
 </media:comments>
        Returns:
        array of comments

      • setComments

        public void setComments​(String[] comments)

        <media:comments>

        Allows inclusion of all the comments a media object has received. 

         <media:comments>
   <media:comment>comment1</media:comment>
   <media:comment>comment2</media:comment>
   <media:comment>comment3</media:comment>
 </media:comments>
        Parameters:
        comments - array of comments

      • getCommunity

        public Community getCommunity()

        <media:community>

        This element stands for the community related content. This allows inclusion of the user perception about a media object in the form of view count, ratings and tags. 

         <media:community>
   <media:starRating average="3.5" count="20" min="1" max="10" />
   <media:statistics views="5" favorites="5" />
   <media:tags>news: 5, abc:3, reuters</media:tags>
 </media:community>

        starRating This element specifies the rating-related information about a media object. Valid attributes are average, count, min and max.

        statistics This element specifies various statistics about a media object like the view count and the favorite count. Valid attributes are views and favorites.

        tags This element contains user-generated tags separated by commas in the decreasing order of each tag's weight. Each tag can be assigned an integer weight in tag_name:weight format. It's up to the provider to choose the way weight is determined for a tag; for example, number of occurences can be one way to decide weight of a particular tag. Default weight is 1.

        Returns:
        Community element

      • setCommunity

        public void setCommunity​(Community community)

        <media:community>

        This element stands for the community related content. This allows inclusion of the user perception about a media object in the form of view count, ratings and tags. 

         <media:community>
   <media:starRating average="3.5" count="20" min="1" max="10" />
   <media:statistics views="5" favorites="5" />
   <media:tags>news: 5, abc:3, reuters</media:tags>
 </media:community>

        starRating This element specifies the rating-related information about a media object. Valid attributes are average, count, min and max.

        statistics This element specifies various statistics about a media object like the view count and the favorite count. Valid attributes are views and favorites.

        tags This element contains user-generated tags separated by commas in the decreasing order of each tag's weight. Each tag can be assigned an integer weight in tag_name:weight format. It's up to the provider to choose the way weight is determined for a tag; for example, number of occurences can be one way to decide weight of a particular tag. Default weight is 1.

        Parameters:
        community - Community element

      • setCopyright

        public void setCopyright​(String copyright)

        <media: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.

        Parameters:
        copyright - copyright text

      • getCopyright

        public String getCopyright()

        <media: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.

        Returns:
        Copyright text

      • setCopyrightUrl

        public void setCopyrightUrl​(URI copyrightUrl)

        <media: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.

        Parameters:
        copyrightUrl - link to more copyright information.

      • getCopyrightUrl

        public URI getCopyrightUrl()

        <media: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.

        Returns:
        Link to more copyright information.

      • setCredits

        public void setCredits​(Credit[] credits)

        <media:credit>

        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

        Parameters:
        credits - credits for the item.

      • getCredits

        public Credit[] getCredits()

        <media:credit>

        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

        Returns:
        credits for the time.

      • setDescription

        public void setDescription​(String description)

        <media: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.

        Parameters:
        description - value of the description

      • getDescription

        public String getDescription()

        <media: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.

        Returns:
        value of the description

      • setDescriptionType

        public void setDescriptionType​(String descriptionType)

        <media: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.

        Parameters:
        descriptionType - type of the description.

      • getDescriptionType

        public String getDescriptionType()

        <media: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.

        Returns:
        type of the description

      • getEmbed

        public Embed getEmbed()

        <media:embed>

        Sometimes player-specific embed code is needed for a player to play any video. <media:embed> allows inclusion of such information in the form of key-value pairs.

        <media:embed url="http://d.yimg.com/static.video.yahoo.com/yep/YV_YEP.swf?ver=2.2.2" width="512" height="323">
   <media:param name="type">application/x-shockwave-flash</media:param>
   <media:param name="width">512</media:param>
   <media:param name="height">323</media:param>
   <media:param name="allowFullScreen">true</media:param>
   <media:param name="flashVars">
     id=7809705&vid=2666306&lang=en-us&intl=us&thumbUrl=http%3A//us.i1.yimg.com/us.yimg.com/i/us/sch/cn/video06/2666306_rndf1e4205b_19.jpg
   </media:param>
 </media:embed>
        Returns:
        embed information

      • setEmbed

        public void setEmbed​(Embed embed)

        <media:embed>

        Sometimes player-specific embed code is needed for a player to play any video. <media:embed> allows inclusion of such information in the form of key-value pairs.

        <media:embed url="http://d.yimg.com/static.video.yahoo.com/yep/YV_YEP.swf?ver=2.2.2" width="512" height="323">
   <media:param name="type">application/x-shockwave-flash</media:param>
   <media:param name="width">512</media:param>
   <media:param name="height">323</media:param>
   <media:param name="allowFullScreen">true</media:param>
   <media:param name="flashVars">
     id=7809705&vid=2666306&lang=en-us&intl=us&thumbUrl=http%3A//us.i1.yimg.com/us.yimg.com/i/us/sch/cn/video06/2666306_rndf1e4205b_19.jpg
   </media:param>
 </media:embed>
        Parameters:
        embed - embed information

      • setHash

        public void setHash​(Hash hash)

        <media: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.

        Parameters:
        hash - sets the hash for the item.

      • getHash

        public Hash getHash()

        <media: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.

        Returns:
        returns a Hash object for the item.

      • setKeywords

        public void setKeywords​(String[] keywords)

        <media: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>
        Parameters:
        keywords - Array of keywords

      • getKeywords

        public String[] getKeywords()

        <media: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>
        Returns:
        Array of keywords

      • getLicenses

        public License[] getLicenses()

        <media:license>

        Optional link to specify the machine-readable license associated with the content.

        <media:license type="text/html" href="http://creativecommons.org/licenses/by/3.0/us/">Creative Commons
 Attribution 3.0 United States License</media:license>
        Returns:
        the licenses

      • setLicenses

        public void setLicenses​(License[] licenses)

        <media:license>

        Optional link to specify the machine-readable license associated with the content.

        <media:license type="text/html" href="http://creativecommons.org/licenses/by/3.0/us/">Creative Commons
 Attribution 3.0 United States License</media:license>
        Parameters:
        licenses - the licenses

      • getLocations

        public Location[] getLocations()

        <media:location>

        Optional element to specify geographical information about various locations captured in the content of a media object. The format conforms to geoRSS.

        <media:location description="My house" start="00:01" end="01:00">
   <georss:where>
     <gml:Point>
       <gml:pos>35.669998 139.770004</gml:pos>
     </gml:Point>
   </georss:where>
 </media:location>

        description description of the place whose location is being specified.

        start time at which the reference to a particular location starts in the media object.

        end time at which the reference to a particular location ends in the media object.

        Returns:
        the locations

      • setLocations

        public void setLocations​(Location[] locations)

        <media:location>

        Optional element to specify geographical information about various locations captured in the content of a media object. The format conforms to geoRSS.

        <media:location description="My house" start="00:01" end="01:00">
   <georss:where>
     <gml:Point>
       <gml:pos>35.669998 139.770004</gml:pos>
     </gml:Point>
   </georss:where>
 </media:location>

        description description of the place whose location is being specified.

        start time at which the reference to a particular location starts in the media object.

        end time at which the reference to a particular location ends in the media object.

        Parameters:
        locations - the locations

      • getPeerLinks

        public PeerLink[] getPeerLinks()

        <media:peerLink>

        Optional element for P2P link.

        <media:peerLink type="application/x-bittorrent" href="http://www.example.org/sampleFile.torrent" />
        Returns:
        the peer links

      • setPeerLinks

        public void setPeerLinks​(PeerLink[] peerLinks)

        <media:peerLink>

        Optional element for P2P link.

        <media:peerLink type="application/x-bittorrent" href="http://www.example.org/sampleFile.torrent" />
        Parameters:
        peerLinks - the peer links

      • getPrices

        public Price[] getPrices()

        <media:price>

        Optional tag to include pricing information about a media object. If this tag is not present, the media object is supposed to be free. One media object can have multiple instances of this tag for including different pricing structures. The presence of this tag would mean that media object is not free. 

         <media:price type="rent" price="19.99" currency="EUR" />
 <media:price type="package" info="http://www.dummy.jp/package_info.html" price="19.99" currency="EUR" />
 <media:price type="subscription" info="http://www.dummy.jp/subscription_info" price="19.99" currency="EUR" />

        type Valid values are "rent", "purchase", "package" or "subscription". If nothing is specified, then the media is free.

        info if the type is "package" or "subscription", then info is a URL pointing to package or subscription information. This is an optional attribute.

        price is the price of the media object. This is an optional attribute.

        currency -- use ISO 4217 for currency codes. This is an optional attribute.

        Returns:
        the prices

      • setPrices

        public void setPrices​(Price[] prices)

        <media:price>

        Optional tag to include pricing information about a media object. If this tag is not present, the media object is supposed to be free. One media object can have multiple instances of this tag for including different pricing structures. The presence of this tag would mean that media object is not free. 

         <media:price type="rent" price="19.99" currency="EUR" />
 <media:price type="package" info="http://www.dummy.jp/package_info.html" price="19.99" currency="EUR" />
 <media:price type="subscription" info="http://www.dummy.jp/subscription_info" price="19.99" currency="EUR" />

        type Valid values are "rent", "purchase", "package" or "subscription". If nothing is specified, then the media is free.

        info if the type is "package" or "subscription", then info is a URL pointing to package or subscription information. This is an optional attribute.

        price is the price of the media object. This is an optional attribute.

        currency -- use ISO 4217 for currency codes. This is an optional attribute.

        Parameters:
        prices - the prices

      • setRatings

        public void setRatings​(Rating[] ratings)

        <media:rating>

        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).

        Parameters:
        ratings - Ratings objects

      • getRatings

        public Rating[] getRatings()

        <media:rating>

        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).

        Returns:
        Ratings objects

      • getResponses

        public String[] getResponses()

        <media:responses>

        Allows inclusion of a list of all media responses a media object has received. 

         <media:responses>
   <media:response>response1</media:response>
   <media:response>response2</media:response>
   <media:response>response3</media:response>
 </media:responses>
        Returns:
        array of responses

      • setResponses

        public void setResponses​(String[] responses)

        <media:responses>

        Allows inclusion of a list of all media responses a media object has received. 

         <media:responses>
   <media:response>response1</media:response>
   <media:response>response2</media:response>
   <media:response>response3</media:response>
 </media:responses>
        Parameters:
        responses - array of responses

      • setRestrictions

        public void setRestrictions​(Restriction[] restrictions)

        <media:restriction>

        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.

        Parameters:
        restrictions - restrictions for the item.

      • getRestrictions

        public Restriction[] getRestrictions()

        <media:restriction>

        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.

        Returns:
        restrictions for the item.

      • getRights

        public Metadata.RightsStatus getRights()

        <media:rights>

        Optional element to specify the rights information of a media object.

        <media:rights status="userCreated" />
 <media:rights status="official" />
        Returns:
        the rights

      • setRights

        public void setRights​(Metadata.RightsStatus rights)

        <media:rights>

        Optional element to specify the rights information of a media object.

        <media:rights status="userCreated" />
 <media:rights status="official" />
        Parameters:
        rights - the rights

      • getScenes

        public Scene[] getScenes()

        <media:scene>

        Optional element to specify various scenes within a media object. It can have multiple child <media:scene> elements, where each <media:scene> element contains information about a particular scene. <media:scene> has the optional sub-elements <sceneTitle>, <sceneDescription>, <sceneStartTime> and <sceneEndTime>, which contains title, description, start and end time of a particular scene in the media, respectively.

        <media:scenes>
   <media:scene>
     <sceneTitle>sceneTitle1</sceneTitle>
     <sceneDescription>sceneDesc1</sceneDescription>
     <sceneStartTime>00:15</sceneStartTime>
     <sceneEndTime>00:45</sceneEndTime>
   </media:scene>
   <media:scene>
     <sceneTitle>sceneTitle2</sceneTitle>
     <sceneDescription>sceneDesc2</sceneDescription>
     <sceneStartTime>00:57</sceneStartTime>
     <sceneEndTime>01:45</sceneEndTime>
     </media:scene>
 </media:scenes>
        Returns:
        the scenes

      • setScenes

        public void setScenes​(Scene[] scenes)

        <media:scene>

        Optional element to specify various scenes within a media object. It can have multiple child <media:scene> elements, where each <media:scene> element contains information about a particular scene. <media:scene> has the optional sub-elements <sceneTitle>, <sceneDescription>, <sceneStartTime> and <sceneEndTime>, which contains title, description, start and end time of a particular scene in the media, respectively.

        <media:scenes>
   <media:scene>
     <sceneTitle>sceneTitle1</sceneTitle>
     <sceneDescription>sceneDesc1</sceneDescription>
     <sceneStartTime>00:15</sceneStartTime>
     <sceneEndTime>00:45</sceneEndTime>
   </media:scene>
   <media:scene>
     <sceneTitle>sceneTitle2</sceneTitle>
     <sceneDescription>sceneDesc2</sceneDescription>
     <sceneStartTime>00:57</sceneStartTime>
     <sceneEndTime>01:45</sceneEndTime>
     </media:scene>
 </media:scenes>
        Parameters:
        scenes - the scenes

      • getStatus

        public Status getStatus()

        <media:status>

        Optional tag to specify the status of a media object -- whether it's still active or it has been blocked/deleted. 

         <media:status state="blocked" reason="http://www.reasonforblocking.com" />

        state can have values "active", "blocked" or "deleted". "active" means a media object is active in the system, "blocked" means a media object is blocked by the publisher, "deleted" means a media object has been deleted by the publisher.

        reason is a reason explaining why a media object has been blocked/deleted. It can be plain text or a URL.

        Returns:
        status of media

      • setStatus

        public void setStatus​(Status status)

        <media:status>

        Optional tag to specify the status of a media object -- whether it's still active or it has been blocked/deleted. 

         <media:status state="blocked" reason="http://www.reasonforblocking.com" />

        state can have values "active", "blocked" or "deleted". "active" means a media object is active in the system, "blocked" means a media object is blocked by the publisher, "deleted" means a media object has been deleted by the publisher.

        reason is a reason explaining why a media object has been blocked/deleted. It can be plain text or a URL.

        Parameters:
        status - status of media

      • getSubTitles

        public SubTitle[] getSubTitles()

        <media:subTitle>

        Optional element for subtitle/CC link. It contains type and language attributes. Language is based on RFC 3066. There can be more than one such tag per media element, for example one per language. Please refer to Timed Text spec - W3C for more information on Timed Text and Real Time Subtitling.

        <media:subTitle type="application/smil" lang="en-us" href="http://www.example.org/subtitle.smil" />
        Returns:
        the subtitles

      • setSubTitles

        public void setSubTitles​(SubTitle[] subTitles)

        <media:subTitle>

        Optional element for subtitle/CC link. It contains type and language attributes. Language is based on RFC 3066. There can be more than one such tag per media element, for example one per language. Please refer to Timed Text spec - W3C for more information on Timed Text and Real Time Subtitling.

        <media:subTitle type="application/smil" lang="en-us" href="http://www.example.org/subtitle.smil" />
        Parameters:
        subTitles - the subtitles

      • setText

        public void setText​(Text[] text)

        <media: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.

        Parameters:
        text - text objects for the item.

      • getText

        public Text[] getText()

        <media: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.

        Returns:
        Text objects for the item.

      • setThumbnail

        public void setThumbnail​(Thumbnail[] thumbnail)

        <media: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.

        Parameters:
        thumbnail - thumbnails for the image

      • getThumbnail

        public Thumbnail[] getThumbnail()

        <media: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.

        Returns:
        Thumbnails for the image

      • setTitle

        public void setTitle​(String title)

        <media: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.

        Parameters:
        title - Value of the title

      • getTitle

        public String getTitle()

        <media: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.

        Returns:
        value of the title.

      • setTitleType

        public void setTitleType​(String titleType)

        <media: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.

        Parameters:
        titleType - type of the title.

      • getTitleType

        public String getTitleType()

        <media: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.

        Returns:
        type of the title

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object