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)
 
Line 10: Line 10:
 
=== Examples ===
 
=== Examples ===
 
Command:
 
Command:
  21      QUERY_RECORDINGS Play
+
  21      QUERY_RECORDINGS Ascending
 
Response:
 
Response:
 
  18988  26[]:[]$40-a-day[]:[]Cape Cod[]:[]...
 
  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:
+
Valid types are (protocol versions 65+):
*Recording: Currently being recorded
+
*Recording: Returns in-progress recordings, unsorted
*Delete: Returns the items in descending order based on start time
+
*Descending (or Delete, deprecated): Returns all recordings in descending order, based on start time
*Play (or anything else): Returns all items
+
*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 ===

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