WPD_CONTENT_TYPE_MEDIA_CAST

Article
03/07/2008

banner art

WPD_CONTENT_TYPE_MEDIA_CAST

An object that describes its type as WPD_CONTENT_TYPE_MEDIA_CAST represents a collection of related content.

A Mediacast object can be thought of as a container object that groups related content, just as a playlist groups music. Often, a Mediacast object is used to group media content that was published online. For example, an RSS channel can be represented as a Mediacast object whose object references point to content objects that represent each item in the channel.

This type of object should host the following properties.

Property Name	Required or Optional
WPD_OBJECT_ID	Required
WPD_OBJECT_PARENT_ID	Required
WPD_OBJECT_NAME	Required
WPD_OBJECT_PERSISTENT_UNIQUE_ID	Required
WPD_OBJECT_FORMAT	Required
WPD_OBJECT_CONTENT_TYPE	Required
WPD_OBJECT_ISHIDDEN	Required if the object is hidden.
WPD_OBJECT_ISSYSTEM	Required if the object is a system object (that is, it represents a system file).
WPD_OBJECT_SIZE	Required if the object has at least one resource.
WPD_OBJECT_ORIGINAL_FILE_NAME	Required if the object represents a file.
WPD_OBJECT_NON_CONSUMABLE	Recommended if the object is not meant for consumption by the device.
WPD_OBJECT_REFERENCES	Required if the object has references to other objects.
WPD_OBJECT_KEYWORDS	Optional
WPD_OBJECT_SYNC_ID	Optional
WPD_OBJECT_IS_DRM_PROTECTED	Required if the object is protected by DRM technology.
WPD_OBJECT_DATE_CREATED	Optional
WPD_OBJECT_DATE_MODIFIED	Recommended
WPD_OBJECT_DATE_AUTHORED	Optional
WPD_OBJECT_BACK_REFERENCES	Recommended if the object is referenced by another object.
WPD_OBJECT_CONTAINER_FUNCTIONAL_OBJECT_ID	Optional
WPD_OBJECT_GENERATE_THUMBNAIL_FROM_RESOURCE	Optional
WPD_OBJECT_CAN_DELETE	Required if the object can be deleted.
WPD_MEDIA_COPYRIGHT	Optional
WPD_MEDIA_PARENTAL_RATING	Optional
WPD_MEDIA_META_GENRE	Optional
WPD_MEDIA_SUB_TITLE	Optional
WPD_MEDIA_RELEASE_DATE	Recommended
WPD_MEDIA_TITLE	Recommended
WPD_MEDIA_OWNER	Recommended
WPD_MEDIA_MANAGING_EDITOR	Recommended
WPD_MEDIA_WEBMASTER	Recommended
WPD_MEDIA_SOURCE_URL	Recommended
WPD_MEDIA_DESTINATION_URL	Recommended
WPD_MEDIA_DESCRIPTION	Optional
WPD_MEDIA_GENRE	Optional
WPD_MEDIA_OBJECT_BOOKMARK	Recommended
WPD_MEDIA_LAST_BUILD_DATE	Recommended
WPD_MEDIA_TIME_TO_LIVE	Optional

Typical Resources

These objects typically include the following resources.

Resource Name	Required or Optional	Description
WPD_RESOURCE_DEFAULT	Optional	Contains the mediacast file data. For example, if this mediacast represents an RSS channel, this could be the RSS document.
WPD_RESOURCE_THUMBNAIL	Optional	Contains the thumbnail representing this mediacast.
WPD_RESOURCE_ALBUM_ART	Optional	Contains the artwork for this mediacast.

Mapping of RSS Elements and Mediacast properties

An RSS channel can be represented as a Mediacast object whose references point to content objects representing each item in a given channel.

The elements in an RSS feed have the following hierarchy and attributes.

<channel>
    <title />
    <link />
    <description />
    <language />
    <copyright />
    <managingEditor />
    <webMaster />
    <pubDate />
    <lastBuildDate />
    <category />
    <generator />
    <docs />
    <cloud />
    <ttl />

    <image>
        <url />
        <title />
        <link />
        <width />
        <height />
        <description />
    </image>

    <rating />

    <textInput>
        <title />
        <description />
        <name />
        <link />
    </textInput>

    <skipHours />
    <skipDays />

    <item>
        <title />
        <link />
        <description />
        <author />
        <category domain = " "/>
        <comments />
        <enclousure url = " " length = " " type = " "/>
        <guid isPermaLink = " "/>
        <pubDate />
        <source url = " " />
    </item>
</channel>

The following table lists the channel elements in an RSS feed and the corresponding WPD_CONTENT_TYPE_MEDIA_CAST properties.

Channel Element	RSS Feed Requirement	Corresponding Mediacast Property
category	Optional.	WPD_MEDIA_GENRE
cloud	Not applicable.	Not applicable.
copyright	Optional.	WPD_MEDIA_COPYRIGHT
description	Required.	WPD_MEDIA_DESCRIPTION
docs	Not applicable.	Not applicable.
generator	Not applicable.	Not applicable.
language	Not applicable.	Not applicable.
lastBuildDate	Optional.	WPD_MEDIA_LAST_BUILD_DATE
link	Required.	WPD_MEDIA_DESTINATION_URL
managingEditor	Optional.	WPD_MEDIA_MANAGING_EDITOR
pubDate	Optional.	WPD_MEDIA_RELEASE_DATE
rating	Not applicable.	Not applicable.
skipDays	Not applicable.	Not applicable.
skipHours	Not applicable.	Not applicable.
textInput	Not applicable.	Not applicable.
title	Required.	WPD_OBJECT_NAME
ttl	Optional.	WPD_MEDIA_TIME_TO_LIVE
webMaster	Optional.	WPD_MEDIA_WEBMASTER

The following table lists the image elements in an RSS feed and the corresponding WPD_CONTENT_TYPE_MEDIA_CAST properties.

Image Element	RSS Feed Requirement	Mediacast Property
description	Optional.	WPD_MEDIA_DESCRIPTION
height	Optional.	WPD_MEDIA_HEIGHT
link	Optional.	WPD_MEDIA_DESTINATION_URL
title	Optional.	WPD_OBJECT_NAME
url	Optional.	WPD_MEDIA_SOURCE_URL
width	Optional.	WPD_MEDIA_WIDTH

The following table lists the item elements in an RSS feed and the corresponding WPD_CONTENT_TYPE_MEDIA_CAST properties.

Item Element	Attribute	RSS Feed Requirement	Mediacast Property
author		Optional.	WPD_MEDIA_ARTIST
category		Optional.	WPD_MEDIA_GENRE
	domain	Not applicable.	Not applicable.
description		Optional.	WPD_MEDIA_DESCRIPTION
enclosure		Optional.
	url	Required.	WPD_MEDIA_SOURCE_URL
	length	Required.	WPD_OBJECT_SIZE
	type	Required.	(The MIME type should be mapped to the property content type.)
guid		Optional.	WPD_MEDIA_GUID
	isPermaLink	Not applicable.	Not applicable.
link		Optional.	WPD_MEDIA_DESTINATION_URL
pubDate		Optional.	WPD_MEDIA_RELEASE_DATE
source		Not applicable.	Not applicable.
title		Optional.	WPD_OBJECT_NAME

Example

The following example shows a complete RSS feed for a fictitious podcast supplied by the CEO of a publishing company.

<channel>
    <title>The Digital Publication</title>
    <link>https://www.lucernepublishing.com/podcasting</link>
    <description>Lucerne Publishing CEO Peter Bankov takes a look at the latest trends in online publications.</description>
    <language>en-us</language>
    <copyright>2006 Lucerne Publishing LP, LLLP. All Rights Reserved.</copyright>
    <managingEditor>someone@example.com</managingEditor>
    <webMaster>someone@example.com</webMaster>
    <pubDate>Fri, 9 June 2006 14:00:28 EDT</pubDate>
    <lastBuildDate Fri, 9 June 2006 14:00:28 EDT />
    <category>News</category>
    <generator>Podcaster version 1.0</generator>
    <docs>https://www.lucernepublishing.com/tech/rss</docs>
    <cloud />
    <ttl>240</ttl>
    <rating />
    <textInput />
    <skipHours />
    <skipDays />

<image>
     <url>https://www.lucernepublishing.com/images/logo.gif</url>
     <title>Lucerne Publishing</title>
     <link>https://www.lucernepublishing.com/community/podcasts</link>
     <width>300</width>
     <height>300</height>
     <description>Lucerne Logo</description>
</image>

<item>
    <title>The Digital Publication</title>
    <link>https://www.lucernepublishing.com/services/podcasting/digital.publishing/audio/2006/06/digital0601.mp3</link>
    <description>Online publications are rapidly changing. A publishing house CEO examines the trends of the past 5 years and their implications.</description>
    <author>Lucerne</author>
    <category>News</category>
    <comments />
    <enclosure url="https://www.lucernepublishing/services/podcasting/digital.publishing/audio/2006/06/digital0601.mp3" length="10329011" type="audio/mpeg" />
    <guid>https://www.lucernepublishing/services/podcasting/digital.publishing/audio/2006/06/digital0601.mp3</guid>
    <pubDate>Thur, 1 June 2006 14:00:28 EDT</pubDate>
    <source />
</item>

</channel>

Mapping of RSS Channel Elements to WPD Property Values

The following table describes how the values in the RSS channel elements in the previous example map to particular WPD properties.

WPD Property	Value
WPD_MEDIA_COPYRIGHT	2006 Lucerne Publishing LP, LLLP. All Rights Reserved.
WPD_MEDIA_DESCRIPTION	Lucerne Publishing CEO Peter Bankov takes a look at the latest trends in online publications.
WPD_MEDIA_DESTINATION_URL	https://www.lucernepublishing.com/services/podcasting
WPD_MEDIA_GENRE	News
WPD_MEDIA_LAST_BUILD_DATE	Fri, 9 June 2006 14:00:28 EDT
WPD_MEDIA_MANAGING_EDITOR	someone@example.com
WPD_MEDIA_RELEASE_DATE	Fri, 9 June 2006 14:00:28 EDT
WPD_MEDIA_TIME_TO_LIVE	240
WPD_MEDIA_TITLE	The Digital Publication
WPD_MEDIA_SOURCE_URL	https://www.lucernepublishing/services/podcasting/digital.publication/rss.xml
WPD_MEDIA_WEBMASTER	someone@example.com
WPD_OBJECT_CONTENT_TYPE	WPD_CONTENT_TYPE_MEDIA_CAST
WPD_OBJECT_DATE_AUTHORED	Fri, 9 June 2006 14:00:28 EDT
WPD_OBJECT_DATE_CREATED	Fri, 9 June 2006 14:00:28 EDT
WPD_OBJECT_DATE_MODIFIED	Fri, 9 June 2006 14:00:28 EDT
WPD_OBJECT_FORMAT	WPD_OBJECT_FORMAT_ABSTRACT_MEDIA_CAST
WPD_OBJECT_ID	Session dependent value.
WPD_OBJECT_NAME	The Digital Publication
WPD_OBJECT_ORIGINAL_FILE_NAME	The Digital Publication
WPD_OBJECT_PARENT_ID	MyPodcasts (a fictitious podcast folder on the device). Assume "0A0" for this example.
WPD_OBJECT_PERSISTENT_UNIQUE_ID	Session independent value. (Assume "0A1" for this example.)
WPD_OBJECT_REFERENCES	0A2 … for N items
WPD_OBJECT_SIZE	13,790

Mapping of RSS Image Elements to WPD Property Values

The following table describes how the values in the RSS Image elements in the previous example map to particular WPD properties.

WPD Property	Value
WPD_MEDIA_DESCRIPTION	Lucerne Logo
WPD_MEDIA_DESTINATION_URL	https://www.lucernepublishing.com/community/podcasts
WPD_MEDIA_HEIGHT	300
WPD_MEDIA_SOURCE_URL	https://www.lucernepublishing.com/images/logo.gif
WPD_MEDIA_WIDTH	300
WPD_OBJECT_NAME	Lucerne Publishing
WPD_RESOURCE_ATTRIBUTE_CAN_DELETE	VARIANT_TRUE
WPD_RESOURCE_ATTRIBUTE_CAN_READ	VARIANT_TRUE
WPD_RESOURCE_ATTRIBUTE_FORMAT	WPD_OBJECT_FORMAT_GIF
WPD_RESOURCE_ATTRIBUTE_OPTIMAL_READ_BUFFER_SIZE	1024
WPD_RESOURCE_ATTRIBUTE_TOTAL_SIZE	512

Mapping of RSS Item Elements to WPD Property Values

The following table describes how the values in the RSS Item elements in the previous example map to particular WPD properties.

WPD Property	Value
WPD_MEDIA_TITLE	The Digital Publication
WPD_MEDIA_DURATION	10329011
WPD_MEDIA_ARTIST	Lucerne
WPD_MEDIA_DESCRIPTION	Online publications are rapidly changing. A publishing house CEO examines the trends of the past 5 years and their implications.
WPD_MEDIA_DESTINATION_URL	https://www.lucernepublishing/services/podcasting/digital.publishing/audio/2006/06/digital0601.mp3
WPD_MEDIA_GENRE	News
WPD_MEDIA_GUID	https://www.lucernepublishing/services/podcasting/digital.publishing/audio/2006/06/digital0601.mp3
WPD_MEDIA_RELEASE_DATE	Thur, 1 June 2006 14:00:28 EDT
WPD_MEDIA_SOURCE_URL	https://www.lucernepublishing/services/podcasting/digital.publishing/audio/2006/06/digital0601.mp3
WPD_OBJECT_BACK_REFERENCES	0A1
WPD_OBJECT_CONTENT_TYPE	WPD_CONTENT_TYPE_MEDIA_IMAGE
WPD_OBJECT_DATE_AUTHORED	Thur, 1 June 2006 14:00:28 EDT
WPD_OBJECT_DATE_CREATED	Thur, 1 June 2006 14:00:28 EDT
WPD_OBJECT_DATE_MODIFIED	Thur, 1 June 2006 14:00:28 EDT
WPD_OBJECT_FORMAT	WPD_OBJECT_FORMAT_MP3
WPD_OBJECT_ID	Session dependent. (Assume "0A2" for this example.)
WPD_OBJECT_NAME	The Digital Publication
WPD_OBJECT_ORIGINAL_FILE_NAME	digital0601.mp3
WPD_OBJECT_PARENT_ID	0A0
WPD_OBJECT_PERSISTENT_UNIQUE_ID	Session independent.
WPD_OBJECT_SIZE	10329011

See Also

Requirements for Objects

Previous

Next

Share via

WPD_CONTENT_TYPE_MEDIA_CAST

WPD_CONTENT_TYPE_MEDIA_CAST

Additional resources