[mythtv] Feature Request/RFC: A stable, extensible, third-party usable API

[Raymond Wagner]

  On 9/29/2010 14:29, Robert Johnston wrote:
> For instance, a call to:
>
> http://backend/GetRecordings
>
> Would return:
>
> <xml>
> <RecordingList filterable="Name,Title,Series,Date,Time,Channel,Group">
> <Recording id="1016_201001011905" Start="2010-01-01 19:05 +0000" 
> End="2010-01-01 20:25 +0000">
> <Title>Sample Program</Title>
> <SubTitle>First in a new series, "Sample Program" brings together the 
> best of samples, and programs</SubTitle>
> <HasCommSkip />...
> <Stream>rtsp://backend-that-holds-the-recording/Stream/1016_201001011905</Stream> 
>
> <Download>http://backend-that-holds-the-recording/Download/1016_201001011905</Download> 
>
> </Recording>
> </RecordingList>

A call to:

http://backend:6544/xml/GetRecorded

Will return:

<?xml version="1.0" encoding="utf-8"?>
<GetRecordedResponse>
     <Count>81</Count>
     <AsOf>2010-09-08T01:11:05</AsOf>
     <Version>0.23.20100830-2</Version>
     <ProtoVer>59</ProtoVer>
     <Recorded>
         <Programs>
             <Program title="Warehouse 13" subTitle="Merge With Caution" programFlags="5" category="Comedy-drama" fileSize="3259860928" seriesId="EP01159848" hostname="myth0" catType="" programId="EP011598480022" repeat="0" stars="0" endTime="2010-08-24T22:00:00" airdate="2010-08-24" startTime="2010-08-24T21:00:00" lastModified="2010-08-24T22:00:11">The agents hope to spend a weekend relaxing until an artifact gets in the way.
                 <Channel inputId="0" chanFilters="" commFree="0" channelName="Sci-Fi Channel" sourceId="0" chanId="2061" chanNum="61" callSign="SCIFI"/>
                 <Recording recPriority="0" playGroup="Default" recStatus="-3" recStartTs="2010-08-24T21:00:00" recGroup="Default" dupMethod="6" recType="0" encoderId="0" recProfile="High Quality" recEndTs="2010-08-24T22:00:00" recordId="437" dupInType="15"/>
             </Program>
...
         </Programs>
     </Recorded>
</GetRecordedResponse>


> I realise that some of this could be done using MythWeb, or the 
> Perl/Python bindings to a web page/site (Though I think the streaming 
> of recordings wouldn't be possible like this)

MythWeb can stream content, and both the Perl and Python bindings have 
routines to expose mythproto file transfers as file objects.

> It already has a web server built in, this is merely(!) giving that 
> webserver something to serve other than the status page.

A bit of documentation on what the other Robert already referenced:

http://mythtv.org/wiki/MythXML
http://svn.mythtv.org/trac/browser/trunk/mythtv/contrib/development/MythXMLTest