Difference between revisions of "Capture Service"
From MythTV Official Wiki
Iamlindoro (talk | contribs) (Created page with '=Capture Service API List= <center> {| cellpadding="4" border="1" | align="center" |<b>API Command</b> | align="center" |<b>POST Required?</b> | align="center" |<b>Descrip…') |
Iamlindoro (talk | contribs) |
||
| Line 8: | Line 8: | ||
| align="center" |<b>Description</b> | | align="center" |<b>Description</b> | ||
|- | |- | ||
| − | | style="background:silver" | GetCaptureCardList | + | | style="background:silver" | [[Capture_Service#GetCaptureCardList | GetCaptureCardList]] |
| style="background:silver" align="center" | No | | style="background:silver" align="center" | No | ||
| style="background:silver" | Get a list of configured capture devices globally, on a certain host, or of a certain type. | | style="background:silver" | Get a list of configured capture devices globally, on a certain host, or of a certain type. | ||
|- | |- | ||
| − | | GetCaptureCard | + | | [[Capture_Service#GetCaptureCard | GetCaptureCard]] |
| align="center" | No | | align="center" | No | ||
| Get info on a specific capture device, by card id. | | Get info on a specific capture device, by card id. | ||
|- | |- | ||
| − | | style="background:silver" |AddCaptureCard | + | | style="background:silver" | [[Capture_Service#AddCaptureCard | AddCaptureCard]] |
| style="background:silver" align="center" | Yes | | style="background:silver" align="center" | Yes | ||
| − | | style="background:silver" |Add a brand new capture device to the database. | + | | style="background:silver" | Add a brand new capture device to the database. |
|- | |- | ||
| − | | UpdateCaptureCard | + | | [[Capture_Service#UpdateCaptureCard | UpdateCaptureCard]] |
| align="center" | Yes | | align="center" | Yes | ||
| Change a specific setting value for a specific capture device. | | Change a specific setting value for a specific capture device. | ||
|- | |- | ||
| − | | style="background:silver" | RemoveCaptureCard | + | | style="background:silver" | [[Capture_Service#RemoveCaptureCard | RemoveCaptureCard]] |
| style="background:silver" align="center" | Yes | | style="background:silver" align="center" | Yes | ||
| style="background:silver" | Remove a particular capture device from the database, by card id. | | style="background:silver" | Remove a particular capture device from the database, by card id. | ||
|- | |- | ||
| − | | AddCardInput | + | | [[Capture_Service#GAddCardInput | AddCardInput]] |
| align="center" | Yes | | align="center" | Yes | ||
| Add a new card input to the database, and associate it with a video listings source. | | Add a new card input to the database, and associate it with a video listings source. | ||
|- | |- | ||
| − | | style="background:silver" | UpdateCardInput | + | | style="background:silver" | [[Capture_Service#UpdateCardInput | UpdateCardInput]] |
| style="background:silver" align="center" | Yes | | style="background:silver" align="center" | Yes | ||
| style="background:silver" | Change a specific setting value for a specific card input id. | | style="background:silver" | Change a specific setting value for a specific card input id. | ||
|- | |- | ||
| − | | RemoveCardInput | + | | [[Capture_Service#RemoveCardInput | RemoveCardInput]] |
| align="center" | Yes | | align="center" | Yes | ||
| Remove a particular card input from the database, by card input id. | | Remove a particular card input from the database, by card input id. | ||
Revision as of 05:38, 2 October 2011
Capture Service API List
| API Command | POST Required? | Description |
| GetCaptureCardList | No | Get a list of configured capture devices globally, on a certain host, or of a certain type. |
| GetCaptureCard | No | Get info on a specific capture device, by card id. |
| AddCaptureCard | Yes | Add a brand new capture device to the database. |
| UpdateCaptureCard | Yes | Change a specific setting value for a specific capture device. |
| RemoveCaptureCard | Yes | Remove a particular capture device from the database, by card id. |
| AddCardInput | Yes | Add a new card input to the database, and associate it with a video listings source. |
| UpdateCardInput | Yes | Change a specific setting value for a specific card input id. |
| RemoveCardInput | Yes | Remove a particular card input from the database, by card input id. |
Capture APIs
GetCaptureCardList
The GetCaptureCardList API takes the following arguments:
- HostName (Optional)
- The backend host name you wish to see a capture card list for.
- CardType (Optional)
- Filter results by a particular capture card type (HDHOMERUN, DEMO, etc.)
Example Query:
http://BackendServerIP:6544/Capture/GetCaptureCardList?HostName=localhost&CardType=HDHOMERUN
Example Return:
<CaptureCardList version="1.0" serializerVersion="1.1">
<CaptureCards>
<CaptureCard>
<CardId>3</CardId>
<VideoDevice>13100674-0</VideoDevice>
<AudioDevice></AudioDevice>
<VBIDevice></VBIDevice>
<CardType>HDHOMERUN</CardType>
<DefaultInput>MPEG2TS</DefaultInput>
<AudioRateLimit>0</AudioRateLimit>
<HostName>localhost</HostName>
<DVBSWFilter>0</DVBSWFilter>
<DVBSatType>0</DVBSatType>
<DVBWaitForSeqStart>true</DVBWaitForSeqStart>
<SkipBTAudio>false</SkipBTAudio>
<DVBOnDemand>false</DVBOnDemand>
<DVBDiSEqCType>0</DVBDiSEqCType>
<FirewireSpeed>0</FirewireSpeed>
<FirewireModel></FirewireModel>
<FirewireConnection>0</FirewireConnection>
<SignalTimeout>1000</SignalTimeout>
<ChannelTimeout>3000</ChannelTimeout>
<DVBTuningDelay>0</DVBTuningDelay>
<Contrast>0</Contrast>
<Brightness>0</Brightness>
<Colour>0</Colour>
<Hue>0</Hue>
<DiSEqCId>0</DiSEqCId>
<DVBEITScan>true</DVBEITScan>
</CaptureCard>
</CaptureCards>
</CaptureCardList>
GetCaptureCard
The GetCaptureCard API takes the following arguments:
- CardId (Required)
- The database card ID for the device you want informaion for.
Example Query:
http://BackendServerIP:6544/Capture/GetCaptureCard?CardId=3
Example Return:
<CaptureCard>
<CardId>3</CardId>
<VideoDevice>13100674-0</VideoDevice>
<AudioDevice></AudioDevice>
<VBIDevice></VBIDevice>
<CardType>HDHOMERUN</CardType>
<DefaultInput>MPEG2TS</DefaultInput>
<AudioRateLimit>0</AudioRateLimit>
<HostName>localhost</HostName>
<DVBSWFilter>0</DVBSWFilter>
<DVBSatType>0</DVBSatType>
<DVBWaitForSeqStart>true</DVBWaitForSeqStart>
<SkipBTAudio>false</SkipBTAudio>
<DVBOnDemand>false</DVBOnDemand>
<DVBDiSEqCType>0</DVBDiSEqCType>
<FirewireSpeed>0</FirewireSpeed>
<FirewireModel></FirewireModel>
<FirewireConnection>0</FirewireConnection>
<SignalTimeout>1000</SignalTimeout>
<ChannelTimeout>3000</ChannelTimeout>
<DVBTuningDelay>0</DVBTuningDelay>
<Contrast>0</Contrast>
<Brightness>0</Brightness>
<Colour>0</Colour>
<Hue>0</Hue>
<DiSEqCId>0</DiSEqCId>
<DVBEITScan>true</DVBEITScan>
</CaptureCard>
