Difference between revisions of "PlaybackHeartBeatVod"
Jump to navigation
Jump to search
| Line 2: | Line 2: | ||
Description=Control that a VOD content is played in only one device at a time. | Description=Control that a VOD 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 | + | 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 (total of 3 times) before showing a message to the user that the maximum number of devices are connected and that he was kicked out. |
The order to kicked out the device is configured by the instance on the MIB. | The order to kicked out the device is configured by the instance on the MIB. | ||
| Line 21: | Line 21: | ||
}} | }} | ||
{{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| | ||
Latest revision as of 06:26, 11 March 2025
Description
Control that a VOD 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 (total of 3 times) before showing a message to the user that the maximum number of devices are connected and that he was kicked out.
The order to kicked out the device is configured by the instance on the MIB.
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- movieId (int, optional)
- Movie id
subscriptionId(int, optional)
The subscriptionId that wants to request the data.
- mediaId (int, optional)
- Media Id.
- playbackHeartBeat (int, optional)
- Heartbeat interval used in client application
- playbackTime (int, optional)
- Current playback time to update resume info.
Returns
Returns a JSON object containing TRUE = Playback is allowed, FALSE = Playback is denied.
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content": true
}
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 |
