Bureaucrats, editor
349
edits
Changes
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..."
{{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 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=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=recordingId
|ParamType=int
|ParamRequired=required
|ParamDescription=Recording id
}}
{{Api_Parameter|
ParamName= playbackHeartBeat
|ParamType=int
|ParamRequired=optional
|ParamDescription=Heartbeat interval used in client application
}}
{{Api_Parameter|
ParamName= playbackTime
|ParamType=int
|ParamRequired=optional
|ParamDescription=Current playback time to update resume info.
}}
{{Api_Parameter|
ParamName= SubtitlesLanguage
|ParamType=String
|ParamRequired=optional
|ParamDescription=Current Subtitles language used (ISO 639-2)
}}
{{Api_Parameter|
ParamName= AudioLanguage
|ParamType=String
|ParamRequired=optional
|ParamDescription=Current Audio Language code used (ISO 639-2)
}}
|Returns=
Returns a JSON object StatusCode = 0 allowed, elsewhere deny
'''Example:'''
{
: <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</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;">"Content"</span>: <span style="color: #219;">true</span>
}
|Exceptions=
* [[PlaybackNotAllowed]]
|Cache=
This method is not cached.
|KnownIssues=
* None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 7.0
{{!}} Initial method design
{{!}} José Manuel Escartín
{{!}}}
|SeeAlso=
}}
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=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=recordingId
|ParamType=int
|ParamRequired=required
|ParamDescription=Recording id
}}
{{Api_Parameter|
ParamName= playbackHeartBeat
|ParamType=int
|ParamRequired=optional
|ParamDescription=Heartbeat interval used in client application
}}
{{Api_Parameter|
ParamName= playbackTime
|ParamType=int
|ParamRequired=optional
|ParamDescription=Current playback time to update resume info.
}}
{{Api_Parameter|
ParamName= SubtitlesLanguage
|ParamType=String
|ParamRequired=optional
|ParamDescription=Current Subtitles language used (ISO 639-2)
}}
{{Api_Parameter|
ParamName= AudioLanguage
|ParamType=String
|ParamRequired=optional
|ParamDescription=Current Audio Language code used (ISO 639-2)
}}
|Returns=
Returns a JSON object StatusCode = 0 allowed, elsewhere deny
'''Example:'''
{
: <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</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;">"Content"</span>: <span style="color: #219;">true</span>
}
|Exceptions=
* [[PlaybackNotAllowed]]
|Cache=
This method is not cached.
|KnownIssues=
* None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 7.0
{{!}} Initial method design
{{!}} José Manuel Escartín
{{!}}}
|SeeAlso=
}}
