org.ocap.hn.recording
Interface RecordingNetModule

All Superinterfaces:

NetModule

All Known Subinterfaces:

NetRecordingRequestManager

public interface RecordingNetModule
extends NetModule

An interface representing a NetModule which provides DVR functionality.

NetModules which implement this interface SHALL have a NetModule.PROP_NETMODULE_TYPE property value of NetModule.CONTENT_RECORDER.

Field Summary

Fields inherited from interface org.ocap.hn.NetModule

CONTENT_LIST, CONTENT_MANAGER, CONTENT_RECORDER, CONTENT_RENDERER, CONTENT_SERVER, PROP_CONTROL_URL, PROP_DESCRIPTION_URL, PROP_EventSub_URL, PROP_NETMODULE_ID, PROP_NETMODULE_TYPE

Method Summary

NetActionRequest	requestDelete(ContentEntry recording, NetActionHandler handler) Requests that metadata associated with a scheduled recording be deleted from storage.
NetActionRequest	requestDeleteService(ContentEntry recording, NetActionHandler handler) Requests that content associated with a scheduled recording be deleted from storage.
NetActionRequest	requestDisable(ContentEntry recording, NetActionHandler handler) Requests that an in progress recording be disabled on this network recording device.
NetActionRequest	requestPrioritize(NetRecordingEntry[] recordings, NetActionHandler handler) Requests that a group of scheduled recording request be prioritized on this network recording device, where each recording request may represent one or more individual recordings on the remote device.
NetActionRequest	requestPrioritize(RecordingContentItem[] recordings, NetActionHandler handler) Requests that a group of scheduled individual recordings be prioritized on this network recording device.
NetActionRequest	requestReschedule(ContentEntry recording, NetRecordingSpec recordingSpec, NetActionHandler handler) Requests that a recording be rescheduled on this network recording device.
NetActionRequest	requestSchedule(NetRecordingSpec recordingSpec, NetActionHandler handler) Requests that a recording be scheduled on this network recording device.

Methods inherited from interface org.ocap.hn.NetModule

addNetModuleEventListener, getDevice, getKeys, getNetModuleId, getNetModuleType, getProperty, isLocal, removeNetModuleEventListener

Method Detail

requestSchedule

NetActionRequest requestSchedule(NetRecordingSpec recordingSpec,
                                 NetActionHandler handler)

Requests that a recording be scheduled on this network recording device. metadata added to the NetRecordingSpec prior to calling this method will be utilized by the remote device in identifying the recording or recordings to be scheduled. Upon completion of this operation, a NetActionEvent SHALL be delivered to the given handler indicating success or failure. Upon success, values returned by calls to NetActionEvent.getResponse() SHALL contain a NetRecordingEntry representing the newly created recording.

Parameters:

recordingSpec - a recording spec containing the metadata used to identify the recordings to be scheduled.

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

Returns:

NetActionRequest to inform calling application of results.

Throws:

SecurityException - if the caller does not have HomeNetPermission("recording")

IllegalArgumentException - if recordingSpec has an empty MetadataNode, or if MetadataNode which is associated with recordingSpec does not contain the necessary metadata entry such as scheduledChannelID, scheduledStartDateTime, scheduledDuration

requestReschedule

NetActionRequest requestReschedule(ContentEntry recording,
                                   NetRecordingSpec recordingSpec,
                                   NetActionHandler handler)

Requests that a recording be rescheduled on this network recording device. Metadata added to the NetRecordingSpec prior to calling this method will be utilized by the remote device in identifying changes the recording or recordings to be rescheduled. Upon completion of this operation, a NetActionEvent SHALL be delivered to the given handler indicating success or failure.

Parameters:

recording - the previously scheduled RecordingContentItem or NetRecordingEntry to be rescheduled.

recordingSpec - a recording spec containing the metadata used to identify the changes to recordings to be rescheduled.

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

Returns:

NetActionRequest to inform calling application of results.

Throws:

SecurityException - if the caller does not have HomeNetPermission("recording")

IllegalArgumentException - if the recording parameter is neither the NetRecordingEntry with upnp:srsRecordScheduleID metadata entry nor the RecordingContentItem with upnp:srsRecordTaskID metadata entry in its own MetadataNode,or if recordingSpec has an empty MetadataNode, or if MetadataNode which is associated with recordingSpec does not contain the necessary metadata entry such as scheduledChannelID, scheduledStartDateTime, scheduledDuration

requestDisable

NetActionRequest requestDisable(ContentEntry recording,
                                NetActionHandler handler)

Requests that an in progress recording be disabled on this network recording device. If the recording is in progress, this method requests that the recording be stopped. If the recording is pending, this method requests that the recording be canceled. Upon completion of this operation, a NetActionEvent SHALL be delivered to the given handler indicating success or failure.

Parameters:

recording - a RecordingContentItem or NetRecordingEntry that identifies the recording(s) to be canceled.

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

Returns:

NetActionRequest to inform calling application of results.

Throws:

SecurityException - if the caller does not have HomeNetPermission("recording")

IllegalArgumentException - if the recording parameter is neither the NetRecordingEntry with upnp:srsRecordScheduleID metadata entry nor the RecordingContentItem with upnp:srsRecordTaskID metadata entry in its own MetadataNode

requestDeleteService

NetActionRequest requestDeleteService(ContentEntry recording,
                                      NetActionHandler handler)

Requests that content associated with a scheduled recording be deleted from storage. Upon completion of this operation, a NetActionEvent SHALL be delivered to the given handler indicating success or failure.

Parameters:

recording - a RecordingContentItem or NetRecordingEntry that identifies the recording(s) to be deleted.

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

Returns:

NetActionRequest to inform calling application of results.

Throws:

SecurityException - if the caller does not have HomeNetPermission("recording")

requestDelete

NetActionRequest requestDelete(ContentEntry recording,
                               NetActionHandler handler)

Requests that metadata associated with a scheduled recording be deleted from storage. Upon completion of this operation, a NetActionEvent SHALL be delivered to the given handler indicating success or failure.

Parameters:

recording - a recording that identifies the recording to be deleted.

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

Returns:

NetActionRequest to inform calling application of results.

Throws:

SecurityException - if the caller does not have HomeNetPermission("recording")

requestPrioritize

NetActionRequest requestPrioritize(RecordingContentItem[] recordings,
                                   NetActionHandler handler)

Requests that a group of scheduled individual recordings be prioritized on this network recording device. Prioritization is determined by the ordering of recordings in the array of RecordingContentItems, with highest priority given to the entry at element 0 in the array. Upon completion of this operation, a NetActionEvent SHALL be delivered to the given handler indicating success or failure.

Parameters:

recordings - a prioritized array of RecordingContentItems

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

Returns:

NetActionRequest to inform calling application of results.

Throws:

SecurityException - if the caller does not have HomeNetPermission("recording")

requestPrioritize

NetActionRequest requestPrioritize(NetRecordingEntry[] recordings,
                                   NetActionHandler handler)

Requests that a group of scheduled recording request be prioritized on this network recording device, where each recording request may represent one or more individual recordings on the remote device. Prioritization is determined by the ordering of recordings in the array of NetRecordingEntries with highest priority given to the entry at element 0 in the array. Upon completion of this operation, a NetActionEvent SHALL be delivered to the given handler indicating success or failure.

Parameters:

recordings - a prioritized array of NetRecordingEntries

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

Returns:

NetActionRequest to inform calling application of results.

Throws:

SecurityException - if the caller does not have HomeNetPermission("recording")