Skip to content

getSpanGeometryAndPreparation

GET
/api/v1/screen-groups/{id}/span
curl --request GET \
--url https://example.com/api/v1/screen-groups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/span

Get span geometry and preparation. Requires an authenticated dashboard user.

id
required
string format: uuid

Canvas, panel geometry, and preparation status

Media typeapplication/json
object
data
required
object
groupId
required
string format: uuid
displayMode
required
string
Allowed values: mirror span
geometry
required
object
canvas
required
object
width
required
integer
>= 1
height
required
integer
>= 1
panels
required
Array<object>
object
screenId
required
string format: uuid
screenName
string
order
required
integer
<= 63
x
required
integer
y
required
integer
width
required
integer
>= 1
height
required
integer
>= 1
rotation
required
integer
Allowed values: 0 90 180 270
bezelLeft
integer
<= 500
bezelTop
integer
<= 500
bezelRight
integer
<= 500
bezelBottom
integer
<= 500
preparations
required
Array<object>
object
id
required
string format: uuid
screenId
required
string format: uuid
sourceAssetId
required
string format: uuid
sourceVariantId
required
string format: uuid
status
required
string
Allowed values: queued processing ready failed
progress
number
<= 1
width
integer
>= 1
height
integer
>= 1
durationSeconds
number
frameRate
number
errorCode
string
errorMessage
string
updatedAt
required
string
Example
{
"data": {
"displayMode": "mirror",
"geometry": {
"panels": [
{
"rotation": 0
}
]
},
"preparations": [
{
"status": "queued"
}
]
}
}