Difference between revisions of "QUERY RECORDINGS (Myth Protocol)"

From MythTV Official Wiki
Jump to: navigation, search
(Update for changes in 0.24 and pre-0.25 development)
 
(10 intermediate revisions by 4 users not shown)
Line 2: Line 2:
  
 
=== Arguments ===
 
=== Arguments ===
−
'''Command arguments''': <type>
+
'''Command arguments''': <string:type>
  
 
'''List arguments''': none
 
'''List arguments''': none
 +
 +
'''Response''': SEQ <num> OF <[[ProgramInfo (Myth Protocol)|ProgramInfo]]>
  
 
=== Examples ===
 
=== Examples ===
 
Command:
 
Command:
−
<pre>21      QUERY_RECORDINGS Play</pre>
+
21      QUERY_RECORDINGS Ascending
 
Response:
 
Response:
−
<pre>18988  26[]:[]$40-a-day[]:[]Cape Cod[]:[]...</pre>
+
18988  26[]:[]$40-a-day[]:[]Cape Cod[]:[]...
  
 
=== Description ===
 
=== Description ===
−
Queries a list of recordings in the system
+
Queries a list of recordings in the system.  Query type is case-sensitive.
−
Valid types are:<br>
+
 
−
- Recording: Currently being recorded<br>
+
Valid types are (protocol versions 65+):
−
- Delete: Returns the items in descending order based on start time<br>
+
*Recording: Returns in-progress recordings, unsorted
−
- Play (or anything else): Returns all items
+
*Descending (or Delete, deprecated): Returns all recordings in descending order, based on start time
 +
*Ascending (or Play, deprecated): Returns all recordings in ascending order, based on start time
 +
*Unsorted (or anything else): Returns all recordings, unsorted
 +
 
 +
 
 +
For protocol versions 57 - 64, valid types are:
 +
*Recording: Returns in-progress recordings, unsorted
 +
*Play (or anything else): Returns all recordings, unsorted
 +
 
 +
 
 +
For protocol versions 1 - 56, valid types are:
 +
*Recording: Returns in-progress recordings in ascending order, based on start time
 +
*Delete: Returns all recordings in descending order, based on start time
 +
*Play (or anything else): Returns all recordings in ascending order, based on start time
  
 
=== Returns ===
 
=== Returns ===
−
The first int in the list is the number of recordings.  After this, there is a list of ProgramInfo's. Each ProgramInfo is 41 fields (version 26) with the following fields:
+
The first int in the list is the number of recordings.  After this, there follows a ProgramInfo for each recording.
−
    // data
+
 
−
    QString title;
+
=== Changelog ===
−
    QString subtitle;
+
{| border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border-color:#8eabd0; background:#e7edf5"
−
    QString description;
+
|- style="background: lightsteelblue"
−
    QString category;
+
|+
−
    QString chanid;
+
! version !! changeset !! description
−
    QString chanstr;
+
|-
−
    QString chansign;
+
| 1 || {{changeset|3021}}
−
    QString channame;
+
| Initial version
−
    QString pathname;
+
|-
−
    long long filesize;
+
|}
−
    QDateTime startts;
+
 
−
    QDateTime endts;
+
[[Category:Myth Protocol Commands]]
−
    //empty field
 
−
    bool shareable;
 
−
    int findid;
 
−
    QString hostname;
 
−
    int sourceid;
 
−
    int inputid;
 
−
    int cardid;
 
−
    int recpriority;
 
−
    RecStatusType recstatus;
 
−
    int recordid;
 
−
    RecordingType rectype;
 
−
    RecordingDupInType dupin;
 
−
    RecordingDupMethodType dupmethod;
 
−
    QDateTime recstartts;
 
−
    QDateTime recendts;
 
−
    bool repeat;
 
−
    int programflags;
 
−
    QString recgroup;
 
−
    int chancommfree;
 
−
    QString chanOutputFilters;
 
−
    QString seriesid;
 
−
    QString programid;
 
−
    QDateTime lastmodified;
 
−
    float stars;
 
−
    QDate originalAirDate;
 
−
    bool hasAirDate;
 
−
    QString playgroup;
 
−
    int recpriority2;
 

Latest revision as of 18:29, 8 March 2011

QUERY_RECORDINGS

Arguments

Command arguments: <string:type>

List arguments: none

Response: SEQ <num> OF <ProgramInfo>

Examples

Command: 

21      QUERY_RECORDINGS Ascending

Response: 

18988   26[]:[]$40-a-day[]:[]Cape Cod[]:[]...

Description

Queries a list of recordings in the system. Query type is case-sensitive.

Valid types are (protocol versions 65+):

  • Recording: Returns in-progress recordings, unsorted
  • Descending (or Delete, deprecated): Returns all recordings in descending order, based on start time
  • Ascending (or Play, deprecated): Returns all recordings in ascending order, based on start time
  • Unsorted (or anything else): Returns all recordings, unsorted


For protocol versions 57 - 64, valid types are:

  • Recording: Returns in-progress recordings, unsorted
  • Play (or anything else): Returns all recordings, unsorted


For protocol versions 1 - 56, valid types are:

  • Recording: Returns in-progress recordings in ascending order, based on start time
  • Delete: Returns all recordings in descending order, based on start time
  • Play (or anything else): Returns all recordings in ascending order, based on start time

Returns

The first int in the list is the number of recordings. After this, there follows a ProgramInfo for each recording.

Changelog

version changeset description
1 [3021] Initial version
Retrieved from "http://www.mythtv.org/wiki?title=QUERY_RECORDINGS_(Myth_Protocol)&oldid=51450"