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

FieldTypeRequiredDescription
deviceUidstringrequireddevice application id

Body

content-type: application/json or application/x-www-form-urlencoded

Recommended usage:

FieldTypeDescription
orientationstring - ‘PORTRAIT’ ‘PORTRAITFLIPPED’ ’LANDSCAPE’ ‘LANDSCAPEFLIPPED’ ‘AUTO’ must be in uppercaseset device orientation to portrait, landscape or auto. Auto works only for tablets with gyroscope.
sizeJSON
`{ 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.
frameratenumber - 60specify exact video output framerate, only for BrightSign. To be used in combination with size and orientation field.

Legacy usage:

FieldTypeDescription
orientationstring - ‘PORTRAIT’ ‘PORTRAITFLIPPED’ ’LANDSCAPE’ ‘LANDSCAPEFLIPPED’ ‘AUTO’ must be in uppercaseset device orientation to portrait, landscape or auto. Auto works only for tablets with gyroscope.
resolutionstring ‘FULLHD’ ‘HDREADY’ must be in uppercaseset device resolution.
Deprecated method to set resolution, framerate field is ignored if used in combination with this method

HEADERS

KeyDatatypeRequiredDescription
x-authstringAuthorization key and token
Content-Typestring
Content-Typestring
Acceptstring

RESPONSES

status: OK

{}