PlaybackHeartBeatVod - Revision history

Id02224 at 06:26, 11 March 2025

2025-03-11T06:26:12Z

Pcl245 at 09:20, 24 February 2016

2016-02-24T09:20:22Z

Rcalvo at 22:21, 4 August 2014

2014-08-04T22:21:41Z

Rcalvo at 22:18, 4 August 2014

2014-08-04T22:18:47Z

Rcalvo: 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..."

2014-08-04T21:43:19Z

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..."

New page

{{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.

|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=subscriptionId
|ParamType=int
|ParamRequired=optional
|ParamDescription=The subscriptionId that wants request the data.
}}
{{Api_Parameter|
ParamName=movieId
|ParamType=int
|ParamRequired=optional
|ParamDescription=Movie id
}}
{{Api_Parameter|
ParamName=mediaId
|ParamType=int
|ParamRequired=optional
|ParamDescription=Media 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= concurrenceToken
|ParamType=String
|ParamRequired=optional
|ParamDescription=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

|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"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}

|SeeAlso=
}}

@@ Line 2: / Line 2: @@
 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 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 returns 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.
@@ Line 21: / Line 21: @@
 }}
 {{Api_Parameter|
-ParamName=subscriptionId
+ParamName=<s>subscriptionId</s>
 |ParamType=int
 |ParamRequired=optional
-|ParamDescription=The subscriptionId that wants request the data.
+|ParamDescription=<s>The subscriptionId that wants to request the data.</s>
 }}
 {{Api_Parameter|

@@ Line 60: / Line 60: @@
 :    <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: #a11;">"Content"</span>: <span style="color: #219;">true</span>
+}

@@ Line 43: / Line 43: @@
 |ParamRequired=optional
 |ParamDescription=Current playback time to update resume info.
 }}