Difference between revisions of "GetUserAvailableStreams"

From Gvp-public
Jump to navigation Jump to search
 
Line 21: Line 21:
 
|ParamDescription=Requested Streaming type
 
|ParamDescription=Requested Streaming type
 
}}
 
}}
 
 
{{Api_Parameter|
 
{{Api_Parameter|
 
ParamName=includeExternal
 
ParamName=includeExternal
Line 63: Line 62:
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
! 1.0
+
! 3.0
 
{{!}} Added parameter:
 
{{!}} Added parameter:
* includeExternal (true|false) - Default is FALSE.
+
* includeExternal (true/false) - Default is FALSE.
 
{{!}} Ricardo Calvo
 
{{!}} Ricardo Calvo
 
{{!}}- valign="top"
 
{{!}}- 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
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:
  • includeExternal (true/false) - Default is FALSE.
Ricardo Calvo


See also