org.ocap.hn.recording
Interface NetRecordingRequestHandler

public interface NetRecordingRequestHandler

A class implementing this interface processes recording requests received from devices on the home network.

An application which has a class implementing this interface may set an instance of it in a local RecordingNetModule. It is up to the application to interpret metadata associated with NetRecordingSpecs and RecordingContentItems delivered in the callback methods, and translate these requests into local DVR recordings.

Method Summary

boolean	notifyDelete(InetAddress address, ContentEntry recording) Notifies this NetRecordingRequestHandler that a device on the home network has requested that metadata associated with a recording be deleted.
boolean	notifyDeleteService(InetAddress address, ContentEntry recording) Notifies this NetRecordingRequestHandler that a device on the home network has requested that content associated with a recorded service be deleted.
boolean	notifyDisable(InetAddress address, ContentEntry recording) Notifies this NetRecordingRequestHandler that a device on the home network has requested that a recording be disabled.
boolean	notifyPrioritization(InetAddress address, NetRecordingEntry[] recordings) Notifies this NetRecordingRequestHandler that a device on the home network has requested that a group of recordings be re-prioritized.
boolean	notifyPrioritization(InetAddress address, RecordingContentItem[] recordings) Notifies this NetRecordingRequestHandler that a device on the home network has requested that a group of individual recordings be re-prioritized.
boolean	notifyReschedule(InetAddress address, ContentEntry recording, NetRecordingEntry spec) Notifies this NetRecordingRequestHandler that a device on the home network has requested that a recording be rescheduled.
boolean	notifySchedule(InetAddress address, NetRecordingEntry spec) Notifies this NetRecordingRequestHandler that a device on the home network has requested that a recording be scheduled.

Method Detail

notifySchedule

boolean notifySchedule(InetAddress address,
                       NetRecordingEntry spec)

Notifies this NetRecordingRequestHandler that a device on the home network has requested that a recording be scheduled. Handler applications MAY inspect any metadata associated with the NetRecordingEntry passed with the method invocation, and translate such metadata in one or more local DVR recordings. Applications SHOULD associate such recordings with the NetRecordingEntry by adding the recordings to the entry using the NetRecordingEntry.addRecordingContentItem() method.

Parameters:

address - IP address of the device on the home network which has issues this request

spec - the NetRecordingEntry which describes the requested recording

Returns:

true if the schedule request can be successfully processed, or false if the request will not be processed.

See Also:

NetRecordingEntry.addRecordingContentItem(RecordingContentItem)

notifyReschedule

boolean notifyReschedule(InetAddress address,
                         ContentEntry recording,
                         NetRecordingEntry spec)

Notifies this NetRecordingRequestHandler that a device on the home network has requested that a recording be rescheduled. Handler applications MAY inspec any metadata contained within the NetRecordingEntry passed into this method, and utilize such metadata to reschedule the local DVR recording represented by the given ContentEntry. This ContentEntry may represent an individual recording as a RecordingContentItem, or may represent a collection of recordings contained within a NetRecordingEntry object.

Parameters:

address - the IP address of the device on the home network which has issues this request

recording - the RecordingContentItem or NetRecordingEntry to be rescheduled

spec - the NetRecordingEntry object containing the metadata to be used to reschedule the recording

Returns:

true if the reschedule request can be successfully processed,or false if the request will not be processed.

notifyDisable

boolean notifyDisable(InetAddress address,
                      ContentEntry recording)

Notifies this NetRecordingRequestHandler that a device on the home network has requested that a recording be disabled. If the recording is in progress, this is a request to stop the recording. If the recording is pending, this is a request to cancel the recording. Applications MAY cancel or stop the given recording in response to this request.

Parameters:

address - the IP address of the device on the home network which has issues this request

recording - the RecordingContentItem or RecordingNetEntry to be disabled

Returns:

true if the disable request can be successfully processed,or false if the request will not be processed.

notifyDelete

boolean notifyDelete(InetAddress address,
                     ContentEntry recording)

Notifies this NetRecordingRequestHandler that a device on the home network has requested that metadata associated with a recording be deleted. Applications MAY delete the given recording in response to this request.

Parameters:

address - the IP address of the device on the home network which has issues this request

recording - the RecordingContentItem or NetRecordingEntry to be deleted

Returns:

true if the delete request can be successfully processed,or false if the request will not be processed.

notifyDeleteService

boolean notifyDeleteService(InetAddress address,
                            ContentEntry recording)

Notifies this NetRecordingRequestHandler that a device on the home network has requested that content associated with a recorded service be deleted. Applications MAY delete the content associated with the given recording in response to this request.

Parameters:

address - the IP address of the device on the home network which has issues this request

recording - requested the RecordingContentItem or NetRecordingEntry

Returns:

true if the delete request can be successfully processed,or false if the request will not be processed.

notifyPrioritization

boolean notifyPrioritization(InetAddress address,
                             NetRecordingEntry[] recordings)

Notifies this NetRecordingRequestHandler that a device on the home network has requested that a group of recordings be re-prioritized. The requested prioritization is represented by the ordering of the NetRecordingEntry objects in the given array, with the highest priority at index 0 of the array. Applications MAY prioritize some or all of the local DVR recordings contained within the NetRecordingEntry array.

Parameters:

address - the IP address of the device on the home network which has issues this request

recordings - the NetRecordingEntrys to be prioritized

Returns:

true if the prioritization request can be successfully processed,or false if the request will not be processed.

notifyPrioritization

boolean notifyPrioritization(InetAddress address,
                             RecordingContentItem[] recordings)

Notifies this NetRecordingRequestHandler that a device on the home network has requested that a group of individual recordings be re-prioritized. The requested prioritization is represented by the ordering of the RecordingContentItem objects in the given array, with the highest priority at index 0 of the array. Applications MAY prioritize the local DVR recordings contained within the RecordingContentItem array.

Parameters:

address - IP address of the device on the home network which has issued this request.

recordings - The recording content items associated with the recordings to be prioritized.

Returns:

True if the prioritization request can be successfully processed,or false if the request will not be processed.