Difference between revisions of "GetUserAvailableStreams"
Jump to navigation
Jump to search
| (One intermediate revision by the same user not shown) | |||
| Line 21: | Line 21: | ||
|ParamDescription=Requested Streaming type | |ParamDescription=Requested Streaming type | ||
}} | }} | ||
| − | |||
{{Api_Parameter| | {{Api_Parameter| | ||
ParamName=includeExternal | ParamName=includeExternal | ||
| − | |ParamType= | + | |ParamType=bool |
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription=Set | + | |ParamDescription=Set if API should consider external contents. |
}} | }} | ||
| Line 61: | Line 60: | ||
{{!}} 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" | ||
| + | |||
{{!}}} | {{!}}} | ||
Latest revision as of 18:55, 25 March 2015
Description
Returns a list (as an array of LiveChannelStreams objects) of live channel streams for the provided Live Channel IDs and streaming type.
Parameters
- token (String, required)
- A valid token for identifying the API session context and logged user.
- liveChannelIds (array of ints, required)
- List of Live Channel ID
- streamingType (StreamingType, required)
- Requested Streaming type
- includeExternal (bool, optional)
- Set if API should consider external contents.
Returns
Returns a JSON object with the array of LiveChannelStreams.
Example:
{
- LiveChannelStreamsCollection: [
- Array of LiveChannelStreams objects
- ]
}
Exceptions
- None
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
- LiveChannelStreams type
- Quality type
- Epg Service methods
