Difference between revisions of "Channel Service"

From MythTV Official Wiki
Jump to: navigation, search
(Intro)
m (GetChannelInfoList: ComFree with 0.28pre)
 
(17 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{note box|This page is under construction 2/3/2013}}
 
 
=What is this?=
 
=What is this?=
 
See [[Services API]]
 
See [[Services API]]
Line 24: Line 23:
 
| style="background:silver" align="center"  | Yes
 
| style="background:silver" align="center"  | Yes
 
| style="background:silver" | Update a specific channel's database information.
 
| style="background:silver" | Update a specific channel's database information.
|-  
+
|-
 
| [[Channel_Service#AddDBChannel | AddDBChannel]]
 
| [[Channel_Service#AddDBChannel | AddDBChannel]]
 
| align="center" | Yes
 
| align="center" | Yes
Line 37: Line 36:
 
| Get all video sources. Note, usernames/passwords are included.
 
| Get all video sources. Note, usernames/passwords are included.
 
|-  
 
|-  
| style="background:silver" | [[Channel_Service#UpdateVideoSource | UpdateVideoSource]]
+
| style="background:silver" | [[Channel_Service#GetVideoSource | GetVideoSource]]
| style="background:silver" align="center" | Yes
+
| style="background:silver" align="center" | No
| style="background:silver" | Change a specific setting value for a specific video source.
+
| style="background:silver" | Get individual video source.
 
|-  
 
|-  
| [[Channel_Service#AddVideoSource | AddVideoSource]]
+
|  [[Channel_Service#UpdateVideoSource | UpdateVideoSource]]
| align="center"  | Yes
+
|  align="center" | Yes
| Add a new video source.
+
| | Change a specific setting value for a specific video source.
 +
|-
 +
| style="background:silver" | [[Channel_Service#AddVideoSource | AddVideoSource]]
 +
| style="background:silver" align="center"  | Yes
 +
| style="background:silver" | Add a new video source.
 
|-
 
|-
| style="background:silver" | [[Channel_Service#RemoveVideoSource | RemoveVideoSource]]
+
| [[Channel_Service#RemoveVideoSource | RemoveVideoSource]]
| style="background:silver" align="center" | Yes
+
| align="center" | Yes
| style="background:silver" | Remove a specific video source.
+
| Remove a specific video source.
 
|-  
 
|-  
| [[Channel_Service#GetDDLineupList | GetDDLineupList]]
+
| style="background:silver" | [[Channel_Service#GetDDLineupList | GetDDLineupList]]
| align="center"  | No
+
| style="background:silver" align="center"  | No
| Get Data Direct lineup.
+
| style="background:silver" | Get Data Direct lineup.
 
|-
 
|-
| style="background:silver" | [[Channel_Service#FetchChannelsFromSource | FetchChannelsFromSource]]
+
| [[Channel_Service#FetchChannelsFromSource | FetchChannelsFromSource]]
| style="background:silver" align="center" | No
+
| align="center" | No
| style="background:silver" | Get a list of channels for a specific source.
+
| Get a list of channels for a specific source.
 
|-  
 
|-  
| [[Channel_Service#GetVideoMultiplexList | GetVideoMultiplexList]]
+
| style="background:silver" | [[Channel_Service#GetVideoMultiplexList | GetVideoMultiplexList]]
| align="center"  | No
+
| style="background:silver" align="center"  | No
| Get a list of all video multiplexes.
+
| style="background:silver" | Get a list of all video multiplexes.
 
|-
 
|-
| style="background:silver" | [[Channel_Service#GetVideoMultiplex | GetVideoMultiplex]]
+
| [[Channel_Service#GetVideoMultiplex | GetVideoMultiplex]]
| style="background:silver" align="center" | No
+
| align="center" | No
| style="background:silver" | Get the video multiplexes for a specific multiplix ID.
+
| Get the video multiplexes for a specific multiplex ID.
 
|-  
 
|-  
| [[Channel_Service#GetXMLTVIdList | GetXMLTVIdList]]
+
| style="background:silver" | [[Channel_Service#GetXMLTVIdList | GetXMLTVIdList]]
| align="center"  | No
+
| style="background:silver" align="center"  | No
| Get a list of XMLTVIDs for a given source ID.
+
| style="background:silver" | Get a list of XMLTVIDs for a given source ID.
 
|}
 
|}
 
</center>
 
</center>
Line 89: Line 92:
 
:: Total number of channels to retrieve.
 
:: Total number of channels to retrieve.
  
 +
:<span style="color:SteelBlue">OnlyVisible</Span> ('''Optional''')
 +
:: '''Parameter Type:''' Bool
 +
:: Only show visible channels?
 +
:: This parameter is introduced with 0.28.  Presume set false to preserve 0.27 behaviour.  Its presence does not break 0.27.
 +
 +
:<span style="color:SteelBlue">Details</Span> ('''Optional''')
 +
:: '''Parameter Type:''' Bool
 +
:: This parameter is introduced with 0.28. 
 +
:: If false it only displays a subset of parameters.  ChanId, ChanNum, Callsign, IconURL and ChannelName.
 +
:: Set true to preserve 0.27 behaviour.  Its presence does not break 0.27.
  
 
Example Query:
 
Example Query:
  
<code>http://BackendServerIP:6544/Channel/GetChannelInfoList?SourceID=1&StartIndex=1&Count=1</code>
+
<code>http://BackendServerIP:6544/Channel/GetChannelInfoList?SourceID=1&StartIndex=1&Count=1&OnlyVisible=false&Details=true</code>
  
 
Example Return:
 
Example Return:
Line 138: Line 151:
 
     </ChannelInfoList>
 
     </ChannelInfoList>
 
</pre>
 
</pre>
 +
 +
Note that 0.28pre returns true or false rather than 1 or 0 for CommFree.
  
 
==GetChannelInfo==
 
==GetChannelInfo==
Line 150: Line 165:
 
Example Query:
 
Example Query:
  
<code>http://BackendServerIP:6544/Channel/GetChannelInfoList?SourceID=1&StartIndex=1&Count=1</code>
+
<code>http://BackendServerIP:6544/Channel/GetChannelInfo?ChanID=1002</code>
  
 
Example Return:
 
Example Return:
  
 
<pre>
 
<pre>
add response here
+
<?xml version="1.0" encoding="UTF-8"?>
 +
<ChannelInfo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.06" serializerVersion="1.1">
 +
    <ChanId>1002</ChanId>
 +
    <ChanNum>2</ChanNum>
 +
    <CallSign>BBC TWO</CallSign>
 +
    <IconURL></IconURL>
 +
    <ChannelName>BBC TWO</ChannelName>
 +
    <MplexId>1</MplexId>
 +
    <TransportId>4164</TransportId>
 +
    <ServiceId>4287</ServiceId>
 +
    <NetworkId>9018</NetworkId>
 +
    <ATSCMajorChan>0</ATSCMajorChan>
 +
    <ATSCMinorChan>0</ATSCMinorChan>
 +
    <Format></Format>
 +
    <Modulation></Modulation>
 +
    <Frequency>490000000</Frequency>
 +
    <FrequencyId>23</FrequencyId>
 +
    <FrequencyTable>default</FrequencyTable>
 +
    <FineTune>0</FineTune>
 +
    <SIStandard>dvb</SIStandard>
 +
    <ChanFilters></ChanFilters>
 +
    <SourceId>1</SourceId>
 +
    <InputId>0</InputId>
 +
    <CommFree>0</CommFree>
 +
    <UseEIT>true</UseEIT>
 +
    <Visible>true</Visible>
 +
    <XMLTVID></XMLTVID>
 +
    <DefaultAuth>fp.bbc.co.uk</DefaultAuth>
 +
    <Programs/>
 +
</ChannelInfo>
 
</pre>
 
</pre>
 
The <span style="color:LimeGreen">GetChannelInfo</span> API takes the following arguments:
 
  
 
==UpdateDBChannel==
 
==UpdateDBChannel==
  
The <span style="color:LimeGreen">UpdateDBChannel</span> API takes the following arguments:
+
The <span style="color:LimeGreen">UpdateDBChannel</span> API is a POST operation which requires a form with the following arguments:
 +
 
 +
::ATSCMajorChannel
 +
::ATSCMinorChannel
 +
::CallSign
 +
::ChannelID
 +
::ChannelName
 +
::ChannelNumber
 +
::DefaultAuthority
 +
::Format
 +
::FrequencyID
 +
::Icon
 +
::MplexID
 +
::ServiceID
 +
::SourceID
 +
::UseEIT
 +
::XMLTVID
 +
::visible
 +
 
 +
 
 +
Missing values may take unintended default values.
 +
 
 +
 
 +
Example Return:
 +
 
 +
<pre>
 +
<?xml version="1.0" encoding="UTF-8"?><bool>true</bool>
 +
</pre>
  
 
==AddDBChannel==
 
==AddDBChannel==
  
The <span style="color:LimeGreen">AddDBChannel</span> API takes the following arguments:
+
The <span style="color:LimeGreen">AddDBChannel</span> API is a POST operation:
 +
 
 +
Arguments and response are as per UpdateDBChannel.
  
 
==RemoveDBChannel==
 
==RemoveDBChannel==
  
The <span style="color:LimeGreen">RemoveDBChannel</span> API takes the following arguments:
+
The <span style="color:LimeGreen">RemoveDBChannel</span> API is a POST operation which requires a form with only one argument:
 +
::ChannelID
  
 
==GetVideoSourceList==
 
==GetVideoSourceList==
  
 
The <span style="color:LimeGreen">GetVideoSourceList</span> API takes the following arguments:
 
The <span style="color:LimeGreen">GetVideoSourceList</span> API takes the following arguments:
 +
 +
None.
 +
 +
Example Query:
 +
 +
<code>http://192.168.1.67:6544/Channel/GetVideoSourceList</code>
 +
 +
Example Return:
 +
 +
<pre>
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<VideoSourceList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.0" serializerVersion="1.1">
 +
<AsOf>2015-05-26T20:06:49Z</AsOf>
 +
<Version>0.27.20141016-1</Version>
 +
<ProtoVer>77</ProtoVer>
 +
    <VideoSources>
 +
        <VideoSource>
 +
            <Id>1</Id>
 +
            <SourceName>EIT</SourceName>
 +
            <Grabber>eitonly</Grabber>
 +
            <UserId></UserId>
 +
            <FreqTable>default</FreqTable>
 +
            <LineupId></LineupId>
 +
            <Password></Password>
 +
            <UseEIT>true</UseEIT>
 +
            <ConfigPath></ConfigPath>
 +
            <NITId>-1</NITId>
 +
        </VideoSource>
 +
    </VideoSources>
 +
</VideoSourceList>
 +
</pre>
  
 
==GetVideoSource==
 
==GetVideoSource==
  
 
The <span style="color:LimeGreen">GetVideoSource</span> API takes the following arguments:
 
The <span style="color:LimeGreen">GetVideoSource</span> API takes the following arguments:
 +
 +
SourceID
 +
 +
Example Query:
 +
 +
<code>http://192.168.1.67:6544/Channel/GetVideoSource?SourceID=1</code>
 +
 +
Example return:
 +
<pre>
 +
<<?xml version="1.0" encoding="UTF-8"?>
 +
<VideoSource xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.0" serializerVersion="1.1">
 +
    <Id>1</Id>
 +
    <SourceName>EIT</SourceName>
 +
    <Grabber>eitonly</Grabber>
 +
    <UserId></UserId>
 +
    <FreqTable>default</FreqTable>
 +
    <LineupId></LineupId>
 +
    <Password></Password>
 +
    <UseEIT>true</UseEIT>
 +
    <ConfigPath></ConfigPath>
 +
    <NITId>-1</NITId>
 +
</VideoSource>
 +
</pre>
  
 
==UpdateVideoSource==
 
==UpdateVideoSource==
Line 203: Line 329:
  
 
The <span style="color:LimeGreen">GetVideoMultiplexList</span> API takes the following arguments:
 
The <span style="color:LimeGreen">GetVideoMultiplexList</span> API takes the following arguments:
 +
 +
SourceID (mandatory)
 +
StartIndex, Count (optional).
 +
 +
Example query:
 +
http://192.168.1.67:6544/Channel/GetVideoMultiplexList?SourceID=1&StartIndex=1&Count=1
 +
 +
Example response:
 +
 +
<pre>
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<VideoMultiplexList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.0" serializerVersion="1.1">
 +
<StartIndex>1</StartIndex>
 +
<Count>1</Count>
 +
<CurrentPage>2</CurrentPage>
 +
<TotalPages>6</TotalPages>
 +
<TotalAvailable>6</TotalAvailable>
 +
<AsOf>2015-07-23T09:35:03Z</AsOf>
 +
<Version>0.27.20141016-1</Version>
 +
<ProtoVer>77</ProtoVer>
 +
    <VideoMultiplexes>
 +
        <VideoMultiplex>
 +
            <MplexId>2</MplexId>
 +
            <SourceId>1</SourceId>
 +
            <TransportId>8197</TransportId>
 +
            <NetworkId>9018</NetworkId>
 +
            <Frequency>514000000</Frequency>
 +
            <Inversion>a</Inversion>
 +
            <SymbolRate>0</SymbolRate>
 +
            <FEC></FEC>
 +
            <Polarity></Polarity>
 +
            <Modulation></Modulation>
 +
            <Bandwidth>8</Bandwidth>
 +
            <LPCodeRate>1/2</LPCodeRate>
 +
            <HPCodeRate>2/3</HPCodeRate>
 +
            <TransmissionMode>8</TransmissionMode>
 +
            <GuardInterval>1/32</GuardInterval>
 +
            <Visible>false</Visible>
 +
            <Constellation>qam_64</Constellation>
 +
            <Hierarchy>n</Hierarchy>
 +
            <ModulationSystem>1</ModulationSystem>
 +
            <RollOff></RollOff>
 +
            <SIStandard>dvb</SIStandard>
 +
            <ServiceVersion>21</ServiceVersion>
 +
            <UpdateTimeStamp>2012-04-18T07:50:51Z</UpdateTimeStamp>
 +
        <DefaultAuthority></DefaultAuthority>
 +
        </VideoMultiplex>
 +
    </VideoMultiplexes>
 +
</VideoMultiplexList>
 +
</pre>
  
 
==GetVideoMultiplex==
 
==GetVideoMultiplex==
  
 
The <span style="color:LimeGreen">GetVideoMultiplex</span> API takes the following arguments:
 
The <span style="color:LimeGreen">GetVideoMultiplex</span> API takes the following arguments:
 +
 +
MplexID
 +
 +
Example query:
 +
http://192.168.1.67:6544/Channel/GetVideoMultiplex?MplexID=1
 +
 +
Example response:
 +
 +
<pre>
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<VideoMultiplex xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.1" serializerVersion="1.1">
 +
    <MplexId>1</MplexId>
 +
    <SourceId>1</SourceId>
 +
    <TransportId>4164</TransportId>
 +
    <NetworkId>9018</NetworkId>
 +
    <Frequency>490000000</Frequency>
 +
    <Inversion>a</Inversion>
 +
    <SymbolRate>0</SymbolRate>
 +
    <FEC></FEC>
 +
    <Polarity></Polarity>
 +
    <Modulation></Modulation>
 +
    <Bandwidth>8</Bandwidth>
 +
    <LPCodeRate>1/2</LPCodeRate>
 +
    <HPCodeRate>2/3</HPCodeRate>
 +
    <TransmissionMode>8</TransmissionMode>
 +
    <GuardInterval>1/32</GuardInterval>
 +
    <Visible>false</Visible>
 +
    <Constellation>qam_64</Constellation>
 +
    <Hierarchy>n</Hierarchy>
 +
    <ModulationSystem>1</ModulationSystem>
 +
    <RollOff></RollOff>
 +
    <SIStandard>dvb</SIStandard>
 +
    <ServiceVersion>11</ServiceVersion>
 +
    <UpdateTimeStamp>2012-04-18T07:47:54Z</UpdateTimeStamp>
 +
    <DefaultAuthority></DefaultAuthority>
 +
</VideoMultiplex>
 +
</pre>
  
 
==GetXMLTVIdList==
 
==GetXMLTVIdList==

Latest revision as of 13:52, 4 February 2016

What is this?

See Services API


Channel Service API List

API Command POST Required? Description
GetChannelInfoList No Get a list of configured channels.
GetChannelInfo No Get info on a specific channel.
UpdateDBChannel Yes Update a specific channel's database information.
AddDBChannel Yes Add a new channel to the database.
RemoveDBChannel Yes Remove a particular channel from the database.
GetVideoSourceList No Get all video sources. Note, usernames/passwords are included.
GetVideoSource No Get individual video source.
UpdateVideoSource Yes Change a specific setting value for a specific video source.
AddVideoSource Yes Add a new video source.
RemoveVideoSource Yes Remove a specific video source.
GetDDLineupList No Get Data Direct lineup.
FetchChannelsFromSource No Get a list of channels for a specific source.
GetVideoMultiplexList No Get a list of all video multiplexes.
GetVideoMultiplex No Get the video multiplexes for a specific multiplex ID.
GetXMLTVIdList No Get a list of XMLTVIDs for a given source ID.

Channel APIs

GetChannelInfoList

The GetChannelInfoList API takes the following arguments:

SourceID (Required)
Parameter Type: Integer
The source ID of the channel of interest.
StartIndex (Optional)
Parameter Type: Integer
Value of the first index to retrieve.
Count (Optional)
Parameter Type: Integer
Total number of channels to retrieve.
OnlyVisible (Optional)
Parameter Type: Bool
Only show visible channels?
This parameter is introduced with 0.28. Presume set false to preserve 0.27 behaviour. Its presence does not break 0.27.
Details (Optional)
Parameter Type: Bool
This parameter is introduced with 0.28.
If false it only displays a subset of parameters. ChanId, ChanNum, Callsign, IconURL and ChannelName.
Set true to preserve 0.27 behaviour. Its presence does not break 0.27.

Example Query:

http://BackendServerIP:6544/Channel/GetChannelInfoList?SourceID=1&StartIndex=1&Count=1&OnlyVisible=false&Details=true

Example Return:

<ChannelInfoList version="1.0" serializerVersion="1.1">
    <StartIndex>1</StartIndex>
    <Count>1</Count>
    <CurrentPage>2</CurrentPage>
    <TotalPages>32</TotalPages>
    <TotalAvailable>32</TotalAvailable>
    <AsOf>2013-02-04T03:02:13Z</AsOf>
    <Version>0.27.20130130-1</Version>
    <ProtoVer>77</ProtoVer>
    <ChannelInfos>
        <ChannelInfo>
        <ChanId>1053</ChanId>
        <ChanNum>5_3</ChanNum>
        <CallSign>NBC5-US</CallSign>
        <IconURL/>
        <ChannelName>NBC5-US</ChannelName>
        <MplexId>5</MplexId>
        <TransportId>1001</TransportId>
        <ServiceId>7</ServiceId>
        <NetworkId>0</NetworkId>
        <ATSCMajorChan>5</ATSCMajorChan>
        <ATSCMinorChan>3</ATSCMinorChan>
        <Format>ATSC</Format>
        <Modulation>8vsb</Modulation>
        <Frequency>563000000</Frequency>
        <FrequencyId>29</FrequencyId>
        <FrequencyTable>default</FrequencyTable>
        <FineTune>0</FineTune>
        <SIStandard>atsc</SIStandard>
        <ChanFilters/>
        <SourceId>1</SourceId>
        <InputId>0</InputId>
        <CommFree>0</CommFree>
        <UseEIT>false</UseEIT>
        <Visible>false</Visible>
        <XMLTVID/><DefaultAuth/>
        <Programs/>
        </ChannelInfo>
        </ChannelInfos>
    </ChannelInfoList>

Note that 0.28pre returns true or false rather than 1 or 0 for CommFree.

GetChannelInfo

The GetChannelInfo API takes the following arguments:

ChanID (Required)
Parameter Type: Integer
Specific channel ID, e.g. 1021.


Example Query:

http://BackendServerIP:6544/Channel/GetChannelInfo?ChanID=1002

Example Return:

<?xml version="1.0" encoding="UTF-8"?>
<ChannelInfo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.06" serializerVersion="1.1">
    <ChanId>1002</ChanId>
    <ChanNum>2</ChanNum>
    <CallSign>BBC TWO</CallSign>
    <IconURL></IconURL>
    <ChannelName>BBC TWO</ChannelName>
    <MplexId>1</MplexId>
    <TransportId>4164</TransportId>
    <ServiceId>4287</ServiceId>
    <NetworkId>9018</NetworkId>
    <ATSCMajorChan>0</ATSCMajorChan>
    <ATSCMinorChan>0</ATSCMinorChan>
    <Format></Format>
    <Modulation></Modulation>
    <Frequency>490000000</Frequency>
    <FrequencyId>23</FrequencyId>
    <FrequencyTable>default</FrequencyTable>
    <FineTune>0</FineTune>
    <SIStandard>dvb</SIStandard>
    <ChanFilters></ChanFilters>
    <SourceId>1</SourceId>
    <InputId>0</InputId>
    <CommFree>0</CommFree>
    <UseEIT>true</UseEIT>
    <Visible>true</Visible>
    <XMLTVID></XMLTVID>
    <DefaultAuth>fp.bbc.co.uk</DefaultAuth>
    <Programs/>
</ChannelInfo>

UpdateDBChannel

The UpdateDBChannel API is a POST operation which requires a form with the following arguments:

ATSCMajorChannel
ATSCMinorChannel
CallSign
ChannelID
ChannelName
ChannelNumber
DefaultAuthority
Format
FrequencyID
Icon
MplexID
ServiceID
SourceID
UseEIT
XMLTVID
visible


Missing values may take unintended default values.


Example Return:

<?xml version="1.0" encoding="UTF-8"?><bool>true</bool>

AddDBChannel

The AddDBChannel API is a POST operation:

Arguments and response are as per UpdateDBChannel.

RemoveDBChannel

The RemoveDBChannel API is a POST operation which requires a form with only one argument:

ChannelID

GetVideoSourceList

The GetVideoSourceList API takes the following arguments:

None.

Example Query:

http://192.168.1.67:6544/Channel/GetVideoSourceList

Example Return:

<?xml version="1.0" encoding="UTF-8"?>
<VideoSourceList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.0" serializerVersion="1.1">
<AsOf>2015-05-26T20:06:49Z</AsOf>
<Version>0.27.20141016-1</Version>
<ProtoVer>77</ProtoVer>
    <VideoSources>
        <VideoSource>
            <Id>1</Id>
            <SourceName>EIT</SourceName>
            <Grabber>eitonly</Grabber>
            <UserId></UserId>
            <FreqTable>default</FreqTable>
            <LineupId></LineupId>
            <Password></Password>
            <UseEIT>true</UseEIT>
            <ConfigPath></ConfigPath>
            <NITId>-1</NITId>
        </VideoSource>
    </VideoSources>
</VideoSourceList>

GetVideoSource

The GetVideoSource API takes the following arguments:

SourceID

Example Query:

http://192.168.1.67:6544/Channel/GetVideoSource?SourceID=1

Example return:

<<?xml version="1.0" encoding="UTF-8"?>
<VideoSource xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.0" serializerVersion="1.1">
    <Id>1</Id>
    <SourceName>EIT</SourceName>
    <Grabber>eitonly</Grabber>
    <UserId></UserId>
    <FreqTable>default</FreqTable>
    <LineupId></LineupId>
    <Password></Password>
    <UseEIT>true</UseEIT>
    <ConfigPath></ConfigPath>
    <NITId>-1</NITId>
</VideoSource>

UpdateVideoSource

The UpdateVideoSource API takes the following arguments:

AddVideoSource

The AddVideoSource API takes the following arguments:

RemoveVideoSource

The RemoveVideoSource API takes the following arguments:

GetDDLineupList

The GetDDLineupList API takes the following arguments:

FetchChannelsFromSource

The FetchChannelsFromSource API takes the following arguments:

GetVideoMultiplexList

The GetVideoMultiplexList API takes the following arguments:

SourceID (mandatory) StartIndex, Count (optional).

Example query: http://192.168.1.67:6544/Channel/GetVideoMultiplexList?SourceID=1&StartIndex=1&Count=1

Example response:

<?xml version="1.0" encoding="UTF-8"?>
<VideoMultiplexList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.0" serializerVersion="1.1">
<StartIndex>1</StartIndex>
<Count>1</Count>
<CurrentPage>2</CurrentPage>
<TotalPages>6</TotalPages>
<TotalAvailable>6</TotalAvailable>
<AsOf>2015-07-23T09:35:03Z</AsOf>
<Version>0.27.20141016-1</Version>
<ProtoVer>77</ProtoVer>
    <VideoMultiplexes>
        <VideoMultiplex>
            <MplexId>2</MplexId>
            <SourceId>1</SourceId>
            <TransportId>8197</TransportId>
            <NetworkId>9018</NetworkId>
            <Frequency>514000000</Frequency>
            <Inversion>a</Inversion>
            <SymbolRate>0</SymbolRate>
            <FEC></FEC>
            <Polarity></Polarity>
            <Modulation></Modulation>
            <Bandwidth>8</Bandwidth>
            <LPCodeRate>1/2</LPCodeRate>
            <HPCodeRate>2/3</HPCodeRate>
            <TransmissionMode>8</TransmissionMode>
            <GuardInterval>1/32</GuardInterval>
            <Visible>false</Visible>
            <Constellation>qam_64</Constellation>
            <Hierarchy>n</Hierarchy>
            <ModulationSystem>1</ModulationSystem>
            <RollOff></RollOff>
            <SIStandard>dvb</SIStandard>
            <ServiceVersion>21</ServiceVersion>
            <UpdateTimeStamp>2012-04-18T07:50:51Z</UpdateTimeStamp>
        <DefaultAuthority></DefaultAuthority>
        </VideoMultiplex>
    </VideoMultiplexes>
</VideoMultiplexList>

GetVideoMultiplex

The GetVideoMultiplex API takes the following arguments:

MplexID

Example query: http://192.168.1.67:6544/Channel/GetVideoMultiplex?MplexID=1

Example response:

<?xml version="1.0" encoding="UTF-8"?>
<VideoMultiplex xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.1" serializerVersion="1.1">
    <MplexId>1</MplexId>
    <SourceId>1</SourceId>
    <TransportId>4164</TransportId>
    <NetworkId>9018</NetworkId>
    <Frequency>490000000</Frequency>
    <Inversion>a</Inversion>
    <SymbolRate>0</SymbolRate>
    <FEC></FEC>
    <Polarity></Polarity>
    <Modulation></Modulation>
    <Bandwidth>8</Bandwidth>
    <LPCodeRate>1/2</LPCodeRate>
    <HPCodeRate>2/3</HPCodeRate>
    <TransmissionMode>8</TransmissionMode>
    <GuardInterval>1/32</GuardInterval>
    <Visible>false</Visible>
    <Constellation>qam_64</Constellation>
    <Hierarchy>n</Hierarchy>
    <ModulationSystem>1</ModulationSystem>
    <RollOff></RollOff>
    <SIStandard>dvb</SIStandard>
    <ServiceVersion>11</ServiceVersion>
    <UpdateTimeStamp>2012-04-18T07:47:54Z</UpdateTimeStamp>
    <DefaultAuthority></DefaultAuthority>
</VideoMultiplex>

GetXMLTVIdList

The GetXMLTVIdList API takes the following arguments: