Difference between revisions of "PlaybackHeartBeatRecording"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Sets resume info in a Recording and controls concurrency in case device needs it The heartbeat method will be called every 'N' seconds. This pa...") |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 35: | Line 35: | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName= SubtitleCode |
|ParamType=String | |ParamType=String | ||
|ParamRequired=optional | |ParamRequired=optional | ||
| Line 41: | Line 41: | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName= AudioCode |
|ParamType=String | |ParamType=String | ||
|ParamRequired=optional | |ParamRequired=optional | ||
| Line 56: | Line 56: | ||
: <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: #219;"> | + | : <span style="color: #a11;">"Content"</span>: <span style="color: #219;">[[PlaybackResultObject]]</span> |
| + | |||
} | } | ||
Latest revision as of 13:54, 11 April 2019
Description
Sets resume info in a Recording and controls concurrency in case device needs it
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 statuscode !=0 the player should stop playing
It also sets the resume data of the recording
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.
- recordingId (int, required)
- Recording id
- playbackHeartBeat (int, optional)
- Heartbeat interval used in client application
- playbackTime (int, optional)
- Current playback time to update resume info.
- SubtitleCode (String, optional)
- Current Subtitles language used (ISO 639-2)
- AudioCode (String, optional)
- Current Audio Language code used (ISO 639-2)
Returns
Returns a JSON object StatusCode = 0 allowed, elsewhere deny
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content": PlaybackResultObject
}
Exceptions
Caching
This method is not cached.
Known issues
- None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 7.0 | Initial method design | José Manuel Escartín |
