GetLiveChannel
Jump to navigation
Jump to search
Description
Returns a live channel (object LiveChannel) by its ID
Note: All methods returning channel lists are ordered by ChannelNumber and ID. That way it makes it easier for clients implementing channel up and down functionality based on channel lists
Parameters
- token (String, required)
- A valid token for identifying the API session context and logged user.
- liveChannelId (int, required)
- Live Channel ID
- imageWidth (int, optional)
- Width desired of image (default=0)
- imageHeight (int, optional)
- Height desired of image (default=0)
- adultFilter (AdultFilterType, optional)
- Adult filter to apply to the list (default = all)
Returns
Returns a JSON object with the LiveChannel.
Example:
{
- LiveChannel object
}
Exceptions
- InvalidLiveChannelException: If the liveChannelId provided doesn't exist.
Caching
This method is cached.
Known issues
None
Version history
API Version Number | Change description | Changes author |
---|---|---|
1.0 | Initial method design | Harley Cabral |
See also
- LiveChannel object type
- AdultFilterType object type
- Epg Service methods