PlaybackHeartBeatVod
Jump to navigation
Jump to search
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 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.
- movieId (int, optional)
- Movie id
- mediaId (int, optional)
- Media Id.
- playbackHeartBeat (int, optional)
- Heartbeat interval used in client application
- playbackTime (int, optional)
- Current playback time to update resume info.
- concurrenceToken (String, optional)
- Concurrence token bound to current playback session.
Returns
Returns a JSON object containing TRUE = Playback is allowed, FALSE = Playback is denied.
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content":
- { Bool }
}
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 |