Since the Recording class implements the ScheduledRecording interface, the properties required to be supported from that interface as defined above are also required.
All other properties are not included.
Security: Trusted Mandatory only if PVR feature is supported.
The Recording class represents an in-progress or completed recording being made available through the extended PVR management functionality as defined in section 7.10.4. Recordings for which no data has yet been recorded are represented by the ScheduledRecording class.
This class implements the ScheduledRecording interface (see section 7.10.2) to provide access to the information relating to the scheduling of the recording. The difference between scheduled recordings, in-progress recordings and completed recordings is primarily what properties are populated with values. In addition, for recorded and in-progress recordings the following is true:
The startPadding property is read only.
For in-progress recordings, changes to the value of the endPadding property SHALL modify the actual duration of the recording. If the value of the endPadding property is changed so that the current actual duration of the recording exceeds the new actual duration specified by the sum of the startPadding, duration and endPadding properties, the recording SHALL be stopped immediately. Changing the value of this property for a completed recording SHALL have no effect.
Recordings MAY be “manual” in that they simply record a channel at a certain time, for a period – analogous to a traditional VCR – or alternatively recordings can be programme based.
If an in-progress recording is interrupted and automatically resumed, e.g. due to a temporary power failure, all sections of the recording SHALL be represented by a single Recording object.
Values of properties in the Recording object SHALL be obtained from metadata about the recorded programme and are typically copied from the Programme used for scheduling a recording by the record(Programme programme) method of the application/oipfRecordingScheduler object. See section 7.10.4 for more information about the mapping between the properties of a Programme and the BCG metadata. In the event of a conflict between the metadata in the Programme and that in the broadcast channel, the conflict resolution is implementation dependent.
NOTE: The property parentalRatings formerly defined as part of this class is now redundant following the renaming of the parentalRating property in the ScheduledRecording class to parentalRatings.
NOTE: The properties state and isManual formerly defined in this class are now defined in the ScheduledRecording class, and since the Recording class inherits from the ScheduledRecording class they are still part of the Recording class.
readonly String uri
A uri identifying the content item in local storage according to [RFC3986]. The format of the URI is outside the scope of this specification except that; · the scheme SHALL NOT be one that is included in this specification · the URI SHALL NOT include a fragment
readonly String id
An identifier for this recording. This value SHALL be unique to this recording and so can be used to compare two recording objects to see if they refer to the same recording. The OITF SHALL guarantee that recording identifiers are unique in relation to download identifiers and CODAsset identifiers.
If true, then this recording should not be automatically deleted by the system.
The number of days for which an individual or manual recording SHOULD be saved. Recordings older than this value MAY be deleted. If the value of this property is undefined, the default save duration SHALL be used.
The number of episodes of a series-link that SHOULD be saved. Older episodes MAY be deleted. This is only valid when set on the latest scheduled recording in the series. If the value of this property is undefined, the default value SHALL be used.
readonly Boolean blocked
Flag indicating whether the programme is blocked due to parental control settings or conditional access restrictions.
The blocked and locked properties work together to provide a tri-state flag describing the status of a programme. This can best be described by the following table:
No parental control applies.
Item is above the parental rating threshold (or manually blocked); no PIN has been entered to view it and so the item cannot currently be viewed.
Item is above the parental rating threshold (or manually blocked); the PIN has been entered and so the item can be viewed.
Invalid combination – OITFs SHALL NOT support this combination
readonly Integer showType
Flag indicating the type of show. This field SHALL take one of the following values:
The show is live.
The show is a first-run show.
The show is a rerun.
readonly Boolean subtitles
Flag indicating whether subtitles or closed-caption information is available.
readonly StringCollection subtitleLanguages
Supported subtitle languages, indicated by their ISO 639-2 language codes as defined in [ISO 639-2].
readonly Boolean isHD
Flag indicating whether the programme has high-definition video.
readonly Boolean is3D
Flag indicating whether the programme has 3D video.
readonly Integer audioType
Bitfield indicating the type of audio that is available for the programme. Since more than one type of audio may be available for a given programme, the value of this field SHALL consist of one or more of the following values ORed together:
readonly Boolean isMultilingual
Flag indicating whether more than one audio language is available for this recording.
readonly StringCollection audioLanguages
Supported audio languages, indicated by their ISO 639-2 language codes as defined in [ISO 639-2].
readonly StringCollection genres
A collection of genres that describe this programme.
readonly Integer recordingStartTime
The actual start time of the recording, including any padding, measured in seconds since midnight (GMT) on 1/1/1970. This MAY not be the same as the scheduled start time of the recorded programme (e.g. due to a recording starting late, or due to start/end padding). For recordings that have not yet started, the value of this field SHALL be undefined.
readonly Integer recordingDuration
The actual duration of the recording, including any padding, measured in seconds. This MAY not be the same as the scheduled duration of the recording (e.g. due to a recording finishing early, or due to start/end padding). For recordings that have not yet started, the value of this field SHALL be undefined.
readonly BookmarkCollection bookmarks
A collection of the bookmarks set in a recording. If no bookmarks are set, the collection SHALL be empty.
readonly Boolean locked
Flag indicating whether the current state of the parental control system prevents the recording from being viewed (e.g. a correct parental control PIN has not been entered to allow the recording to be viewed).