Difference between revisions of "PlaybackHeartBeatVod"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| 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 configu...") |
|||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
| − | 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. | + | 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 (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= | |Parameters= | ||
| Line 11: | Line 15: | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=movieId |
|ParamType=int | |ParamType=int | ||
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription= | + | |ParamDescription=Movie id |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=subscriptionId |
|ParamType=int | |ParamType=int | ||
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription= | + | |ParamDescription=The subscriptionId that wants request the data. |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 39: | Line 43: | ||
|ParamRequired=optional | |ParamRequired=optional | ||
|ParamDescription=Current playback time to update resume info. | |ParamDescription=Current playback time to update resume info. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
}} | }} | ||
| Line 56: | Line 54: | ||
: <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;">true</span> |
| − | |||
} | } | ||
Latest revision as of 09:20, 24 February 2016
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 (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 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 |
