PlaybackHeartBeatRecording

From Gvp-public
Jump to navigation Jump to search

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


See also