Difference between revisions of "SetItemResumeData"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Set the resume information for the item playback of the user. This information is used to set on the GVP the exactly time watched by the user sh...") |
|||
| (3 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
Description=Set the resume information for the item playback of the user. This information is used to set on the GVP the exactly time watched by the user should be storage on the platform. This feature allow the client application restart the reproduction from the moment that he stopped. | Description=Set the resume information for the item playback of the user. This information is used to set on the GVP the exactly time watched by the user should be storage on the platform. This feature allow the client application restart the reproduction from the moment that he stopped. | ||
| − | This method has two optional parameter that can be used to storage the currently subtitle and audio. | + | This method has two optional parameter that can be used to storage the currently subtitle and audio. ISO-639-2 Fromat |
|Parameters= | |Parameters= | ||
| Line 10: | Line 10: | ||
|ParamType=String | |ParamType=String | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription=A valid token for identifying the API session context. The token | + | |ParamDescription=A valid token for identifying the API session context. The token has to be logged-in user. |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 20: | Line 20: | ||
{{Api_Parameter| | {{Api_Parameter| | ||
ParamName=ItemType | ParamName=ItemType | ||
| − | |ParamType=[[ | + | |ParamType=[[ItemType]] enum |
|ParamRequired=required | |ParamRequired=required | ||
|ParamDescription=ItemType | |ParamDescription=ItemType | ||
| Line 53: | Line 53: | ||
: <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</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;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>, | ||
| − | : <span style="color: #a11;">"Content"</span>: | + | : <span style="color: #a11;">"Content"</span>: [[ActionExecutedObject]] |
} | } | ||
Latest revision as of 15:36, 5 June 2019
Description
Set the resume information for the item playback of the user. This information is used to set on the GVP the exactly time watched by the user should be storage on the platform. This feature allow the client application restart the reproduction from the moment that he stopped.
This method has two optional parameter that can be used to storage the currently subtitle and audio. ISO-639-2 Fromat
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token has to be logged-in user.
- ItemId (int, required)
- Id of the resume information
- ItemType (ItemType enum, required)
- ItemType
- time (int, required)
- Current playback time in seconds (optional) (-1 when the movie is ended)
- subtitleCode (String, optional)
- Current Subtitle Language Code ISO-639-2
- audioCode (String, optional)
- Current Audio Language Code ISO-639-2
Returns
Returns a JSON object containing true if change was made, false if no change was made.
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content": ActionExecutedObject
}
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 |
