editor
278
edits
Changes
Jump to navigation
Jump to search
Returns an array of [[RecordingSchedule|RecordingSchedule]] objects, filled with the recording related parameters:
*If the recording was successfully deleted by the platform, its state will be "Deleted"
*If a given recording could not be deleted, its state will remain "Recorded".
*If a given recording was not found, its state will be "Not Found".
DeleteRecordingSchedule (view source)
Revision as of 09:09, 31 October 2014
, 09:09, 31 October 2014no edit summary
{{Api_Method_Spec|
Description= Delete each of Deletes the given provided Recording Schedule Recording from the platform. If Returns an array of [[RecordingSchedule|RecordingSchedule]] objects, filled with the external platform provides results and status parameters. <p>* '''Mirada comments''':</p>* Clients wanting to cancel (or delete) a recording should have to firstly request a Network PVR service[[GetAllRecordingSchedules|GetAllRecordingSchedules]] call, this method in order to retrieve the recordings ID and (in the case of Mirada) the associated lastModified value that must be included in the cancel/delete request. This parameter will not be available (GetAllRecordingSchedules will remove contents accessible return 0) for some other rPVR backends.* When cancelling things "in the future" (not started yet), such as individual movies/episodes not started yet, or the cancellation of entire series, the final purpose is to "avoid" the future recording of an event. The [[RecordingSchedule|RecordingSchedule]] object would be set to GVP status "Cancelled"* When cancelling only a thing that is just being recorded at the current moment (at the moment of invoking cancel by the networkclient) the final purpose is to "stop" the ongoing recording (and the status of the schedule, in both Mirada's backend and in the [[RecordingSchedule|RecordingSchedule]] object returned to clients, would be set to "finished"/completed, not "cancelled"). In This is the case when cancelling individual events or episodes within series (but NOT cancelling the whole series) AND the event to cancel is just being recorded at this moment. <p>* '''Mediaroom comments''':</p>* The Mediaroom API (RemoveRecordingDefinition) method removes a recording definition (the equivalent concept to a [[RecordingSchedule|RecordingSchedule]]), and all associated upcoming recordings, from an account's schedule. The behavior of Remote PVR service availabilitythe method depends on whether there are recordings already associated with this recording definition:<ul> <li>If there are no recordings associated with this definition (there are no matching programs in the current EPG data), the recording definition is deleted.</li> <li>If recordings have already been made, the existing recordings are kept, but the recording definition's state is set to "cancelled, " preventing any future recordings from being made. After all existing recordings have been deleted, the recording definition is automatically deleted.</li> <li>If a recording is currently in progress, it is halted. The recording definition's state is also set to "cancelled," preventing future recordings from being made. Again, after all existing recordings have been deleted, the recording definition is automatically deleted.</li></ul>* In the [[RecordingSchedule|RecordingSchedule]] object handled by GVP (returned to clients), the status would be set to the state "Cancelled" (as this method state includes both "cancelled" and "deleted" schedules that will physically delete contents from be the connected STB hard disk.states managed by Mediaroom when invoking RemoveRecordingDefinition)
|Parameters=
|ParamRequired=optional (declared "optional" for backwards compatibility; but needed for correct operation)
|ParamDescription=ID (string) of the Recording Schedule to be deleted
}}
{{Api_Parameter|
ParamName=lastModified
|ParamType=int
|ParamRequired=optional (needed for correct operation in Mirada)
|ParamDescription=Date-time of the last modification of the recording schedule (must be previously obtained from Mirada's backend)
}}
{{Api_Parameter|
