Difference between revisions of "PlaybackHeartBeatLive"
Jump to navigation
Jump to search
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
| − | Description=Control that | + | Description=Control that 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 returns 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= | |Parameters= | ||
| Line 11: | Line 11: | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName=subscriptionId | + | ParamName=<s>subscriptionId</s> |
|ParamType=int | |ParamType=int | ||
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription=The subscriptionId that wants request the data. | + | |ParamDescription=<s>The subscriptionId that wants to request the data.</s> |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 58: | Line 58: | ||
|ParamDescription=heartbeat interval used in client application | |ParamDescription=heartbeat interval used in client application | ||
}} | }} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|Returns= | |Returns= | ||
Latest revision as of 06:25, 11 March 2025
Description
Control that 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 returns 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 to 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 |
