Difference between revisions of "GetLiveChannelUrlList"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Returns an array of LiveStream with all the streams endpoints for the provided Live Channel ID |Parameters= {{Api_Parameter| ParamN...") |
|||
| Line 15: | Line 15: | ||
|ParamDescription=Live Channel ID | |ParamDescription=Live Channel ID | ||
}} | }} | ||
| − | + | {{Api_Parameter| | |
| + | ParamName=includeExternal | ||
| + | |ParamType=bool | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=Set if API should consider external contents. | ||
| + | }} | ||
|Returns= | |Returns= | ||
| − | Returns a JSON object with the array of [[ | + | Returns a JSON object with the array of [[LiveStream]]. |
'''Example:''' | '''Example:''' | ||
{ | { | ||
| − | : [ Array of [[ | + | : [ Array of [[LiveStream]] objects ] |
} | } | ||
| Line 46: | Line 51: | ||
! Changes author | ! Changes author | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
| + | |||
! 1.0 | ! 1.0 | ||
{{!}} Initial method design | {{!}} Initial method design | ||
{{!}} Harley Cabral | {{!}} Harley Cabral | ||
| + | {{!}}- valign="top" | ||
| + | |||
| + | ! 3.0 | ||
| + | {{!}} Added parameter: | ||
| + | * includeExternal (true/false) - Default is FALSE. | ||
| + | {{!}} Ricardo Calvo | ||
| + | {{!}}- valign="top" | ||
{{!}}} | {{!}}} | ||
Revision as of 19:08, 25 March 2015
Description
Returns an array of LiveStream with all the streams endpoints for the provided Live Channel ID
Parameters
- token (String, required)
- A valid token for identifying the API session context and logged user.
- liveChannelId (int, required)
- Live Channel ID
- includeExternal (bool, optional)
- Set if API should consider external contents.
Returns
Returns a JSON object with the array of LiveStream.
Example:
{
- [ Array of LiveStream objects ]
}
Exceptions
- InvalidChannelException: If the Channel Id provided doesn't exist.
- MovieNotPlayableByDeviceTypeException: If the content is not playable by the user device.
- LiveChannelNotPurchasedException: If the live channel is not purchased by user.
Caching
This method is cached.
Known issues
None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 1.0 | Initial method design | Harley Cabral |
| 3.0 | Added parameter:
|
Ricardo Calvo |
See also
- LiveChannel object type
- LiveStream type
- StreamingType type
- Quality type
- Epg Service methods
