Difference between revisions of "AddEventPlayback"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |ParamDescription=A valid token for identifying the ...") |
|||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
| − | Description= | + | Description=The devices send events to the UNIAPI EventService to collect Playback events. They call to the addEventPlayback method to send this playback events. |
| + | This events are sent only in the Player so it's related to VoD and Live contents and related to the HeartBeat event. In case of VoD contents, two kinds of request are made to register events in the platform: AddEventPlayback to register the analytics events and the events for the PlaybackHeartBeat control. In case of an OB has the PlaybackHeartBeat deactivated, and the device's play the Live content, the events for the Analytics won't be registered. | ||
| Line 12: | Line 13: | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=playbackEventType |
| − | |ParamType= | + | |ParamType= |
| − | |ParamRequired= | + | |ParamRequired= |
| − | |ParamDescription= | + | |ParamDescription= |
| − | + | }} | |
| − | + | {{Api_Parameter| | |
| − | + | ParamName=contentId | |
| − | + | |ParamType= | |
| − | + | |ParamRequired= | |
| − | + | |ParamDescription= | |
| − | + | }} | |
| − | + | {{Api_Parameter| | |
| − | + | ParamName=contentType | |
| − | + | |ParamType= | |
| − | + | |ParamRequired= | |
| − | + | |ParamDescription= | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=errorMessage |
| − | |ParamType= | + | |ParamType= |
| − | |ParamRequired= | + | |ParamRequired= |
| − | |ParamDescription= | + | |ParamDescription= |
| − | |||
| − | |||
}} | }} | ||
| − | |||
Revision as of 15:46, 11 July 2014
Description
The devices send events to the UNIAPI EventService to collect Playback events. They call to the addEventPlayback method to send this playback events.
This events are sent only in the Player so it's related to VoD and Live contents and related to the HeartBeat event. In case of VoD contents, two kinds of request are made to register events in the platform: AddEventPlayback to register the analytics events and the events for the PlaybackHeartBeat control. In case of an OB has the PlaybackHeartBeat deactivated, and the device's play the Live content, the events for the Analytics won't be registered.
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- playbackEventType (, )
- contentId (, )
- contentType (, )
- errorMessage (, )
Returns
Returns a JSON object containing the information if the event is registered on server.
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content": true
}
Exceptions
None
Caching
This method is not cached.
Known issues
None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 1.0 | Initial method design | Harley Cabral |
| 2.4 | Ricardo Calvo
|
