Difference between revisions of "GET RECORDER NUM (Myth Protocol)"

From MythTV Official Wiki
Jump to: navigation, search
m (clarified description)
 
(4 intermediate revisions by 2 users not shown)
Line 4: Line 4:
 
'''Command arguments''': none
 
'''Command arguments''': none
  
'''List arguments''': ProgramInfo
+
'''List arguments''': <[[ProgramInfo (Myth Protocol)|ProgramInfo]]>
  
 
=== Examples ===
 
=== Examples ===
Line 15: Line 15:
  
 
=== Description ===
 
=== Description ===
Asks the backend for a recorder that matches the program info passed in. The host address and port returned may not be on the originally queried host, if slave backends are used. If the recorder is not valid, -1 will be returned for the port and the host will be "nohost".  Note that this does not check to see of the recorder is busy or locked.
+
Asks the backend for the recorder that is actively recording the program info passed in. The host address and port returned may not be on the originally queried host, if slave backends are used. If the recorder is not valid, -1 will be returned for the port and the host will be "nohost".  Note that this does not check to see of the recorder is busy or locked.
  
 
The ProgramInfo is a combination of a large collection of attributes.  These can be seen in /libs/libmythtv/programinfo.cpp in the function ProgramInfo::FromStringList
 
The ProgramInfo is a combination of a large collection of attributes.  These can be seen in /libs/libmythtv/programinfo.cpp in the function ProgramInfo::FromStringList
Line 21: Line 21:
 
=== Returns ===
 
=== Returns ===
 
The recorder id, the host address of the backend to connect to, and the port of the backend to connect to
 
The recorder id, the host address of the backend to connect to, and the port of the backend to connect to
 +
 +
=== Changelog ===
 +
{| border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border-color:#8eabd0; background:#e7edf5"
 +
|- style="background: lightsteelblue"
 +
|+
 +
! version !! changeset !! description
 +
|-
 +
| 1 || {{changeset|3021}}
 +
| Initial version
 +
|-
 +
|}
 +
 +
[[Category:Myth Protocol Commands]]

Latest revision as of 04:00, 4 March 2011

GET_RECORDER_NUM

Arguments

Command arguments: none

List arguments: <ProgramInfo>

Examples

Command:

GET_RECORDER_NUM[]:[] ??? 

Successful response:

2[]:[]192.168.1.110[]:[]6543

Unsuccessful response:

-1[]:[]nohost[]:[]-1

Description

Asks the backend for the recorder that is actively recording the program info passed in. The host address and port returned may not be on the originally queried host, if slave backends are used. If the recorder is not valid, -1 will be returned for the port and the host will be "nohost". Note that this does not check to see of the recorder is busy or locked.

The ProgramInfo is a combination of a large collection of attributes. These can be seen in /libs/libmythtv/programinfo.cpp in the function ProgramInfo::FromStringList

Returns

The recorder id, the host address of the backend to connect to, and the port of the backend to connect to

Changelog

version changeset description
1 [3021] Initial version