Difference between revisions of "ProgramInfo (Myth Protocol)"

From MythTV Official Wiki
Jump to: navigation, search
m (formatted into table)
 
(6 intermediate revisions by one other user not shown)
Line 1: Line 1:
−
The ProgramInfo structure is a frequently used block of data sent in [[Myth Protocol]] [[Myth Protocol/Commands|Commands]].  It consists of the following 47 fields, separated by a '[]:[]'.
+
The ProgramInfo structure is a frequently used block of data in [[:Category:Myth Protocol|Myth Protocol]] sent by [[:Category:Myth Protocol Commands|Myth Protocol Commands]].  It consists of the following 44 fields, separated by a '[]:[]'.
  
−
{| border=1 cellspacing=0 cellpadding=5
+
{| border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border-color:#8eabd0; background:#e7edf5"
−
|Name
+
|- style="background: lightsteelblue"
−
|Format
+
|+
−
|Description
+
! Name !! Format !! Description
 
|-
 
|-
−
|title
+
|title       || string ||
−
|string
 
−
|
 
 
|-
 
|-
−
|subtitle
+
|subtitle     || string ||
−
|string
 
−
|
 
 
|-
 
|-
−
|description
+
|description || string ||
−
|string
 
−
|
 
 
|-
 
|-
−
|category
+
|season      || integer ||
−
|string
 
−
|
 
 
|-
 
|-
−
|chanid
+
|episode      || integer ||
−
|integer
+
|-
 +
|category    || string ||
 +
|-
 +
|chanid       || integer
 
|internal channel ID
 
|internal channel ID
 
|-
 
|-
−
|channum
+
|channum     || string
−
|string
 
 
|user defined channel number (likely to contain '-', '_', or '.')
 
|user defined channel number (likely to contain '-', '_', or '.')
 
|-
 
|-
−
|callsign
+
|callsign     || string
−
|string
 
 
|station abbreviation
 
|station abbreviation
 
|-
 
|-
−
|channame
+
|channame     || string
−
|string
 
 
|full station name
 
|full station name
 
|-
 
|-
−
|filename
+
|filename     || string
−
|string
+
|full myth URI (myth://[Default]@hostname:6543/file.mpg) or basename (file.mpg)
−
|full myth URI (myth://[Default]@hostname:6543/file.mpg)
 
 
|-
 
|-
−
|fs_high
+
|filesize    || long integer ||
−
|integer
 
−
|top 32-bits of file size
 
 
|-
 
|-
−
|fs_low
+
|starttime    || datetime
−
|integer
 
−
|bottom 32-bits of file size
 
−
|-
 
−
|starttime
 
−
|datetime
 
 
|scheduled start of program
 
|scheduled start of program
 
|-
 
|-
−
|endtime
+
|endtime     || datetime
−
|datetime
 
 
|scheduled end of program
 
|scheduled end of program
 
|-
 
|-
−
|duplicate
+
|findid      || integer ||
−
|boolean
 
−
|
 
−
|-
 
−
|shareable
 
−
|boolean
 
−
|
 
−
|-
 
−
|findid
 
−
|integer
 
−
|
 
 
|-
 
|-
−
|hostname
+
|hostname     || string ||
−
|string
 
−
|
 
 
|-
 
|-
−
|sourceid
+
|sourceid     || integer
−
|integer
 
 
|source ID (usually first digit of chanid)
 
|source ID (usually first digit of chanid)
 
|-
 
|-
−
|cardid
+
|cardid       || integer
−
|integer
 
 
|ID of physical capture card
 
|ID of physical capture card
 
|-
 
|-
−
|inputid
+
|inputid     || integer
−
|integer
 
 
|ID of specific input
 
|ID of specific input
 
|-
 
|-
−
|recpriority
+
|recpriority || integer
−
|integer
 
 
|recording priority (-20 to 20)
 
|recording priority (-20 to 20)
 
|-
 
|-
−
|recstatus
+
|recstatus   || integer ||
−
|integer
 
−
|
 
 
|-
 
|-
−
|recordid
+
|recordid     || integer ||
−
|integer
 
−
|
 
 
|-
 
|-
−
|rectype
+
|rectype     || integer ||
−
|integer
 
−
|
 
 
|-
 
|-
−
|dupin
+
|dupin       || integer ||
−
|integer
 
−
|
 
 
|-
 
|-
−
|dupmethod
+
|dupmethod   || integer ||
−
|integer
 
−
|
 
 
|-
 
|-
−
|recstartts
+
|recstartts   || datetime
−
|datetime
 
 
|beginning of actual recording
 
|beginning of actual recording
 
|-
 
|-
−
|recendts
+
|recendts     || datetime
−
|datetime
 
 
|end of actual recording
 
|end of actual recording
 
|-
 
|-
−
|repeat
+
|programflags || integer ||state flags for the recording like watched, auto expires, delete pending, currently playing (see http://code.mythtv.org/doxygen/programtypes_8h_source.html#l00121)
−
|boolean
 
−
|
 
 
|-
 
|-
−
|programflags
+
|recgroup    || string ||
−
|integer
 
−
|
 
 
|-
 
|-
−
|recgroup
+
|outputfilters|| string ||
−
|string
 
−
|
 
 
|-
 
|-
−
|commfree
+
|seriesid    || string ||
−
|integer
 
−
|
 
 
|-
 
|-
−
|outputfilters
+
|programid    || string ||
−
|string
 
−
|
 
 
|-
 
|-
−
|seriesid
+
|inetref      || string
−
|string
+
|identification string to use with metadata grabbers
−
|
 
 
|-
 
|-
−
|programid
+
|lastmodified || datetime ||
−
|string
 
−
|
 
 
|-
 
|-
−
|lastmodified
+
|stars        || float ||
−
|datetime
 
−
|
 
 
|-
 
|-
−
|stars
+
|airdate      || date ||
−
|float
 
−
|
 
 
|-
 
|-
−
|airdate
+
|playgroup    || string ||
−
|date
 
−
|
 
 
|-
 
|-
−
|hasairdate
+
|recpriority2 || integer ||
−
|boolean
 
−
|
 
 
|-
 
|-
−
|playgroup
+
|parentid    || integer ||
−
|string
 
−
|
 
 
|-
 
|-
−
|recpriority2
+
|storagegroup || string ||
−
|integer
 
−
|
 
 
|-
 
|-
−
|parentid
+
|audio_props  || integer ||
−
|integer
 
−
|
 
 
|-
 
|-
−
|storagegroup
+
|video_props  || integer ||
−
|string
 
−
|
 
 
|-
 
|-
−
|audio_props
+
|subtitle_type|| integer ||
−
|integer
 
−
|
 
 
|-
 
|-
−
|video_props
+
|year        || int ||
−
|integer
+
|}
−
|
+
 
 +
=== Changelog ===
 +
{| border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border-color:#8eabd0; background:#e7edf5"
 +
|- style="background: lightsteelblue"
 +
|+
 +
! version !! changeset !! field count !! description
 
|-
 
|-
−
|subtitle_type
+
| 12 || {{changeset|3988}} || 38
−
|integer
+
| add 'stars' and 'originalairdate'
−
|
+
|-
 +
| 14 || {{changeset|4508}} || 39
 +
| timestamps are now in UTC
 +
|-
 +
| 15 || {{changeset|5833}} || 39
 +
| add 'hasairdate'
 +
|-
 +
| 18 || {{changeset|6865}} || 40
 +
| add 'timestretch'
 +
|-
 +
| 25 || {{changeset|8628}} || 41
 +
| add 'recpriority2'
 +
|-
 +
| 31 || {{changeset|11278}} || 42
 +
| add 'parentid'
 +
|-
 +
| 32 || {{changeset|12151}} || 43
 +
| add 'storagegroup'
 +
|-
 +
| 35 || {{changeset|13952}} || 46
 +
| add 'audioproperties', 'videoproperties', and 'subtitletype'
 +
|-
 +
| 41 || {{changeset|18419}} || 47
 +
| add 'year'
 +
|-
 +
| 57 || {{changeset|24694}} || 41
 +
| merge 'fs_high' and 'fs_low' to 'filesize'
 +
remove 'duplicate', 'shareable', 'previouslyshown', 'commfree', 'hasairdate'
 +
|-
 +
| 67 || {{gitcommit|a41e9657c0|mythtv|v0.25pre-2563-ga41e965}} || 44
 +
| add 'season', 'episode', and 'inetref'
 
|-
 
|-
−
|year
 
−
|int
 
−
|
 
 
|}
 
|}
  
−
 
+
[[Category:Myth Protocol]]
−
Protocol version documented: 50
 
−
 
 
−
Long integer values are separated into two 32-bit ints, which can be reconstructed with the simple line...
 
−
<code>
 
−
(high + (low<0)) x 2^32 + low
 
−
</code>
 

Latest revision as of 18:56, 29 May 2012

The ProgramInfo structure is a frequently used block of data in Myth Protocol sent by Myth Protocol Commands. It consists of the following 44 fields, separated by a '[]:[]'.

Name Format Description
title string
subtitle string
description string
season integer
episode integer
category string
chanid integer internal channel ID
channum string user defined channel number (likely to contain '-', '_', or '.')
callsign string station abbreviation
channame string full station name
filename string full myth URI (myth://[Default]@hostname:6543/file.mpg) or basename (file.mpg)
filesize long integer
starttime datetime scheduled start of program
endtime datetime scheduled end of program
findid integer
hostname string
sourceid integer source ID (usually first digit of chanid)
cardid integer ID of physical capture card
inputid integer ID of specific input
recpriority integer recording priority (-20 to 20)
recstatus integer
recordid integer
rectype integer
dupin integer
dupmethod integer
recstartts datetime beginning of actual recording
recendts datetime end of actual recording
programflags integer state flags for the recording like watched, auto expires, delete pending, currently playing (see http://code.mythtv.org/doxygen/programtypes_8h_source.html#l00121)
recgroup string
outputfilters string
seriesid string
programid string
inetref string identification string to use with metadata grabbers
lastmodified datetime
stars float
airdate date
playgroup string
recpriority2 integer
parentid integer
storagegroup string
audio_props integer
video_props integer
subtitle_type integer
year int

Changelog

version changeset field count description
12 [3988] 38 add 'stars' and 'originalairdate'
14 [4508] 39 timestamps are now in UTC
15 [5833] 39 add 'hasairdate'
18 [6865] 40 add 'timestretch'
25 [8628] 41 add 'recpriority2'
31 [11278] 42 add 'parentid'
32 [12151] 43 add 'storagegroup'
35 [13952] 46 add 'audioproperties', 'videoproperties', and 'subtitletype'
41 [18419] 47 add 'year'
57 [24694] 41 merge 'fs_high' and 'fs_low' to 'filesize'

remove 'duplicate', 'shareable', 'previouslyshown', 'commfree', 'hasairdate'

67 [v0.25pre-2563-ga41e965] 44 add 'season', 'episode', and 'inetref'
Retrieved from "http://www.mythtv.org/wiki?title=ProgramInfo_(Myth_Protocol)&oldid=55206"