Difference between revisions of "DVR Service"

From MythTV Official Wiki
Jump to: navigation, search
(Created page with '=Dvr Service API List= <center> {| cellpadding="4" border="1" | align="center" |<b>API Command</b> | align="center" |<b>POST Required?</b> | align="center" |<b>Description…')
 
Line 7: Line 7:
 
| align="center"  |<b>POST Required?</b>  
 
| align="center"  |<b>POST Required?</b>  
 
| align="center"  |<b>Description</b>  
 
| align="center"  |<b>Description</b>  
 +
|-
 +
| [[DVR_Service#GetUpcoming | GetUpcoming]]
 +
| align="center"  | No
 +
| Query information on all upcoming programs matching recording rules.
 
|-  
 
|-  
 
| style="background:silver" | [[DVR_Service#GetExpiring | GetExpiring]]
 
| style="background:silver" | [[DVR_Service#GetExpiring | GetExpiring]]
Line 23: Line 27:
  
 
=Dvr APIs=
 
=Dvr APIs=
 +
 +
==GetUpcoming==
 +
 +
The <span style="color:LimeGreen">GetUpcoming</span> API takes the following arguments:
 +
 +
:<span style="color:SteelBlue">StartIndex</Span> ('''Optional''')
 +
:: '''Parameter Type:''' Integer
 +
:: The numerical starting index in the list of expiring programs.
 +
 +
:<span style="color:SteelBlue">Count</Span> ('''Optional''')
 +
:: '''Parameter Type:''' Integer
 +
:: The number of items to return in the result.
 +
 +
:<span style="color:SteelBlue">ShowAll</Span> ('''Optional''')
 +
:: '''Parameter Type:''' Boolean
 +
:: Show all items which match recording rules, regardless of whether or not they will record (conflicts, previously recorded, etc.).
 +
 +
Example Query:
 +
 +
<code>http://BackendServerIP:6544/Dvr/GetUpcoming?StartIndex=2&Count=1&ShowAll=true</code>
 +
 +
Example Return:
 +
 +
<pre>
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<ProgramList version="1.0" serializerVersion="1.1">
 +
<StartIndex>2</StartIndex>
 +
<Count>1</Count>
 +
<TotalAvailable>15</TotalAvailable>
 +
<AsOf>2011-10-02T16:09:52</AsOf>
 +
<Version>0.25.20110928-1</Version>
 +
<ProtoVer>69</ProtoVer>
 +
<Programs>
 +
    <Program>
 +
        <StartTime>2011-09-12T19:00:00</StartTime>
 +
        <EndTime>2011-09-12T20:01:00</EndTime>
 +
        <Title>Alphas</Title>
 +
        <SubTitle>Blind Spot</SubTitle>
 +
        <Category>Drama</Category>
 +
        <CatType></CatType>
 +
        <Repeat>true</Repeat>
 +
        <SeriesId>EP01410873</SeriesId>
 +
        <ProgramId>EP014108730010</ProgramId>
 +
        <Stars>0</Stars>
 +
        <FileSize>5143875332</FileSize>
 +
        <LastModified>2011-09-12T20:02:18</LastModified>
 +
        <ProgramFlags>13643781</ProgramFlags>
 +
        <Hostname>Holmes</Hostname>
 +
        <Airdate>2011-09-12</Airdate>
 +
        <Inetref>210841</Inetref>
 +
        <Season>1</Season>
 +
        <Episode>9</Episode>
 +
        <Channel>
 +
            <ChanId>34736</ChanId>
 +
            <ChanNum>736</ChanNum>
 +
            <CallSign>SYFYHD</CallSign>
 +
            <IconURL></IconURL>
 +
            <ChannelName>Syfy HD</ChannelName>
 +
            <MplexId>0</MplexId>
 +
            <TransportId>0</TransportId>
 +
            <ServiceId>0</ServiceId>
 +
            <NetworkId>0</NetworkId>
 +
            <ATSCMajorChan>0</ATSCMajorChan>
 +
            <ATSCMinorChan>0</ATSCMinorChan>
 +
            <Format></Format>
 +
            <Modulation></Modulation>
 +
            <Frequency>0</Frequency>
 +
            <FrequencyId></FrequencyId>
 +
            <FrequencyTable></FrequencyTable>
 +
            <FineTune>0</FineTune>
 +
            <SIStandard></SIStandard>
 +
            <ChanFilters></ChanFilters>
 +
            <SourceId>0</SourceId>
 +
            <InputId>0</InputId>
 +
            <CommFree>0</CommFree>
 +
            <UseEIT>false</UseEIT>
 +
            <Visible>false</Visible>
 +
            <XMLTVID></XMLTVID>
 +
            <DefaultAuth></DefaultAuth>
 +
            <Programs/>
 +
        </Channel>
 +
        <Recording>
 +
            <Status>-3</Status>
 +
            <Priority>0</Priority>
 +
            <StartTs>2011-09-12T18:59:00</StartTs>
 +
            <EndTs>2011-09-12T20:02:15</EndTs>
 +
            <RecordId>1126</RecordId>
 +
            <RecGroup>Default</RecGroup>
 +
            <PlayGroup>Default</PlayGroup>
 +
            <RecType>0</RecType>
 +
            <DupInType>15</DupInType>
 +
            <DupMethod>6</DupMethod>
 +
            <EncoderId>0</EncoderId>
 +
            <Profile>Default</Profile>
 +
        </Recording>
 +
    </Program>
 +
</Programs>
 +
</ProgramList></pre>
  
 
==GetExpiring==
 
==GetExpiring==

Revision as of 01:34, 27 October 2011

Dvr Service API List

API Command POST Required? Description
GetUpcoming No Query information on all upcoming programs matching recording rules.
GetExpiring No Query information on recorded programs which are set to expire.
GetRecorded No Query information on all recorded programs.
Encoders No Query information on configured capture devices, and their current activity.

Dvr APIs

GetUpcoming

The GetUpcoming API takes the following arguments:

StartIndex (Optional)
Parameter Type: Integer
The numerical starting index in the list of expiring programs.
Count (Optional)
Parameter Type: Integer
The number of items to return in the result.
ShowAll (Optional)
Parameter Type: Boolean
Show all items which match recording rules, regardless of whether or not they will record (conflicts, previously recorded, etc.).

Example Query:

http://BackendServerIP:6544/Dvr/GetUpcoming?StartIndex=2&Count=1&ShowAll=true

Example Return: 

<?xml version="1.0" encoding="UTF-8"?>
<ProgramList version="1.0" serializerVersion="1.1">
<StartIndex>2</StartIndex>
<Count>1</Count>
<TotalAvailable>15</TotalAvailable>
<AsOf>2011-10-02T16:09:52</AsOf>
<Version>0.25.20110928-1</Version>
<ProtoVer>69</ProtoVer>
<Programs>
    <Program>
        <StartTime>2011-09-12T19:00:00</StartTime>
        <EndTime>2011-09-12T20:01:00</EndTime>
        <Title>Alphas</Title>
        <SubTitle>Blind Spot</SubTitle>
        <Category>Drama</Category>
        <CatType></CatType>
        <Repeat>true</Repeat>
        <SeriesId>EP01410873</SeriesId>
        <ProgramId>EP014108730010</ProgramId>
        <Stars>0</Stars>
        <FileSize>5143875332</FileSize>
        <LastModified>2011-09-12T20:02:18</LastModified>
        <ProgramFlags>13643781</ProgramFlags>
        <Hostname>Holmes</Hostname>
        <Airdate>2011-09-12</Airdate>
        <Inetref>210841</Inetref>
        <Season>1</Season>
        <Episode>9</Episode>
        <Channel>
            <ChanId>34736</ChanId>
            <ChanNum>736</ChanNum>
            <CallSign>SYFYHD</CallSign>
            <IconURL></IconURL>
            <ChannelName>Syfy HD</ChannelName>
            <MplexId>0</MplexId>
            <TransportId>0</TransportId>
            <ServiceId>0</ServiceId>
            <NetworkId>0</NetworkId>
            <ATSCMajorChan>0</ATSCMajorChan>
            <ATSCMinorChan>0</ATSCMinorChan>
            <Format></Format>
            <Modulation></Modulation>
            <Frequency>0</Frequency>
            <FrequencyId></FrequencyId>
            <FrequencyTable></FrequencyTable>
            <FineTune>0</FineTune>
            <SIStandard></SIStandard>
            <ChanFilters></ChanFilters>
            <SourceId>0</SourceId>
            <InputId>0</InputId>
            <CommFree>0</CommFree>
            <UseEIT>false</UseEIT>
            <Visible>false</Visible>
            <XMLTVID></XMLTVID>
            <DefaultAuth></DefaultAuth>
            <Programs/>
        </Channel>
        <Recording>
            <Status>-3</Status>
            <Priority>0</Priority>
            <StartTs>2011-09-12T18:59:00</StartTs>
            <EndTs>2011-09-12T20:02:15</EndTs>
            <RecordId>1126</RecordId>
            <RecGroup>Default</RecGroup>
            <PlayGroup>Default</PlayGroup>
            <RecType>0</RecType>
            <DupInType>15</DupInType>
            <DupMethod>6</DupMethod>
            <EncoderId>0</EncoderId>
            <Profile>Default</Profile>
        </Recording>
    </Program>
</Programs>
</ProgramList>

GetExpiring

The GetExpiring API takes the following arguments:

StartIndex (Optional)
Parameter Type: Integer
The numerical starting index in the list of expiring programs.
Count (Optional)
Parameter Type: Integer
The number of items to return in the result.

Example Query:

http://BackendServerIP:6544/Dvr/GetExpiring?StartIndex=2&Count=1

Example Return: 

<?xml version="1.0" encoding="UTF-8"?>
<ProgramList version="1.0" serializerVersion="1.1">
<StartIndex>2</StartIndex>
<Count>1</Count>
<TotalAvailable>15</TotalAvailable>
<AsOf>2011-10-02T16:09:52</AsOf>
<Version>0.25.20110928-1</Version>
<ProtoVer>69</ProtoVer>
<Programs>
    <Program>
        <StartTime>2011-09-12T19:00:00</StartTime>
        <EndTime>2011-09-12T20:01:00</EndTime>
        <Title>Alphas</Title>
        <SubTitle>Blind Spot</SubTitle>
        <Category>Drama</Category>
        <CatType></CatType>
        <Repeat>true</Repeat>
        <SeriesId>EP01410873</SeriesId>
        <ProgramId>EP014108730010</ProgramId>
        <Stars>0</Stars>
        <FileSize>5143875332</FileSize>
        <LastModified>2011-09-12T20:02:18</LastModified>
        <ProgramFlags>13643781</ProgramFlags>
        <Hostname>Holmes</Hostname>
        <Airdate>2011-09-12</Airdate>
        <Inetref>210841</Inetref>
        <Season>1</Season>
        <Episode>9</Episode>
        <Channel>
            <ChanId>34736</ChanId>
            <ChanNum>736</ChanNum>
            <CallSign>SYFYHD</CallSign>
            <IconURL></IconURL>
            <ChannelName>Syfy HD</ChannelName>
            <MplexId>0</MplexId>
            <TransportId>0</TransportId>
            <ServiceId>0</ServiceId>
            <NetworkId>0</NetworkId>
            <ATSCMajorChan>0</ATSCMajorChan>
            <ATSCMinorChan>0</ATSCMinorChan>
            <Format></Format>
            <Modulation></Modulation>
            <Frequency>0</Frequency>
            <FrequencyId></FrequencyId>
            <FrequencyTable></FrequencyTable>
            <FineTune>0</FineTune>
            <SIStandard></SIStandard>
            <ChanFilters></ChanFilters>
            <SourceId>0</SourceId>
            <InputId>0</InputId>
            <CommFree>0</CommFree>
            <UseEIT>false</UseEIT>
            <Visible>false</Visible>
            <XMLTVID></XMLTVID>
            <DefaultAuth></DefaultAuth>
            <Programs/>
        </Channel>
        <Recording>
            <Status>-3</Status>
            <Priority>0</Priority>
            <StartTs>2011-09-12T18:59:00</StartTs>
            <EndTs>2011-09-12T20:02:15</EndTs>
            <RecordId>1126</RecordId>
            <RecGroup>Default</RecGroup>
            <PlayGroup>Default</PlayGroup>
            <RecType>0</RecType>
            <DupInType>15</DupInType>
            <DupMethod>6</DupMethod>
            <EncoderId>0</EncoderId>
            <Profile>Default</Profile>
        </Recording>
    </Program>
</Programs>
</ProgramList>

GetRecorded

The GetRecorded API takes the following arguments:

StartIndex (Optional)
Parameter Type: Integer
The numerical starting index in the list of expiring programs.
Count (Optional)
Parameter Type: Integer
The number of items to return in the result.
Descending (Optional)
Parameter Type: Boolean
Controls whether results are returned in forward or reverse chronological order.

Example Query:

http://BackendServerIP:6544/Dvr/GetRecorded?StartIndex=2&Count=1&Descending=true

Example Return: 

<?xml version="1.0" encoding="UTF-8"?>
<ProgramList version="1.0" serializerVersion="1.1">
<StartIndex>2</StartIndex>
<Count>1</Count>
<TotalAvailable>15</TotalAvailable>
<AsOf>2011-10-02T16:09:52</AsOf>
<Version>0.25.20110928-1</Version>
<ProtoVer>69</ProtoVer>
<Programs>
    <Program>
        <StartTime>2011-09-12T19:00:00</StartTime>
        <EndTime>2011-09-12T20:01:00</EndTime>
        <Title>Alphas</Title>
        <SubTitle>Blind Spot</SubTitle>
        <Category>Drama</Category>
        <CatType></CatType>
        <Repeat>true</Repeat>
        <SeriesId>EP01410873</SeriesId>
        <ProgramId>EP014108730010</ProgramId>
        <Stars>0</Stars>
        <FileSize>5143875332</FileSize>
        <LastModified>2011-09-12T20:02:18</LastModified>
        <ProgramFlags>13643781</ProgramFlags>
        <Hostname>Holmes</Hostname>
        <Airdate>2011-09-12</Airdate>
        <Inetref>210841</Inetref>
        <Season>1</Season>
        <Episode>9</Episode>
        <Channel>
            <ChanId>34736</ChanId>
            <ChanNum>736</ChanNum>
            <CallSign>SYFYHD</CallSign>
            <IconURL></IconURL>
            <ChannelName>Syfy HD</ChannelName>
            <MplexId>0</MplexId>
            <TransportId>0</TransportId>
            <ServiceId>0</ServiceId>
            <NetworkId>0</NetworkId>
            <ATSCMajorChan>0</ATSCMajorChan>
            <ATSCMinorChan>0</ATSCMinorChan>
            <Format></Format>
            <Modulation></Modulation>
            <Frequency>0</Frequency>
            <FrequencyId></FrequencyId>
            <FrequencyTable></FrequencyTable>
            <FineTune>0</FineTune>
            <SIStandard></SIStandard>
            <ChanFilters></ChanFilters>
            <SourceId>0</SourceId>
            <InputId>0</InputId>
            <CommFree>0</CommFree>
            <UseEIT>false</UseEIT>
            <Visible>false</Visible>
            <XMLTVID></XMLTVID>
            <DefaultAuth></DefaultAuth>
            <Programs/>
        </Channel>
        <Recording>
            <Status>-3</Status>
            <Priority>0</Priority>
            <StartTs>2011-09-12T18:59:00</StartTs>
            <EndTs>2011-09-12T20:02:15</EndTs>
            <RecordId>1126</RecordId>
            <RecGroup>Default</RecGroup>
            <PlayGroup>Default</PlayGroup>
            <RecType>0</RecType>
            <DupInType>15</DupInType>
            <DupMethod>6</DupMethod>
            <EncoderId>0</EncoderId>
            <Profile>Default</Profile>
        </Recording>
    </Program>
</Programs>
</ProgramList>

Encoders

The Encoders API takes no arguments.

Example Query:

http://BackendServerIP:6544/Dvr/Encoders

Example Return: 

<?xml version="1.0" encoding="UTF-8"?>
<EncoderList version="1.0" serializerVersion="1.1">
<Encoders>
    <Encoder>
        <Id>1</Id>
        <HostName>Holmes</HostName>
        <Local>true</Local>
        <Connected>true</Connected>
        <State>0</State>
        <SleepStatus>8</SleepStatus>
        <LowOnFreeSpace>false</LowOnFreeSpace>
        <Recording>
            <StartTime></StartTime>
            <EndTime></EndTime>
            <Title></Title>
            <SubTitle></SubTitle>
            <Category></Category>
            <CatType></CatType>
            <Repeat>false</Repeat>
            <SeriesId></SeriesId>
            <ProgramId></ProgramId>
            <Stars>0</Stars>
            <FileSize>0</FileSize>
            <LastModified></LastModified>
            <ProgramFlags>0</ProgramFlags>
            <Hostname></Hostname>
            <Airdate></Airdate>
            <Inetref></Inetref>
            <Season>0</Season>
            <Episode>0</Episode>
            <Channel>
                <ChanId>0</ChanId>
                <ChanNum></ChanNum>
                <CallSign></CallSign>
                <IconURL></IconURL>
                <ChannelName></ChannelName>
                <MplexId>0</MplexId>
                <TransportId>0</TransportId>
                <ServiceId>0</ServiceId>
                <NetworkId>0</NetworkId>
                <ATSCMajorChan>0</ATSCMajorChan>
                <ATSCMinorChan>0</ATSCMinorChan>
                <Format></Format>
                <Modulation></Modulation>
                <Frequency>0</Frequency>
                <FrequencyId></FrequencyId>
                <FrequencyTable></FrequencyTable>
                <FineTune>0</FineTune>
                <SIStandard></SIStandard>
                <ChanFilters></ChanFilters>
                <SourceId>0</SourceId>
                <InputId>0</InputId>
                <CommFree>0</CommFree>
                <UseEIT>true</UseEIT>
                <Visible>true</Visible>
                <XMLTVID></XMLTVID>
                <DefaultAuth></DefaultAuth>
                <Programs/>
            </Channel>
            <Recording>
                <Status>0</Status>
                <Priority>0</Priority>
                <StartTs></StartTs>
                <EndTs></EndTs>
                <RecordId>0</RecordId>
                <RecGroup></RecGroup>
                <PlayGroup></PlayGroup>
                <RecType>0</RecType>
                <DupInType>1</DupInType>
                <DupMethod>1</DupMethod>
                <EncoderId>0</EncoderId>
                <Profile></Profile>
            </Recording>
        </Recording>
    </Encoder>
</Encoders>
</EncoderList>
Retrieved from "http://www.mythtv.org/wiki?title=DVR_Service&oldid=53470"