org.ocap.hn.content

Interface ChannelContentItem

All Superinterfaces:

ContentEntry, ContentItem

public interface ChannelContentItem
extends ContentItem

This interface represents a video or audio broadcast channel object.

Field Summary

Fields inherited from interface org.ocap.hn.content.ContentItem

AUDIO_ITEM, AUDIO_ITEM_BOOK, AUDIO_ITEM_BROADCAST, AUDIO_ITEM_TRACK, IMAGE_ITEM, IMAGE_ITEM_PHOTO, ITEM, VIDEO_ITEM, VIDEO_ITEM_BROADCAST, VIDEO_ITEM_MOVIE, VIDEO_ITEM_MUSIC_CLIP, VIDEO_ITEM_VPOP

Method Summary

Methods

Modifier and Type	Method and Description
org.ocap.net.OcapLocator	getChannelLocator() Gets the locator for this ChannelContentItem set in createChannelContentItem.
String	getChannelName() Gets The channel name for this ChannelContentItem
String	getChannelNumber() Gets The channel number for this ChannelContentItem
String	getChannelTitle() Gets The title for this ChannelContentItem, or null if the title is unknown.
String	getChannelType() Gets The channel type for this ChannelContentItem
org.ocap.storage.ExtendedFileAccessPermissions	getExtendedFileAccessPermissions() Gets the extended file access permissions for this ChannelContentItem.
org.ocap.net.OcapLocator	getTuningLocator() Gets the frequency based tuning locator used for service resolution.
boolean	setTuningLocator(org.ocap.net.OcapLocator locator) Sets the tuning locator for this ChannelContentItem that the implementation can use for tuning a broadcast channel.

Methods inherited from interface org.ocap.hn.content.ContentItem

containsResource, deleteEntry, getContentClass, getItemService, getRenderableResources, getResource, getResourceCount, getResourceIndex, getResources, getTitle, hasAudio, hasStillImage, hasVideo, isRenderable

Methods inherited from interface org.ocap.hn.content.ContentEntry

getContentSize, getCreationDate, getEntryParent, getID, getParentID, getRootMetadataNode, getServer, isLocal

Method Detail

getChannelType

String getChannelType()

Gets The channel type for this ChannelContentItem

Returns:

the String channel type for this item, or null if unknown.

getChannelNumber

String getChannelNumber()

Gets The channel number for this ChannelContentItem

Returns:

The String channel number for this item, or null if unknown.

getChannelName

String getChannelName()

Gets The channel name for this ChannelContentItem

Returns:

the String channel name for this item, or null if unknown.

getChannelTitle

String getChannelTitle()

Gets The title for this ChannelContentItem, or null if the title is unknown.

Returns:

the String title for this item, or null if unknown.

getChannelLocator

org.ocap.net.OcapLocator getChannelLocator()

Gets the locator for this ChannelContentItem set in createChannelContentItem.

Returns:

The locator for this ChannelContentItem, returns null if the isLocal method returns false.

getExtendedFileAccessPermissions

org.ocap.storage.ExtendedFileAccessPermissions getExtendedFileAccessPermissions()

Gets the extended file access permissions for this ChannelContentItem.

Specified by:

getExtendedFileAccessPermissions in interface ContentEntry

Returns:

The extended file access permissions.

getTuningLocator

org.ocap.net.OcapLocator getTuningLocator()

Gets the frequency based tuning locator used for service resolution.

Returns:

The frequency based tuning locator if previously resolved, null otherwise.

setTuningLocator

boolean setTuningLocator(org.ocap.net.OcapLocator locator)
                         throws javax.tv.locator.InvalidLocatorException

Sets the tuning locator for this ChannelContentItem that the implementation can use for tuning a broadcast channel. Returns false if the #isLocal method returns false.

An application may call this method to update a channel's tuning parameters (for example, when an SDV channel's program number or frequency changes). Upon a successful update of the channel's tuning parameters the implementation SHALL be responsible for updating any active streaming sessions to the new tuning parameters. When a JavaTV Service represents this ChannelContentItem the implementation SHALL modify the transport dependent locator of the Service to match the locator parameter.

Setting the channel tuning locator to a null locator makes the channel item no longer tunable (for example, when the application ends an SDV session). Setting the tuning locator to null while streaming ends streaming, removes the locator, and StreamingActivityListener.notifyStreamingEnded(org.ocap.hn.content.ContentItem, int, int) is called with an activityID of ACTIVITY_END_SERVICE_VANISHED .

Parameters:

locator - A frequency-based locator for the channel, or null to remove the current locator.

Returns:

true when the locator parameter is set correctly, otherwise, returns false.

Throws:

javax.tv.locator.InvalidLocatorException - if the locator parameter is not frequency based and is not null.

SecurityException - if the calling application is not granted write permission by the permissions returned from the getExtendedFileAccessPermissions method.