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

From MythTV Official Wiki
Jump to: navigation, search
(added additional fields)
(Reference ProgramInfo data page)
Line 2: Line 2:
  
 
=== Arguments ===
 
=== Arguments ===
'''Command arguments''': <type>
+
'''Command arguments''': <string:type>
  
 
'''List arguments''': none
 
'''List arguments''': none
 +
 +
'''Response''': SEQ <num> OF <[[Myth_Protocol_Data_ProgramInfo|ProgramInfo]]>
  
 
=== Examples ===
 
=== Examples ===
Line 21: Line 23:
  
 
=== 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 47 fields (version 40) 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;
 
    QString                  subtitle;
 
    QString                  description;
 
    QString                  category;
 
    QString                  chanid;
 
    QString                  chanstr;
 
    QString                  chansign;
 
    QString                  channame;
 
    QString                  pathname;
 
    int                      filesize; (top 32-bits)
 
    int                      filesize; (bottom 32-bits)
 
    QDateTime                startts;
 
    QDateTime                endts;
 
    bool                    duplicate;
 
    bool                    shareable;
 
    int                      findid;
 
    QString                  hostname;
 
    int                      sourceid;
 
    int                      cardid;
 
    int                      inputid;
 
    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;
 
    QString                  storagegroup;
 
    QString                  audio_props;
 
    QString                  video_props;
 
    QString                  subtitle_type;
 
    QString                  year;
 

Revision as of 14:55, 16 December 2009

QUERY_RECORDINGS

Arguments

Command arguments: <string:type>

List arguments: none

Response: SEQ <num> OF <ProgramInfo>

Examples

Command:

21      QUERY_RECORDINGS Play

Response:

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

Description

Queries a list of recordings in the system

Valid types are:

  • Recording: Currently being recorded
  • Delete: Returns the items in descending order based on start time
  • Play (or anything else): Returns all items

Returns

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