org.ocap.hn.recording
Interface RecordingContentItem

All Superinterfaces:

ContentEntry, ContentItem

public interface RecordingContentItem
extends ContentItem

This ContentItem represents a recording that has been scheduled on the home network. This interface represents a DVR recording which can be published to the home network. On devices which support both the OCAP Home Networking API and the OCAP DVR API, objects implementing org.ocap.dvr.OcapRecordingRequest will also implement this interface. When a RecordingRequest is deleted, implementations SHALL call the RecordingContentItem.deleteEntry method in the same object.

Field Summary

static String	PROP_ACCESS_PERMISSIONS Key constant for retrieving the file access permissions of this recording item from this item's metadata.
static String	PROP_APP_ID Key constant for retrieving the application ID of this recording item from this item's metadata.
static String	PROP_CONTENT_URI Key constant for retrieving the location of content associated with this recording item from this item's metadata.
static String	PROP_DESTINATION Key constant for retrieving the destination of this recording item from this item's metadata.
static String	PROP_DURATION Key constant for retrieving the duration in milliseconds of this recording item from this item's metadata.
static String	PROP_EXPIRATION_PERIOD Key constant for retrieving the expiration period for this recording item from this item's metadata.
static String	PROP_MEDIA_FIRST_TIME Key constant for retrieving the media first time for this recording item from this item's metadata.
static String	PROP_MSO_CONTENT Key constant for retrieving the MSO content indicator for this recording item from this item's metadata.
static String	PROP_NET_RECORDING_ENTRY Key constant for retrieving the ID of any NetRecordingEntry containing this RecordingContentItem.
static String	PROP_ORGANIZATION Key constant for retrieving the organization of this recording item from this item's metadata.
static String	PROP_PRESENTATION_POINT Key constant for retrieving the presentation point for this recording item from this item's metadata.
static String	PROP_PRIORITY_FLAG Key constant for retrieving the priority flag of this recording item from this item's metadata.
static String	PROP_RECORDING_STATE Key constant for retrieving the state of this recording item from this item's metadata.
static String	PROP_RETENTION_PRIORITY Key constant for retrieving the retention priority of this recording item from this item's metadata.
static String	PROP_SOURCE_ID Key constant for retrieving the source ID of this recording item from this item's metadata.
static String	PROP_SOURCE_ID_TYPE Key constant for retrieving the source ID type of this recording item from this item's metadata.
static String	PROP_SPACE_REQUIRED Key constant for retrieving the estimated space required for this recording item from this item's metadata.
static String	PROP_START_TIME Key constant for retrieving the start time of this recording item from this item's metadata.

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

Method Summary

boolean	deleteEntry() Deletes this RecordingContentItem, but does not remove the physical recording.
NetRecordingEntry	getRecordingEntry() Returns the NetRecordingEntry which contains this recording content item if the NetRecordingEntry is available.
String	getRecordingEntryID() Returns the ObjectID of the NetRecordingEntry which contains this recording content item.
NetActionRequest	requestConflictingRecordings(NetActionHandler handler) Requests a list of recordings whose usage of resources conflict with this recording content item.
NetActionRequest	requestSetMediaTime(javax.media.Time time, NetActionHandler handler) Requests that the presentation point of this recording be updated.

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

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

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

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

Field Detail

PROP_RECORDING_STATE

static final String PROP_RECORDING_STATE

Key constant for retrieving the state of this recording item from this item's metadata. Values returned for this key will be represented as an Integer.

See Also:

Constant Field Values

PROP_START_TIME

static final String PROP_START_TIME

Key constant for retrieving the start time of this recording item from this item's metadata. Values returned for this key will be represented as a java.util.Date.

See Also:

Constant Field Values

PROP_DURATION

static final String PROP_DURATION

Key constant for retrieving the duration in milliseconds of this recording item from this item's metadata. Values returned for this key will be represented as an Integer.

See Also:

Constant Field Values

PROP_SOURCE_ID

static final String PROP_SOURCE_ID

Key constant for retrieving the source ID of this recording item from this item's metadata. Values returned for this key will be represented as a String.

See Also:

Constant Field Values

PROP_SOURCE_ID_TYPE

static final String PROP_SOURCE_ID_TYPE

Key constant for retrieving the source ID type of this recording item from this item's metadata. Values returned for this key will be represented as a String.

See Also:

Constant Field Values

PROP_DESTINATION

static final String PROP_DESTINATION

Key constant for retrieving the destination of this recording item from this item's metadata. Values returned for this key will be represented as a String.

See Also:

Constant Field Values

PROP_PRIORITY_FLAG

static final String PROP_PRIORITY_FLAG

Key constant for retrieving the priority flag of this recording item from this item's metadata. Values returned for this key will be represented as an Integer.

See Also:

Constant Field Values

PROP_RETENTION_PRIORITY

static final String PROP_RETENTION_PRIORITY

Key constant for retrieving the retention priority of this recording item from this item's metadata. Values returned for this key will be represented as an Integer.

See Also:

Constant Field Values

PROP_ACCESS_PERMISSIONS

static final String PROP_ACCESS_PERMISSIONS

Key constant for retrieving the file access permissions of this recording item from this item's metadata. Values returned for this key will be represented as an org.ocap.storage.ExtendedFileAccessPermissions.

See Also:

Constant Field Values

PROP_ORGANIZATION

static final String PROP_ORGANIZATION

Key constant for retrieving the organization of this recording item from this item's metadata. Values returned for this key will be represented as a String.

See Also:

Constant Field Values

PROP_APP_ID

static final String PROP_APP_ID

Key constant for retrieving the application ID of this recording item from this item's metadata. Values returned for this key will be represented as an org.dvb.application.AppID.

See Also:

Constant Field Values

PROP_SPACE_REQUIRED

static final String PROP_SPACE_REQUIRED

Key constant for retrieving the estimated space required for this recording item from this item's metadata. Values returned for this key will be represented as a Long.

See Also:

Constant Field Values

PROP_CONTENT_URI

static final String PROP_CONTENT_URI

Key constant for retrieving the location of content associated with this recording item from this item's metadata. Values returned for this key will be represented as a String.

See Also:

Constant Field Values

PROP_MEDIA_FIRST_TIME

static final String PROP_MEDIA_FIRST_TIME

Key constant for retrieving the media first time for this recording item from this item's metadata. Values returned for this key will be represented as a Long.

See Also:

Constant Field Values

PROP_PRESENTATION_POINT

static final String PROP_PRESENTATION_POINT

Key constant for retrieving the presentation point for this recording item from this item's metadata. Values returned for this key will be represented as a Long.

See Also:

Constant Field Values

PROP_EXPIRATION_PERIOD

static final String PROP_EXPIRATION_PERIOD

Key constant for retrieving the expiration period for this recording item from this item's metadata. Values returned for this key will be represented as an Long.

See Also:

Constant Field Values

PROP_MSO_CONTENT

static final String PROP_MSO_CONTENT

Key constant for retrieving the MSO content indicator for this recording item from this item's metadata. Values returned for this key will be represented as an Boolean.

See Also:

Constant Field Values

PROP_NET_RECORDING_ENTRY

static final String PROP_NET_RECORDING_ENTRY

Key constant for retrieving the ID of any NetRecordingEntry containing this RecordingContentItem. Values returned for this key will be represented as a String.

See Also:

Constant Field Values

Method Detail

deleteEntry

boolean deleteEntry()
                    throws IOException

Deletes this RecordingContentItem, but does not remove the physical recording. Deletes a local RecordingContentItem only. If the #isLocal method returns false an exception is thrown.

Note: this overrides the definition of ContentItem.deleteEntry(). If an application calls the ContentEntry.deleteEntry method on an object that is an instance of RecordingContentItem, the implementation SHALL delete the RecordingContentItem as defined by this method.

Specified by:

deleteEntry in interface ContentEntry

Specified by:

deleteEntry in interface ContentItem

Returns:

True if this RecordingContentItem was deleted, otherwise returns false.

Throws:

SecurityException - if the application does not have write ExtendedFileAccessPermission.

IOException - if the RecordingContentItem is not local.

requestSetMediaTime

NetActionRequest requestSetMediaTime(javax.media.Time time,
                                     NetActionHandler handler)

Requests that the presentation point of this recording be updated.

Parameters:

time - The presentation point of this recording.

handler - The NetActionHandler which gets informed once this request completes.

Returns:

NetActionRequest which can be used to monitor asynchronous action progress

requestConflictingRecordings

NetActionRequest requestConflictingRecordings(NetActionHandler handler)

Requests a list of recordings whose usage of resources conflict with this recording content item. The resulting list of recordings SHALL be returned as an array of RecordingContentItem objects from the NetActionEvent.getResponse() method of the resulting NetActionEvent.

Parameters:

handler - The NetActionHandler implementation to receive the asynchronous response to this request

Returns:

NetActionRequest which can be used to monitor asynchronous action progress

getRecordingEntry

NetRecordingEntry getRecordingEntry()

Returns the NetRecordingEntry which contains this recording content item if the NetRecordingEntry is available.

Returns:

null if this RecordingContentItem is not added to any NetRecordingEntry or if the NetRecordingEntry containing this RecordingContentItem is not available. Otherwise the NetRecordingEntry containing this RecordingContentItem

getRecordingEntryID

String getRecordingEntryID()

Returns the ObjectID of the NetRecordingEntry which contains this recording content item. The ObjectID can be obtained from ocap:netRecordingEntry property of this recording content item.

Returns:

null if this RecordingContentItem does not contain ocap:netRecordingEntry property. Otherwise, the value contained in ocap:netRecordingEntry property of this RecordingContentItem.