editor
725
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description=Control that a LIVE content is played in only one device at a time The heartbeat method will be called every N seconds. This parameter is config..."
{{Api_Method_Spec|
Description=Control that a LIVE 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= programName
|ParamType=String
|ParamRequired=optional
|ParamDescription=Current program name
}}
{{Api_Parameter|
ParamName=programId
|ParamType=int
|ParamRequired=optional
|ParamDescription= Current program id
}}
{{Api_Parameter|
ParamName=channelCallLetter
|ParamType=String
|ParamRequired=optional
|ParamDescription=Current channel call-letter
}}
{{Api_Parameter|
ParamName=channelId
|ParamType=int
|ParamRequired=optional
|ParamDescription= Current channel id
}}
{{Api_Parameter|
ParamName=liveStreamId
|ParamType=int
|ParamRequired=optional
|ParamDescription=Live Stream id
}}
{{Api_Parameter|
ParamName= liveStreamQualityName
|ParamType=String
|ParamRequired=optional
|ParamDescription=Current quality selected
}}
{{Api_Parameter|
ParamName= playbackHeartBeat
|ParamType=int
|ParamRequired=optional
|ParamDescription=heartbeat interval used in client application
}}
{{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:'''
{
: <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;">Bool</span> }
}
|Exceptions=
* [[ConcurrenceNotAvailableException]]
* [[MongoConnectionException]]
|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=
}}
Description=Control that a LIVE 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= programName
|ParamType=String
|ParamRequired=optional
|ParamDescription=Current program name
}}
{{Api_Parameter|
ParamName=programId
|ParamType=int
|ParamRequired=optional
|ParamDescription= Current program id
}}
{{Api_Parameter|
ParamName=channelCallLetter
|ParamType=String
|ParamRequired=optional
|ParamDescription=Current channel call-letter
}}
{{Api_Parameter|
ParamName=channelId
|ParamType=int
|ParamRequired=optional
|ParamDescription= Current channel id
}}
{{Api_Parameter|
ParamName=liveStreamId
|ParamType=int
|ParamRequired=optional
|ParamDescription=Live Stream id
}}
{{Api_Parameter|
ParamName= liveStreamQualityName
|ParamType=String
|ParamRequired=optional
|ParamDescription=Current quality selected
}}
{{Api_Parameter|
ParamName= playbackHeartBeat
|ParamType=int
|ParamRequired=optional
|ParamDescription=heartbeat interval used in client application
}}
{{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:'''
{
: <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;">Bool</span> }
}
|Exceptions=
* [[ConcurrenceNotAvailableException]]
* [[MongoConnectionException]]
|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=
}}
