Content Service
Contents
- 1 What is this?
- 2 Content Service API List
- 3 Content APIs
- 3.1 GetFile
- 3.2 GetImageFile
- 3.3 GetFileList
- 3.4 GetRecordingArtwork
- 3.5 GetRecordingArtworkList
- 3.6 GetProgramArtworkList
- 3.7 GetVideoArtwork
- 3.8 GetAlbumArt
- 3.9 GetPreviewImage
- 3.10 GetRecording
- 3.11 GetVideo
- 3.12 GetMusic
- 3.13 GetHash
- 3.14 DownloadFile
- 3.15 AddLiveStream
- 3.16 AddRecordingLiveStream
- 3.17 AddVideoLiveStream
- 3.18 GetLiveStream
- 3.19 GetLiveStreamList
- 3.20 GetFilteredLiveStreamList
- 3.21 RemoveLiveStream
- 3.22 StopLiveStream
What is this?
See Services API
Content Service API List
API Command | POST Required? | Description |
GetFile | No | Download a given file from a given storage group. |
GetImageFile | No | Display, and optionally scale, an image file from a given storage group. |
GetFileList | No | Get a list of files in a specified storage group. |
GetRecordingArtwork | No | Display, and optionally scale, an image file of a given type (coverart, banner, fanart) for a given recording's inetref and season number. |
GetRecordingArtworkList | No | Display a list of artwork available for a recording by start time and channel id. |
GetProgramArtworkList | No | Display a list of artwork available for a program by inetref and season. |
GetVideoArtwork | No | Display, and optionally scale, an image file of a given type (coverart, banner, fanart) for a given video's database id number. |
GetAlbumArt | No | Display, and optionally scale, the album art for a given music file's database id number. |
GetPreviewImage | No | Display, and optionally scale, an preview thumbnail for a given recording by timestamp, chanid and starttime. |
GetRecording | No | Download a given recording file by chanid and starttime. |
GetMusic | No | Download a given music file by database id. |
GetVideo | No | Download a given video by database id. |
GetHash | No | Perform a unique identifying hash on a given file in a given storage group. |
DownloadFile | Yes | Instruct the backend to download a remote file into a storage group. |
AddLiveStream | No | Start a HTTP Live Stream transcode for a given file and storage group. |
AddRecordingLiveStream | No | Start a HTTP Live Stream transcode for a given ChanId and StartTime. |
AddVideoLiveStream | No | Start a HTTP Live Stream transcode for a given Video ID. |
GetLiveStream | No | Get the stream status data for a given HTTP Live Stream. |
GetLiveStreamList | No | Get the stream status data for all available HTTP Live Streams. |
GetFilteredLiveStreamList | No | Get the stream status data for all available HTTP Live Streams created from a given filename. |
RemoveLiveStream | No | Stop transcoding a given HTTP Live Stream, and remove the transcoded files. |
StopLiveStream | No | Stop transcoding a given HTTP Live Stream, leaving the transcoded files intact. |
Content APIs
GetFile
The GetFile API takes the following arguments:
- StorageGroup (Required)
- Parameter Type: String
- The Storage Group name in which you wish to search for the file.
- FileName (Required)
- Parameter Type: String
- The filename (and relative path if necessary) of the file you wish to receive.
Example Query:
Example Return:
The return for this command is a binary file which will be interpreted by your browser and downloaded or displayed as appropriate.
GetImageFile
The GetImageFile API takes the following arguments:
- StorageGroup (Required)
- Parameter Type: String
- The Storage Group name in which you wish to search for the file.
- FileName (Required)
- Parameter Type: String
- The filename (and relative path if necessary) of the file you wish to receive.
- Width (Optional)
- Parameter Type: Integer
- The scaled width to return the image. To preserve proper aspect, you may want to specify only one of width or height.
- Height (Optional)
- Parameter Type: Integer
- The scaled height to return the image. To preserve proper aspect, you may want to specify only one of width or height.
Example Query:
Example Return:
The return for this command is a binary file which will be interpreted by your browser and downloaded or displayed as appropriate.
GetFileList
The GetFileList API takes the following arguments:
- StorageGroup (Required)
- Parameter Type: String
- The Storage Group name for which you wish to see a list of files.
Example Query:
http://BackendServerIP:6544/Content/GetFileList?StorageGroup=Fanart
Example Return:
<?xml version="1.0" encoding="UTF-8"?> <QStringList> <String>10020_fanart.jpg</String> <String>10074_fanart.jpg</String> <String>10126_fanart.jpg</String> <String>10138_fanart.jpg</String> <String>10139_fanart.jpg</String> <String>10140_fanart.jpg</String> <String>10189_fanart.jpg</String> <String>10191_fanart.jpg</String> <String>10192_fanart.jpg</String> <String>10196_fanart.jpg</String> </QStringList>
GetRecordingArtwork
The GetRecordingArtwork API takes the following arguments:
- Inetref (Required)
- Parameter Type: String
- The inetref for the recording you are looking up. This information is available in the Program construct, which can be queried in the DVR Service.
- Type (Optional)
- Parameter Type: String
- The type of artwork you wish to download. Valid types are coverart, fanart, and banner. If no type is present, the query will fall back to coverart.
- Season (Optional)
- Parameter Type: Integer
- The season number of the artwork you wish to receive. If no season number is present, the query will fall back to the latest available season.
- Width (Optional)
- Parameter Type: Integer
- The scaled width to return the image. To preserve proper aspect, you may want to specify only one of width or height.
- Height (Optional)
- Parameter Type: Integer
- The scaled height to return the image. To preserve proper aspect, you may want to specify only one of width or height.
Example Query:
http://BackendServerIP:6544/Content/GetRecordingArtwork?Inetref=80552&Type=fanart&Season=2
Example Return:
The return for this command is a binary file which will be interpreted by your browser and downloaded or displayed as appropriate.
GetRecordingArtworkList
The GetRecordingArtwork API takes the following arguments:
- ChanId (Required)
- Parameter Type: Integer
- The database channel id for the recording.
- StartTime (Required)
- Parameter Type: String
- The recording start time for the item. This should be in MySQL ISO format, eg: 2011-08-29 18:59:00. You can replace the space with %20 or T.
Example Query:
Example Return:
<ArtworkInfoList version="1.0" serializerVersion="1.1"> <ArtworkInfos> <ArtworkInfo> <URL>/Content/GetRecordingArtwork?InetRef=210841&Season=1&Type=coverart</URL> <FileName>myth://Coverart@192.168.0.99:6543/Alphas Season 1_coverart.jpg</FileName> <StorageGroup>Coverart</StorageGroup> <Type>coverart</Type> </ArtworkInfo> <ArtworkInfo> <URL>/Content/GetRecordingArtwork?InetRef=210841&Season=1&Type=fanart</URL> <FileName>myth://Fanart@192.168.0.99:6543/Alphas Season 1_fanart.jpg</FileName> <StorageGroup>Fanart</StorageGroup> <Type>fanart</Type> </ArtworkInfo> <ArtworkInfo> <URL>/Content/GetRecordingArtwork?InetRef=210841&Season=1&Type=banner</URL> <FileName>myth://Banners@192.168.0.99:6543/Alphas Season 1_banner.jpg</FileName> <StorageGroup>Banners</StorageGroup> <Type>banner</Type> </ArtworkInfo> </ArtworkInfos> </ArtworkInfoList>
GetProgramArtworkList
The GetRecordingArtwork API takes the following arguments:
- Inetref (Required)
- Parameter Type: String
- The inetref for the recording you are looking up. This information is available in the Program construct, which can be queried in the DVR Service.
- Season (Optional)
- Parameter Type: Integer
- The season number of the artwork you wish to receive. If no season number is present, the query will fall back to the latest available season.
Example Query:
http://BackendServerIP:6544/Content/GetRecordingArtwork?Inetref=80552&Type=fanart&Season=2
Example Return:
<ArtworkInfoList version="1.0" serializerVersion="1.1"> <ArtworkInfos> <ArtworkInfo> <URL>/Content/GetRecordingArtwork?InetRef=210841&Season=1&Type=coverart</URL> <FileName>myth://Coverart@192.168.0.99:6543/Alphas Season 1_coverart.jpg</FileName> <StorageGroup>Coverart</StorageGroup> <Type>coverart</Type> </ArtworkInfo> <ArtworkInfo> <URL>/Content/GetRecordingArtwork?InetRef=210841&Season=1&Type=fanart</URL> <FileName>myth://Fanart@192.168.0.99:6543/Alphas Season 1_fanart.jpg</FileName> <StorageGroup>Fanart</StorageGroup> <Type>fanart</Type> </ArtworkInfo> <ArtworkInfo> <URL>/Content/GetRecordingArtwork?InetRef=210841&Season=1&Type=banner</URL> <FileName>myth://Banners@192.168.0.99:6543/Alphas Season 1_banner.jpg</FileName> <StorageGroup>Banners</StorageGroup> <Type>banner</Type> </ArtworkInfo> </ArtworkInfos> </ArtworkInfoList>
GetVideoArtwork
The GetVideoArtwork API takes the following arguments:
- Id (Required)
- Parameter Type: String
- The database id for the video you are looking up. This information is available in the VideoMetadataInfo construct, which can be queried in the Video Service.
- Type (Optional)
- Parameter Type: String
- The type of artwork you wish to download. Valid types are coverart, fanart, and banner. If no type is present, the query will fall back to coverart.
- Width (Optional)
- Parameter Type: Integer
- The scaled width to return the image. To preserve proper aspect, you may want to specify only one of width or height.
- Height (Optional)
- Parameter Type: Integer
- The scaled height to return the image. To preserve proper aspect, you may want to specify only one of width or height.
Example Query:
http://BackendServerIP:6544/Content/GetVideoArtwork?Id=100&Type=fanart
Example Return:
The return for this command is a binary file which will be interpreted by your browser and downloaded or displayed as appropriate.
GetAlbumArt
The GetAlbumArt API takes the following arguments:
- Id (Required)
- Parameter Type: String
- The database id for the track you are looking up. For an album, use the id of the first track.
- Width (Optional)
- Parameter Type: Integer
- The scaled width to return the image. To preserve proper aspect, you may want to specify only one of width or height.
- Height (Optional)
- Parameter Type: Integer
- The scaled height to return the image. To preserve proper aspect, you may want to specify only one of width or height.
Example Query:
http://BackendServerIP:6544/Content/GetAlbumArt?Id=585
Example Return:
The return for this command is a binary file which will be interpreted by your browser and downloaded or displayed as appropriate.
GetPreviewImage
The GetPreviewImage API takes the following arguments:
- ChanId (Required)
- Parameter Type: Integer
- The database channel id for the recording.
- StartTime (Required)
- Parameter Type: String
- The recording start time for the item. This should be in MySQL ISO format, eg: 2011-08-29 18:59:00. You can replace the space with %20 or T.
- Width (Optional)
- Parameter Type: Integer
- The scaled width to return the image. To preserve proper aspect, you may want to specify only one of width or height.
- Height (Optional)
- Parameter Type: Integer
- The scaled height to return the image. To preserve proper aspect, you may want to specify only one of width or height.
- SecsIn (Optional)
- Parameter Type: Integer
- The number of seconds into the recording to fast forward before generating a preview image.
Example Query:
http://BackendServerIP:6544/Content/GetPreviewImage?ChanId=34736&StartTime=2011-08-29T18:59:00
Example Return:
The return for this command is a binary file which will be interpreted by your browser and downloaded or displayed as appropriate.
GetRecording
The GetRecording API takes the following arguments:
- ChanId (Required)
- Parameter Type: Integer
- The database channel id for the recording.
- StartTime (Required)
- Parameter Type: String
- The recording start time for the item. This should be in MySQL ISO format, eg: 2011-08-29 18:59:00. You can replace the space with %20 or T. Note that this is the actual start time of the recording not of the show, So for this to work you need to use StartTs from the recording portion of the program info not StartTime
From 0.28 or service version 2.0 you may use the recording ID instead of ChanId/StartTime:
- RecordedId (Optionally Required)
- Parameter Type: Integer
- The database recordedid for the recording.
Example Query:
http://BackendServerIP:6544/Content/GetRecording?ChanId=34736&StartTime=2011-08-29T18:59:00
Example Return:
The return for this command is a binary file which will be interpreted by your browser and downloaded or displayed as appropriate.
GetVideo
The GetVideo API takes the following arguments:
- Id (Required)
- Parameter Type: String
- The database id for the video file.
Example Query:
http://BackendServerIP:6544/Content/GetVideo?Id=100
Example Return:
The return for this command is a binary file which will be interpreted by your browser and downloaded or displayed as appropriate.
GetMusic
The GetMusic API takes the following arguments:
- Id (Required)
- Parameter Type: String
- The database id for the music file.
Example Query:
http://BackendServerIP:6544/Content/GetMusic?Id=100
Example Return:
The return for this command is a binary file which will be interpreted by your browser and downloaded or displayed as appropriate.
GetHash
The GetHash API takes the following arguments:
- StorageGroup (Required)
- Parameter Type: String
- The Storage Group name in which you wish to search for the file.
- FileName (Required)
- Parameter Type: String
- The filename (and relative path if necessary) of the file you wish to hash.
Example Query:
Example Return:
<?xml version="1.0" encoding="UTF-8"?> <QString>c80767b59e4d96d2</QString>
DownloadFile
The DownloadFile API takes the following arguments:
- StorageGroup (Required)
- Parameter Type: String
- The Storage Group name to which you wish to download the file.
- URL (Required)
- Parameter Type: String
- The URL that you wish to download.
Example Query:
Example Return:
<?xml version="1.0" encoding="UTF-8"?> <bool>true</bool>
AddLiveStream
The AddLiveStream API takes the following arguments:
- FileName (Required)
- Parameter Type: String
- The Filename you wish to transcode.
- StorageGroup (Optional)
- Parameter Type: String
- The Storage Group name which contains the file to be transcoded.
- MaxSegments (Optional)
- Parameter Type: Integer
- The number of 10-second segments to keep at any given time. When this number of segments is reached, each new segment results in the deletion of the oldest one from the playlist and filesystem. Not setting this value, or a value of 0, will result in all segments being kept.
- Width (Optional)
- Parameter Type: Integer
- The width, in pixels, of the output stream. If only one of Height and Width are set, the other will be set automatically to preserve the aspect.
- Height (Optional)
- Parameter Type: Integer
- The height, in pixels, of the output stream. If only one of Height and Width are set, the other will be set automatically to preserve the aspect.
- Bitrate (Optional)
- Parameter Type: Integer
- The video bitrate, in bits per second, of the output stream. The default bitrate is 800000 b/s (800 Kb/s).
- AudioBitrate (Optional)
- Parameter Type: Integer
- The audio bitrate, in bits per second, of the output stream. The default audio bitrate is 64000 b/s (64 Kb/s).
- SampleRate (Optional)
- Parameter Type: Integer
- The audio sampling rate, in Hz, of the output stream. The default audio sampling rate is 44100 Hz (44.1 Khz/s).
Example Query:
Example Return:
<?xml version="1.0" encoding="UTF-8"?> <LiveStreamInfo version="1.0" serializerVersion="1.1"> <Id>100</Id> <Width>0</Width> <Height>540</Height> <Bitrate>600000</Bitrate> <AudioBitrate>40000</AudioBitrate> <SegmentSize>10</SegmentSize> <MaxSegments>0</MaxSegments> <StartSegment>0</StartSegment> <CurrentSegment>0</CurrentSegment> <SegmentCount>0</SegmentCount> <PercentComplete>0</PercentComplete> <Created>2011-12-03T06:58:55</Created> <LastModified>2011-12-03T06:58:55</LastModified> <RelativeURL>/Content/GetFile?StorageGroup=Streaming&FileName=34736_20110926190000.mpg.0x540_600kV_40kA.m3u8</RelativeURL> <FullURL>http://192.168.0.99:6544/Content/GetFile?StorageGroup=Streaming&FileName=34736_20110926190000.mpg.0x540_600kV_40kA.m3u8</FullURL> <StatusStr>Queued</StatusStr> <StatusInt>0</StatusInt> <StatusMessage></StatusMessage> <SourceFile>/var/lib/mythtv/recordings/34736_20110926190000.mpg</SourceFile> <SourceHost>Holmes</SourceHost> <SourceWidth>0</SourceWidth> <SourceHeight>0</SourceHeight> <AudioOnlyBitrate>32000</AudioOnlyBitrate> </LiveStreamInfo>
AddRecordingLiveStream
The AddRecordingLiveStream API takes the following arguments:
- ChanId (Required)
- Parameter Type: Integer
- The database channel id for the recording.
- StartTime (Required)
- Parameter Type: String
- The recording start time for the item. This should be in MySQL ISO format, eg: 2011-08-29 18:59:00. You can replace the space with %20 or T.
- MaxSegments (Optional)
- Parameter Type: Integer
- The number of 10-second segments to keep at any given time. When this number of segments is reached, each new segment results in the deletion of the oldest one from the playlist and filesystem. Not setting this value, or a value of 0, will result in all segments being kept.
- Width (Optional)
- Parameter Type: Integer
- The width, in pixels, of the output stream. If only one of Height and Width are set, the other will be set automatically to preserve the aspect.
- Height (Optional)
- Parameter Type: Integer
- The height, in pixels, of the output stream. If only one of Height and Width are set, the other will be set automatically to preserve the aspect.
- Bitrate (Optional)
- Parameter Type: Integer
- The video bitrate, in bits per second, of the output stream. The default bitrate is 800000 b/s (800 Kb/s).
- AudioBitrate (Optional)
- Parameter Type: Integer
- The audio bitrate, in bits per second, of the output stream. The default audio bitrate is 64000 b/s (64 Kb/s).
- SampleRate (Optional)
- Parameter Type: Integer
- The audio sampling rate, in Hz, of the output stream. The default audio sampling rate is 44100 Hz (44.1 Khz/s).
Example Query:
Example Return:
<?xml version="1.0" encoding="UTF-8"?> <LiveStreamInfo version="1.0" serializerVersion="1.1"> <Id>100</Id> <Width>0</Width> <Height>540</Height> <Bitrate>600000</Bitrate> <AudioBitrate>40000</AudioBitrate> <SegmentSize>10</SegmentSize> <MaxSegments>0</MaxSegments> <StartSegment>0</StartSegment> <CurrentSegment>0</CurrentSegment> <SegmentCount>0</SegmentCount> <PercentComplete>0</PercentComplete> <Created>2011-12-03T06:58:55</Created> <LastModified>2011-12-03T06:58:55</LastModified> <RelativeURL>/Content/GetFile?StorageGroup=Streaming&FileName=34736_20110926190000.mpg.0x540_600kV_40kA.m3u8</RelativeURL> <FullURL>http://192.168.0.99:6544/Content/GetFile?StorageGroup=Streaming&FileName=34736_20110926190000.mpg.0x540_600kV_40kA.m3u8</FullURL> <StatusStr>Queued</StatusStr> <StatusInt>0</StatusInt> <StatusMessage></StatusMessage> <SourceFile>/var/lib/mythtv/recordings/34736_20110926190000.mpg</SourceFile> <SourceHost>Holmes</SourceHost> <SourceWidth>0</SourceWidth> <SourceHeight>0</SourceHeight> <AudioOnlyBitrate>32000</AudioOnlyBitrate> </LiveStreamInfo>
AddVideoLiveStream
The AddVideoLiveStream API takes the following arguments:
- Id (Required)
- Parameter Type: String
- The database id for the video you are streaming. This information is available in the VideoMetadataInfo construct, which can be queried in the Video Service.
- MaxSegments (Optional)
- Parameter Type: Integer
- The number of 10-second segments to keep at any given time. When this number of segments is reached, each new segment results in the deletion of the oldest one from the playlist and filesystem. Not setting this value, or a value of 0, will result in all segments being kept.
- Width (Optional)
- Parameter Type: Integer
- The width, in pixels, of the output stream. If only one of Height and Width are set, the other will be set automatically to preserve the aspect.
- Height (Optional)
- Parameter Type: Integer
- The height, in pixels, of the output stream. If only one of Height and Width are set, the other will be set automatically to preserve the aspect.
- Bitrate (Optional)
- Parameter Type: Integer
- The video bitrate, in bits per second, of the output stream. The default bitrate is 800000 b/s (800 Kb/s).
- AudioBitrate (Optional)
- Parameter Type: Integer
- The audio bitrate, in bits per second, of the output stream. The default audio bitrate is 64000 b/s (64 Kb/s).
- SampleRate (Optional)
- Parameter Type: Integer
- The audio sampling rate, in Hz, of the output stream. The default audio sampling rate is 44100 Hz (44.1 Khz/s).
Example Query:
Example Return:
<?xml version="1.0" encoding="UTF-8"?> <LiveStreamInfo version="1.0" serializerVersion="1.1"> <Id>100</Id> <Width>0</Width> <Height>540</Height> <Bitrate>600000</Bitrate> <AudioBitrate>40000</AudioBitrate> <SegmentSize>10</SegmentSize> <MaxSegments>0</MaxSegments> <StartSegment>0</StartSegment> <CurrentSegment>0</CurrentSegment> <SegmentCount>0</SegmentCount> <PercentComplete>0</PercentComplete> <Created>2011-12-03T06:58:55</Created> <LastModified>2011-12-03T06:58:55</LastModified> <RelativeURL>/Content/GetFile?StorageGroup=Streaming&FileName=300.evo.0x540_600kV_40kA.m3u8</RelativeURL> <FullURL>http://192.168.0.99:6544/Content/GetFile?StorageGroup=Streaming&FileName=300.evo.0x540_600kV_40kA.m3u8</FullURL> <StatusStr>Queued</StatusStr> <StatusInt>0</StatusInt> <StatusMessage></StatusMessage> <SourceFile>/MythMedia/movies/300.evo</SourceFile> <SourceHost>Holmes</SourceHost> <SourceWidth>0</SourceWidth> <SourceHeight>0</SourceHeight> <AudioOnlyBitrate>32000</AudioOnlyBitrate> </LiveStreamInfo>
GetLiveStream
The GetLiveStream API takes the following arguments:
- Id (Required)
- Parameter Type: String
- The database id for the live stream. This information is returned with the LiveStreamInfo from when adding a stream.
Example Query:
http://BackendServerIP:6544/Content/GetLiveStream?Id=100
Example Return:
<?xml version="1.0" encoding="UTF-8"?> <LiveStreamInfo version="1.0" serializerVersion="1.1"> <Id>100</Id> <Width>960</Width> <Height>540</Height> <Bitrate>600000</Bitrate> <AudioBitrate>40000</AudioBitrate> <SegmentSize>10</SegmentSize> <MaxSegments>0</MaxSegments> <StartSegment>0</StartSegment> <CurrentSegment>10</CurrentSegment> <SegmentCount>10</SegmentCount> <PercentComplete>4</PercentComplete> <Created>2011-12-03T06:58:55</Created> <LastModified>2011-12-03T06:58:55</LastModified> <RelativeURL>/Content/GetFile?StorageGroup=Streaming&FileName=300.evo.0x540_600kV_40kA.m3u8</RelativeURL> <FullURL>http://192.168.0.99:6544/Content/GetFile?StorageGroup=Streaming&FileName=300.evo.0x540_600kV_40kA.m3u8</FullURL> <StatusStr>Queued</StatusStr> <StatusInt>0</StatusInt> <StatusMessage></StatusMessage> <SourceFile>/MythMedia/movies/300.evo</SourceFile> <SourceHost>Holmes</SourceHost> <SourceWidth>0</SourceWidth> <SourceHeight>0</SourceHeight> <AudioOnlyBitrate>32000</AudioOnlyBitrate> </LiveStreamInfo>
GetLiveStreamList
The GetLiveStreamList API takes no arguments.
Example Query:
http://BackendServerIP:6544/Content/GetLiveStreamList
Example Return:
<?xml version="1.0" encoding="UTF-8"?> <LiveStreamInfoList> <LiveStreamInfo> <Id>100</Id> <Width>960</Width> <Height>540</Height> <Bitrate>600000</Bitrate> <AudioBitrate>40000</AudioBitrate> <SegmentSize>10</SegmentSize> <MaxSegments>0</MaxSegments> <StartSegment>0</StartSegment> <CurrentSegment>10</CurrentSegment> <SegmentCount>10</SegmentCount> <PercentComplete>4</PercentComplete> <Created>2011-12-03T06:58:55</Created> <LastModified>2011-12-03T06:58:55</LastModified> <RelativeURL>/Content/GetFile?StorageGroup=Streaming&FileName=300.evo.0x540_600kV_40kA.m3u8</RelativeURL> <FullURL>http://192.168.0.99:6544/Content/GetFile?StorageGroup=Streaming&FileName=300.evo.0x540_600kV_40kA.m3u8</FullURL> <StatusStr>Queued</StatusStr> <StatusInt>0</StatusInt> <StatusMessage></StatusMessage> <SourceFile>/MythMedia/movies/300.evo</SourceFile> <SourceHost>Holmes</SourceHost> <SourceWidth>0</SourceWidth> <SourceHeight>0</SourceHeight> <AudioOnlyBitrate>32000</AudioOnlyBitrate> </LiveStreamInfo> <LiveStreamInfo> <Id>101</Id> <Width>0</Width> <Height>540</Height> <Bitrate>600000</Bitrate> <AudioBitrate>40000</AudioBitrate> <SegmentSize>10</SegmentSize> <MaxSegments>0</MaxSegments> <StartSegment>0</StartSegment> <CurrentSegment>0</CurrentSegment> <SegmentCount>0</SegmentCount> <PercentComplete>0</PercentComplete> <Created>2011-12-03T06:58:55</Created> <LastModified>2011-12-03T06:58:55</LastModified> <RelativeURL>/Content/GetFile?StorageGroup=Streaming&FileName=34736_20110926190000.mpg.0x540_600kV_40kA.m3u8</RelativeURL> <FullURL>http://192.168.0.99:6544/Content/GetFile?StorageGroup=Streaming&FileName=34736_20110926190000.mpg.0x540_600kV_40kA.m3u8</FullURL> <StatusStr>Queued</StatusStr> <StatusInt>0</StatusInt> <StatusMessage></StatusMessage> <SourceFile>/var/lib/mythtv/recordings/34736_20110926190000.mpg</SourceFile> <SourceHost>Holmes</SourceHost> <SourceWidth>0</SourceWidth> <SourceHeight>0</SourceHeight> <AudioOnlyBitrate>32000</AudioOnlyBitrate> </LiveStreamInfo> <LiveStreamInfoList>
GetFilteredLiveStreamList
The GetFilteredLiveStreamList API takes the following arguments:
- FileName (Required)
- Parameter Type: String
- The source filename, or a portion of a source filename, to narrow the list of returned LiveStreamInfos.
Example Query:
http://BackendServerIP:6544/Content/GetFilteredLiveStreamList?FileName=30
Example Return:
<?xml version="1.0" encoding="UTF-8"?> <LiveStreamInfoList> <LiveStreamInfo> <Id>100</Id> <Width>960</Width> <Height>540</Height> <Bitrate>600000</Bitrate> <AudioBitrate>40000</AudioBitrate> <SegmentSize>10</SegmentSize> <MaxSegments>0</MaxSegments> <StartSegment>0</StartSegment> <CurrentSegment>10</CurrentSegment> <SegmentCount>10</SegmentCount> <PercentComplete>4</PercentComplete> <Created>2011-12-03T06:58:55</Created> <LastModified>2011-12-03T06:58:55</LastModified> <RelativeURL>/Content/GetFile?StorageGroup=Streaming&FileName=300.evo.0x540_600kV_40kA.m3u8</RelativeURL> <FullURL>http://192.168.0.99:6544/Content/GetFile?StorageGroup=Streaming&FileName=300.evo.0x540_600kV_40kA.m3u8</FullURL> <StatusStr>Queued</StatusStr> <StatusInt>0</StatusInt> <StatusMessage></StatusMessage> <SourceFile>/MythMedia/movies/300.evo</SourceFile> <SourceHost>Holmes</SourceHost> <SourceWidth>0</SourceWidth> <SourceHeight>0</SourceHeight> <AudioOnlyBitrate>32000</AudioOnlyBitrate> </LiveStreamInfo> <LiveStreamInfoList>
RemoveLiveStream
The RemoveLiveStream API takes the following arguments:
- Id (Required)
- Parameter Type: String
- The database id for the live stream. This information is returned with the LiveStreamInfo from when adding a stream.
Example Query:
http://BackendServerIP:6544/Content/RemoveLiveStream?Id=100
Example Return:
<?xml version="1.0" encoding="UTF-8"?> <bool>true</bool>
StopLiveStream
The StopLiveStream API takes the following arguments:
- Id (Required)
- Parameter Type: String
- The database id for the live stream. This information is returned with the LiveStreamInfo from when adding a stream.
Example Query:
http://BackendServerIP:6544/Content/StopLiveStream?Id=100
Example Return:
<?xml version="1.0" encoding="UTF-8"?> <bool>true</bool>