Difference between revisions of "PlaybackHeartBeatLive"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Control that a LIVE content is played in only one device at a time The heartbeat method will be called every N seconds. This parameter is config...") |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 57: | Line 57: | ||
|ParamRequired=optional | |ParamRequired=optional | ||
|ParamDescription=heartbeat interval used in client application | |ParamDescription=heartbeat interval used in client application | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
}} | }} | ||
| − | |||
|Returns= | |Returns= | ||
| Line 75: | Line 68: | ||
: <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>, | : <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>, | ||
: <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>, | : <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>, | ||
| − | : <span style="color: #a11;">"Content"</span>: | + | : <span style="color: #a11;">"Content"</span>: "<span style="color: #219;">Bool</span>" |
| − | |||
} | } | ||
Latest revision as of 09:20, 24 February 2016
Description
Control that a LIVE content is played in only one device at a time The heartbeat method will be called every N seconds. This parameter is configured for each OB on the table GVP_INSTANCES, column PLAYBACK_HEARTBEAT_INTERVAL. If the heartbeat method return NOK the player should retry calling the methods 3 times before showing a message to the user that the maximum number of devices are connected and that he was kicked out.
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- subscriptionId (int, optional)
- The subscriptionId that wants request the data.
- programName (String, optional)
- Current program name
- programId (int, optional)
- Current program id
- channelCallLetter (String, optional)
- Current channel call-letter
- channelId (int, optional)
- Current channel id
- liveStreamId (int, optional)
- Live Stream id
- liveStreamQualityName (String, optional)
- Current quality selected
- playbackHeartBeat (int, optional)
- heartbeat interval used in client application
Returns
Returns a JSON object containing TRUE = Playback is allowed, FALSE = Playback is denied.
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content": "Bool"
}
Exceptions
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 |
