Difference between revisions of "GetLiveChannelUrl"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Returns the URL for a given live channel (and a streaming type and quality parameters) |Parameters= {{Api_Parameter| ParamName=token |ParamType=St...") |
|||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
Description=Returns the URL for a given live channel (and a streaming type and quality parameters) | Description=Returns the URL for a given live channel (and a streaming type and quality parameters) | ||
| + | |||
| + | This method has been modified to include a new input parameter DeviceType (optional, default = null) to be able to filter out by device type the different urls available for a Live channel. | ||
| + | |||
|Parameters= | |Parameters= | ||
| Line 27: | Line 30: | ||
|ParamDescription=Requested quality | |ParamDescription=Requested quality | ||
}} | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=includeExternal | ||
| + | |ParamType=bool | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=Set if API should consider external contents. | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=deviceType | ||
| + | |ParamType=[[DeviceType]] | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=Device Type | ||
| + | }} | ||
| + | |||
| + | |||
|Returns= | |Returns= | ||
| − | Returns a JSON object including the live channel URL. | + | Returns a JSON object including the live channel URL as a String. |
'''Example:''' | '''Example:''' | ||
| Line 57: | Line 74: | ||
! 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. | ||
| + | * deviceType (optional: default value: null) | ||
| + | {{!}} Ricardo Calvo | ||
| + | {{!}}- valign="top" | ||
| + | |||
| + | |||
{{!}}} | {{!}}} | ||
Revision as of 19:13, 25 March 2015
Description
Returns the URL for a given live channel (and a streaming type and quality parameters)
This method has been modified to include a new input parameter DeviceType (optional, default = null) to be able to filter out by device type the different urls available for a Live channel.
Parameters
- token (String, required)
- A valid token for identifying the API session context and logged user.
- liveChannelId (int, required)
- Live Channel ID
- streamingType (StreamingType, required)
- Requested Streaming Type
- quality (Quality, required)
- Requested quality
- includeExternal (bool, optional)
- Set if API should consider external contents.
- deviceType (DeviceType, optional)
- Device Type
Returns
Returns a JSON object including the live channel URL as a String.
Example:
{
- "Content": "http://www.telefonica.com...."
}
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
- StreamingType type
- Quality type
- Epg Service methods
