Difference between revisions of "GetLiveChannelsPlayback"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Returns the list of live channels playback (as array of LiveChannelsPlayback objects), according to the playback type and ...") |
|||
| (4 intermediate revisions by one other user not shown) | |||
| Line 8: | Line 8: | ||
|ParamRequired=required | |ParamRequired=required | ||
|ParamDescription=A valid token for identifying the API session context and logged user. | |ParamDescription=A valid token for identifying the API session context and logged user. | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=channelMapId | ||
| + | |ParamType=int | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=ID of the channelMap | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 20: | Line 26: | ||
|ParamRequired=optional | |ParamRequired=optional | ||
|ParamDescription=Quantity of results showed, with the maximum of 100 | |ParamDescription=Quantity of results showed, with the maximum of 100 | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=imageWidth | ||
| + | |ParamType=int | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=Width desired of image (default=0) | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=imageHeight | ||
| + | |ParamType=int | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=Height desired of image (default=0) | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 32: | Line 50: | ||
|ParamRequired=optional | |ParamRequired=optional | ||
|ParamDescription=Adult filter to apply to the list (default = all) | |ParamDescription=Adult filter to apply to the list (default = all) | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName= deviceTypes | ||
| + | |ParamType=List of [[deviceType]] | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=List of deviceTypes separated by comma, to return the info of [[PlaybackInfo]]. | ||
}} | }} | ||
| Line 66: | Line 90: | ||
{{!}} Initial method design | {{!}} Initial method design | ||
{{!}} Harley Cabral | {{!}} Harley Cabral | ||
| + | {{!}}- valign="top" | ||
| + | ! 3.0 | ||
| + | {{!}} Added deviceTypes filter | ||
| + | {{!}} Alberto Los Santos | ||
| + | {{!}}- valign="top" | ||
| + | ! 3.2 | ||
| + | {{!}} Added channelMapId | ||
| + | {{!}} Pedro Caamaño | ||
{{!}}} | {{!}}} | ||
Latest revision as of 16:50, 9 February 2016
Description
Returns the list of live channels playback (as array of LiveChannelsPlayback objects), according to the playback type and adult filter.
Parameters
- token (String, required)
- A valid token for identifying the API session context and logged user.
- channelMapId (int, optional)
- ID of the channelMap
- offset (int, optional)
- Index of the initial result of the list, begins with 0
- limit (int, optional)
- Quantity of results showed, with the maximum of 100
- imageWidth (int, optional)
- Width desired of image (default=0)
- imageHeight (int, optional)
- Height desired of image (default=0)
- playbackType (PlaybackType, optional)
- Playback type
- adultFilter (AdultFilterType, optional)
- Adult filter to apply to the list (default = all)
- deviceTypes (List of deviceType, optional)
- List of deviceTypes separated by comma, to return the info of PlaybackInfo.
Returns
Returns a JSON object with a list of LiveChannelsPlayback.
Example:
{
- "Offset": 0,
- "Limit": 10,
- "Count": 48,
- [ Array of LiveChannelsPlayback objects ]
}
Exceptions
- None
Caching
This method is not cached.
Known issues
None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 1.0 | Initial method design | Harley Cabral |
| 3.0 | Added deviceTypes filter | Alberto Los Santos |
| 3.2 | Added channelMapId | Pedro Caamaño |
See also
- EpgLiveProgram object type
- LiveChannelsPlayback object type
- PlaybackType enumeration
- AdultFilterType enumeration
- Epg Service methods
