Difference between revisions of "RecordingSchedule"

From Gvp-public
Jump to navigation Jump to search
(Created page with "{{Api_DataType_Spec |Description=Represents a Schedule object, associated with the managing of recordings in the Network PVR service. |Members= {{{!}} border="2" style="width:8...")
 
 
(40 intermediate revisions by 3 users not shown)
Line 12: Line 12:
 
! ChannelId
 
! ChannelId
 
{{!}} int
 
{{!}} int
−
{{!}} Channel ID
+
{{!}} Channel ID (internal GVP ID)
 +
{{!}}- valign="top"
 +
 
 +
! ChannelNumber
 +
{{!}} int
 +
{{!}} Channel Number in user's channel map. ONLY FOR MEDIAROOM. NOT USED IN OPEN PLATFORM
 +
{{!}}- valign="top"
 +
 
 +
! ChannelReferenceId
 +
{{!}} int
 +
{{!}} Channel ID (as appearing in EPG, GLF File)
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
Line 18: Line 28:
 
{{!}} String
 
{{!}} String
 
{{!}} Channel Name
 
{{!}} Channel Name
 +
{{!}}- valign="top"
 +
 +
! Conflicted
 +
{{!}} Boolean
 +
{{!}} Whether the recording schedule has been detected as "conflicted" by the nPVR remote backend. NOT USED IN OPEN PLATFORM
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
 
! EndTime
 
! EndTime
 
{{!}} long int
 
{{!}} long int
−
{{!}} Schedule ending time
+
{{!}} Schedule ending time. Tentative, this is the property of the Schedule to be recorded
 +
{{!}}- valign="top"
 +
 
 +
! Id
 +
{{!}} string
 +
{{!}} RecordingSchedule unique ID
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
−
! ID
+
! LastModified
 
{{!}} int
 
{{!}} int
−
{{!}} Schedule unique ID
+
{{!}} Date-time of last modification of the recording schedule. NOT USED IN OPEN PLATFORM
 +
{{!}}- valign="top"
 +
 
 +
! ParentId
 +
{{!}} string
 +
{{!}} Id of the "parent recording" (or recording definition/schedule). The value may be equal to ID in some cases.(ParentRecording always, and some cases of child recording). THIS MUST BE USED FOR CANCELATIONS.
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
 
! ProgramId
 
! ProgramId
 
{{!}} int
 
{{!}} int
−
{{!}} ID of program associated to schedule
+
{{!}} ID of program associated to schedule (internal GVP ID). IN OPEN PLATFORM IS THE ONLY WAY TO MATCH A EPG EVENT WITH A RECORDING
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
Line 38: Line 63:
 
{{!}} String
 
{{!}} String
 
{{!}} Program Name
 
{{!}} Program Name
 +
{{!}}- valign="top"
 +
 +
! ProgramReferenceId
 +
{{!}} int
 +
{{!}} Program ID as appearing in EPG
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
 
! RecordingDuration
 
! RecordingDuration
 
{{!}} long int
 
{{!}} long int
−
{{!}} Duration of the recording
+
{{!}} Duration of the actual recording object
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
Line 48: Line 78:
 
{{!}} long int
 
{{!}} long int
 
{{!}} Recording end time (may not coincide with schedule ending time)
 
{{!}} Recording end time (may not coincide with schedule ending time)
 +
{{!}}- valign="top"
 +
 +
! RecordingHierarchy
 +
{{!}} [[RecordingHierarchyType|RecordingHierarchyType]] enum
 +
{{!}} Indicates whether the object is a "parent" recording (recording definition) (value 0) or a "child" recording (value 1)
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
Line 62: Line 97:
 
! ScheduleId
 
! ScheduleId
 
{{!}} int
 
{{!}} int
−
{{!}} Schedule unique ID
+
{{!}} Schedule unique ID. ScheduleId=0 in OP because this parameter doesn't exist in VRM. CANT BE USED TO MATCH IN THE EPG IN OPEN PLATFORM
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
Line 73: Line 108:
 
{{!}} long int
 
{{!}} long int
 
{{!}} Schedule starting time
 
{{!}} Schedule starting time
 +
{{!}}- valign="top"
 +
 +
! Type
 +
{{!}} [[RecordingScheduleType|RecordingScheduleType]] enum
 +
{{!}} Recording type (entire series or individual episodes)
 +
{{!}}- valign="top"
 +
 +
! SeasonNumber
 +
{{!}} int
 +
{{!}} bgcolor="green" {{!}} '''NEW in 7.1''' Season Number as it appears in the EPG File
 +
{{!}}- valign="top"
 +
 +
! DeleteTime
 +
{{!}} UnixTimestamp
 +
{{!}} bgcolor="green" {{!}} '''NEW in 7.1''' Time when the recording will be erased (if it is != 0)
 +
{{!}}- valign="top"
 +
 +
! ChannelLogoUrl
 +
{{!}} String
 +
{{!}} bgcolor="green" {{!}} '''NEW in 7.1''' ImageUrl of the associated Live Channel Logo  (Must be requested through spotlight)
 +
{{!}}- valign="top"
 +
 +
! Description
 +
{{!}} String
 +
{{!}} bgcolor="green" {{!}} '''NEW in 7.1''' Description of the Program
 +
{{!}}- valign="top"
 +
 +
! AgeRating
 +
{{!}} String
 +
{{!}} bgcolor="green" {{!}} '''NEW in 7.1''' Age Rating of the Program (CODE in contentapi)
 +
{{!}}- valign="top"
 +
 +
! IsProtected
 +
{{!}} Boolean
 +
{{!}} bgcolor="green" {{!}} '''NEW in 7.1''' Indicates if the Recording is protected for deletion
 +
{{!}}- valign="top"
 +
 +
! ImageUrl
 +
{{!}} String
 +
{{!}} bgcolor="green" {{!}} '''NEW in 7.1''' ImageUrl of the Recording (Must be requested through spotlight)
 +
{{!}}- valign="top"
 +
 +
! Genres
 +
{{!}} String
 +
{{!}} bgcolor="green" {{!}} '''NEW in 7.1''' Genres of the recordings, as they comes in the EPG
 +
{{!}}- valign="top"
 +
 +
! UXReference
 +
{{!}} String
 +
{{!}} bgcolor="green" {{!}} '''NEW in 7.1''' UXReference of the recommendation that returned the schedule to be recorded
 +
{{!}}- valign="top"
 +
 +
! TrackId
 +
{{!}} String
 +
{{!}} bgcolor="green" {{!}} '''NEW in 7.1''' TrackId returned by CW of the schedule recorded
 +
{{!}}- valign="top"
 +
 +
! EpisodeNumber
 +
{{!}} Integer
 +
{{!}} bgcolor="green" {{!}} '''NEW in 7.1''' Episode number, as it comes in the EPG
 +
{{!}}- valign="top"
 +
 +
! SeriesName
 +
{{!}} String
 +
{{!}} bgcolor="green" {{!}} '''NEW in 7.1''' Series name, as it comes in the EPG
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
Line 80: Line 180:
 
|Example=
 
|Example=
 
{
 
{
−
:           "ID": 312312,
+
:               "Id" : "525cf038-4890-49e2-8a9c-fc1e89296a00",
−
:           "ChannelId": 235,
+
:               "ParentId" : "db80e616-80e0-48ee-818e-a7e96096672d",
−
:           "ChannelName": "La1",
+
:                "ScheduleId" : 4089207,
−
:           "ScheduleId": 5221344,
+
:                "ProgramId" : 4419758,
−
:           "ProgramId": 141230462,
+
:                "ProgramName" : "Technical Difficulties (Image Sample)",
−
:           "ProgramName": "Telediario-1",
+
:                "ProgramReferenceId" : "99343001",
−
:           "StartTime": 1341898121,
+
:                "ChannelId" : 5044,
−
:           "EndTime": 1341894239,
+
:               "ChannelName" : "KTDS",
−
:           "RecordingDuration": 900,
+
:               "ChannelNumber" : 1459,
−
:           "RecordingStartTime": 1341898121,
+
:               "ChannelReferenceId" : "99343001",
−
:           "RecordingEndTime": 1341891547,
+
:               "SeriesId" : 0,
−
:           "RecordingState": 1,
+
:                "StartTime" : 1418169600,
−
:           "SeriesId": 0,
+
:               "EndTime" : 1418171400,
 +
:               "RecordingHierarchy" : 1,
 +
:               "RecordingState" : 0,
 +
:               "RecordingStartTime" : 1418162400,
 +
:               "RecordingEndTime" : 1418164200,
 +
:               "RecordingDuration" : 1800,
 +
:                "Type" : 1,
 +
:               "LastModified" : 0,
 +
:                "Conflicted" : false,
 +
:                "SeasonNumber" : 0,
 +
:                "DeleteTime" : 0,
 +
:                "ChannelLogoUrl" : "",
 +
:                "Description" : "Program Description",
 +
:                "AgeRating" : "18+",
 +
:                "IsProtected" : false,
 +
:                "ImageUrl" : "",
 +
:                "Genres" : "",
 +
:                "UXReference" : "",
 +
:                "TrackId" : "",
 +
:                "EpisodeNumber" : "2",
 +
:                "SeriesName" : "The Big Bang Theory"
 +
 
 
}
 
}
 +
  
 
|KnownIssues=
 
|KnownIssues=
Line 108: Line 230:
 
{{!}}  
 
{{!}}  
 
{{!}}- valign="top"
 
{{!}}- valign="top"
−
 
+
! 7.1
 +
{{!}} Changes for OpenPlatform CPVR
 +
{{!}} José Manuel Escartín
 +
{{!}}- valign="top"
 
{{!}}}
 
{{!}}}
  

Latest revision as of 10:10, 12 July 2019

Represents a Schedule object, associated with the managing of recordings in the Network PVR service.

Members

Field Data Type Description
ChannelId int Channel ID (internal GVP ID)
ChannelNumber int Channel Number in user's channel map. ONLY FOR MEDIAROOM. NOT USED IN OPEN PLATFORM
ChannelReferenceId int Channel ID (as appearing in EPG, GLF File)
ChannelName String Channel Name
Conflicted Boolean Whether the recording schedule has been detected as "conflicted" by the nPVR remote backend. NOT USED IN OPEN PLATFORM
EndTime long int Schedule ending time. Tentative, this is the property of the Schedule to be recorded
Id string RecordingSchedule unique ID
LastModified int Date-time of last modification of the recording schedule. NOT USED IN OPEN PLATFORM
ParentId string Id of the "parent recording" (or recording definition/schedule). The value may be equal to ID in some cases.(ParentRecording always, and some cases of child recording). THIS MUST BE USED FOR CANCELATIONS.
ProgramId int ID of program associated to schedule (internal GVP ID). IN OPEN PLATFORM IS THE ONLY WAY TO MATCH A EPG EVENT WITH A RECORDING
ProgramName String Program Name
ProgramReferenceId int Program ID as appearing in EPG
RecordingDuration long int Duration of the actual recording object
RecordingEndTime long int Recording end time (may not coincide with schedule ending time)
RecordingHierarchy RecordingHierarchyType enum Indicates whether the object is a "parent" recording (recording definition) (value 0) or a "child" recording (value 1)
RecordingStartTime long int Recording start time (may not coincide with schedule starting time)
RecordingState RecordingScheduleState enum Status of recording
ScheduleId int Schedule unique ID. ScheduleId=0 in OP because this parameter doesn't exist in VRM. CANT BE USED TO MATCH IN THE EPG IN OPEN PLATFORM
SeriesId int Series ID (in case of schedule part of a series)
StartTime long int Schedule starting time
Type RecordingScheduleType enum Recording type (entire series or individual episodes)
SeasonNumber int NEW in 7.1 Season Number as it appears in the EPG File
DeleteTime UnixTimestamp NEW in 7.1 Time when the recording will be erased (if it is != 0)
ChannelLogoUrl String NEW in 7.1 ImageUrl of the associated Live Channel Logo (Must be requested through spotlight)
Description String NEW in 7.1 Description of the Program
AgeRating String NEW in 7.1 Age Rating of the Program (CODE in contentapi)
IsProtected Boolean NEW in 7.1 Indicates if the Recording is protected for deletion
ImageUrl String NEW in 7.1 ImageUrl of the Recording (Must be requested through spotlight)
Genres String NEW in 7.1 Genres of the recordings, as they comes in the EPG
UXReference String NEW in 7.1 UXReference of the recommendation that returned the schedule to be recorded
TrackId String NEW in 7.1 TrackId returned by CW of the schedule recorded
EpisodeNumber Integer NEW in 7.1 Episode number, as it comes in the EPG
SeriesName String NEW in 7.1 Series name, as it comes in the EPG


Example

{

"Id" : "525cf038-4890-49e2-8a9c-fc1e89296a00",
"ParentId" : "db80e616-80e0-48ee-818e-a7e96096672d",
"ScheduleId" : 4089207,
"ProgramId" : 4419758,
"ProgramName" : "Technical Difficulties (Image Sample)",
"ProgramReferenceId" : "99343001",
"ChannelId" : 5044,
"ChannelName" : "KTDS",
"ChannelNumber" : 1459,
"ChannelReferenceId" : "99343001",
"SeriesId" : 0,
"StartTime" : 1418169600,
"EndTime" : 1418171400,
"RecordingHierarchy" : 1,
"RecordingState" : 0,
"RecordingStartTime" : 1418162400,
"RecordingEndTime" : 1418164200,
"RecordingDuration" : 1800,
"Type" : 1,
"LastModified" : 0,
"Conflicted" : false,
"SeasonNumber" : 0,
"DeleteTime" : 0,
"ChannelLogoUrl" : "",
"Description" : "Program Description",
"AgeRating" : "18+",
"IsProtected" : false,
"ImageUrl" : "",
"Genres" : "",
"UXReference" : "",
"TrackId" : "",
"EpisodeNumber" : "2",
"SeriesName" : "The Big Bang Theory"

}


Known issues

None


Version history

API Version Number Change description Changes author
2.4 Initial data type implementation
7.1 Changes for OpenPlatform CPVR José Manuel Escartín


See also

Retrieved from "https://wikis.tid.es/gvp-public/index.php?title=RecordingSchedule&oldid=3100"