Layouts

Lighting resources interact with the canvas and currently playing effects. Here you can see the current effect, change it, change it’s preset, or iterate through all currently installed effects for the user.

Method	Endpoint
GET	scenes/current_layout
PATCH	scenes/current_layout
GET	scenes/layouts

Get Current Layout

Fetches information about the current Layout.

curl http://localhost:16038/api/v1/scenes/current_layout

{
    "api_version": "1.0",
    "data": {
        "current_layout": {
            "id": "My Layout 1",
            "type": "layout"
        }
    },
    "id": 10,
    "method": "/api/v1/scenes/current_layout",
    "params": {},
    "status": "ok"
}

Set Current Layout

Sets the currently active Layout.

curl -X PATCH -d "{\"layout\":\"My Layout 1\"}" http://localhost:16038/api/v1/scenes/current_layout

{
    "api_version": "1.0",
    "data": {
        "current_layout": {
            "id": "My Layout 1",
            "type": "layout"
        }
    },
    "id": 3,
    "method": "/api/v1/scenes/current_layout",
    "params": {
        "body": {
            "layout": "My Layout 1"
        }
    },
    "status": "ok"
}

Get All Layouts

Gets a list of all available Layouts the user has.

curl http://localhost:16038/api/v1/scenes/layouts

{
    "api_version": "1.0",
    "data": {
        "items": [
            {
                "id": "My Layout 1",
                "type": "layout"
            },
            {
                "id": "My Layout 2",
                "type": "layout"
            }
        ],
        "type": "layouts"
    },
    "id": 11,
    "method": "/api/v1/scenes/layouts",
    "params": {},
    "status": "ok"
}