This pages is designed to show the use and output of most of the API functions.
Some functions requiring specific input like changing channels or commencing playback are not represented in this test.
The complete syntax is as follows:
"<PVR IP>:8000/api?function=fff&action=aaa[&module=mmm&session=sss]!param1=data1¶m2=data2&etc&etc&"
where:
fff | Function name |
aaa | Action name |
mmm | Not yet implemented - Optional module name (in integration with other TAPs) |
sss | Not yet implemented - Session ID (for future security) |
"!" | separates the command from the parameters. |
Parameters are separated by "&" characters with a trailing "&". |
Object | Value |
content | Value |
sysid | Value |
device | Value |
apptype | Value |
remotetype | Value |
maxrecstreams | Value |
version | Value |
recextension | Value |
language_code | Value |
utftoppy | Value |
tma1ver | Value |
blockfactor | Value |
autoppy | Value |
utcoffset | Value |
dst | Value |
pre_padding | Value |
post_padding | Value |
hddmodel | Value |
hddserial | Value |
hddfirmware | Value |
pvrname | Value |
logginglevel | Value |
module_count | Value |
timestamp | Value |
There is a fixed portion for overall status and playback status.
There is an array portion for each recording slot that the PVR supports. These properties are a sub-property of the "recording" property.
There is an array portion for each external drive attached. These properties are a sub-property of the "drives" property.
There is a fixed portion with the current channel and channel count.
There is an array portion for each channel. These properties are a sub-property of the "channels" property.
There is a fixed portion with the timer count.
There is an array portion for each timer. These properties are a sub-property of the "timers" property.
There is a fixed portion with the directory name and file count.
There is an array portion for each file. These properties are a sub-property of the "files" property.
TO DO - Add INF+ status to the standard files response.
TO DO - Function to delete and move recordings.
This set of functions allows JavaScript to save settings to the PVR and retrieve them later.
Settings are stored on the PVR in "/ProgramFiles/Settings/TMA1/TMA1-Client.ini."
All settings are stored as strings. They must be converted back to numbers if required.
A request for a key that does not exist will return a null string.
There is a fixed portion with the setting count.
There is an array portion with the actual settings. These properties are a sub-property of the "setting" property.
There is fixed portion that contains some general information and an array portion called "groups".
There is another fixed portion within each groups, and then an array called "services" containing a list of the services in that group.
There is a fixed portion with the directory count.
There is an array portion with the actual directories. These properties are a sub-property of the "directory" property.
There is a fixed portion with the logo count.
There is an array portion with the actual channel IDs and logo coordinates. These properties are a sub-property of the "logos" property.
There is a fixed portion with the EPG event count.
There is an array portion with the actual EPG data. These properties are a sub-property of the "event" property.
Show events for the next 4 hours on the first TV service.
There is a fixed portion with the TAP count.
There is an array portion with the actual TAP data. These properties are a sub-property of the "tap" property.