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...") |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
| + | {{Deprecated|Message=This method has been deprecated in GVP 3.2. Please use [[GetUserAvailableStreams]] instead}} | ||
| + | |||
| + | |||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
Description=Returns an array of [[LiveStream|LiveStream]] with all the streams endpoints for the provided Live Channel ID | Description=Returns an array of [[LiveStream|LiveStream]] with all the streams endpoints for the provided Live Channel ID | ||
| Line 15: | Line 18: | ||
|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 54: | ||
! 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" | ||
| + | {{!}}- | ||
| + | ! 3.2 | ||
| + | {{!}} Method deprecated | ||
| + | {{!}} Francisco Milagro | ||
{{!}}} | {{!}}} | ||
| + | |||
|SeeAlso= | |SeeAlso= | ||
| Line 56: | Line 77: | ||
* [[StreamingType|StreamingType]] type | * [[StreamingType|StreamingType]] type | ||
* [[Quality|Quality]] type | * [[Quality|Quality]] type | ||
| + | * [[GetUserAvailableStreams]] method | ||
* [[UNIAPI_Specification#Epg_Service| Epg Service]] methods | * [[UNIAPI_Specification#Epg_Service| Epg Service]] methods | ||
}} | }} | ||
Latest revision as of 07:14, 21 August 2015
This method has been deprecated in GVP 3.2. Please use GetUserAvailableStreams instead
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 |
| 3.2 | Method deprecated | Francisco Milagro |
See also
- LiveChannel object type
- LiveStream type
- StreamingType type
- Quality type
- GetUserAvailableStreams method
- Epg Service methods
