Set PDF preview position
1. API Description
This API is used to set the PDF preview position.
Request mode:
- V2.6.0 and above: POST [ip]/mwapi/V2.0/layer-control/set-pdf-position
- V2.5.0 and below: POST [ip]/mwapi/set-pdf-position
Administrator Rights | Logged-in |
---|---|
No | Yes |
2. Input Parameters
Name | Required | Type | Description |
---|---|---|---|
showId | Yes | Int | Presentation ID, which can be obtained via Get presentation list |
sceneId | Yes | Int | Scene ID, which can be obtained via Get scene list |
layerId | Yes | Int | Layer ID, the layer position in the layer array |
pdfPosition | Int | PDF location information, (page number - 1) * 100. The preview image of the specified position can be obtained via http://[device IP]/pdf/[sourceId]/[pdfPosition] |
3. Output Parameters
Name | Type | Description |
---|---|---|
status | Int | Status code |
message | String | Status description |
4. Example
Previewing page 5 of the PDF in scene 105 of the presentation 2.
Input Example
{
"showId": 2,
"sceneId": 105,
"layerId": 0,
"pdfPosition": 400
}
Output Example
{
"message": "success",
"status": 0
}
5. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Status | Definition | Description |
---|---|---|
7 | MW_STATUS_INVALID_ARG | Missing required parameters |
16 | MW_STATUS_NOT_EXIST | The operated content does not exist |