Set Device Orientation and Resolution
PUT {{baseUrl}}/v1/device/:deviceUid/resolution
This method is used for setting device orientation and resolution. Just send desired orientation and resolution.
Parameters
Field | Type | Required | Description |
---|---|---|---|
deviceUid | string | required | device application id |
Body
content-type: application/json
or application/x-www-form-urlencoded
Recommended usage:
Field | Type | Description |
---|---|---|
orientation | string - ‘PORTRAIT’ ‘PORTRAITFLIPPED’ ’LANDSCAPE’ ‘LANDSCAPEFLIPPED’ ‘AUTO’ must be in uppercase | set device orientation to portrait, landscape or auto. Auto works only for tablets with gyroscope. |
size | JSON `{ width: 1920, height: 1080 }` | set specific device resolution, only for external players and devices supporting specific resolutions (BrightSign, Windows, selected Android players) To be used in combination with orientation field and possibly framerate field on supported device (BrightSign). resolution field needs to be omitted. |
framerate | number - 60 | specify exact video output framerate, only for BrightSign. To be used in combination with size and orientation field. |
Legacy usage:
Field | Type | Description |
---|---|---|
orientation | string - ‘PORTRAIT’ ‘PORTRAITFLIPPED’ ’LANDSCAPE’ ‘LANDSCAPEFLIPPED’ ‘AUTO’ must be in uppercase | set device orientation to portrait, landscape or auto. Auto works only for tablets with gyroscope. |
resolution | string ‘FULLHD’ ‘HDREADY’ must be in uppercase | set device resolution. Deprecated method to set resolution, framerate field is ignored if used in combination with this method |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
x-auth | string | Authorization key and token | |
Content-Type | string | ||
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{}