Lighting

Lighting-ressourcer interagerer med canvas’et og de aktuelt afspillede effekter. Her kan du se den aktuelle effekt, skifte den, ændre dens preset eller gennemgå alle brugerens aktuelt installerede effekter.

Metode	Endepunkt
GET	lighting
PATCH	lighting/global_brightness
PATCH	lighting/enabled
GET	lighting/effects
GET	lighting/effect/:id
GET	lighting/effect/:id/presets
PATCH	lighting/effect/:id/presets
POST	lighting/effect/:id/apply
GET	lighting/next
POST	lighting/next
GET	lighting/previous
POST	lighting/previous
POST	lighting/shuffle

Hent aktuel effekt

Henter oplysninger om den aktuelt afspillede effekt, den globale lysstyrke og canvas-afspilningsstatus. Self-linket kan bruges til at hente yderligere oplysninger om denne effekt efter behov.

curl http://localhost:16038/api/v1/lighting

{
    "api_version": "1.0",
    "data": {
        "attributes": {
            "enabled": true,
            "global_brightness": 50,
            "name": "Neon Shift"
        },
        "id": "Neon Shift.html",
        "links": {
            "self": "/api/v1/lighting/effects/Neon Shift.html"
        },
        "type": "current_effect"
    },
    "id": 6,
    "method": "/api/v1/lighting",
    "params": {},
    "status": "ok"
}

Sæt global lysstyrke

Sætter den aktuelle globale lysstyrke.

curl -X PATCH -d "{\"global_brightness\":73}" http://localhost:16038/api/v1/lighting/global_brightness

{
    "api_version": "1.0",
    "data": {
        "attributes": {
            "enabled": true,
            "global_brightness": 73
        },
        "type": "effect"
    },
    "id": 3,
    "method": "/api/v1/lighting/global_brightness",
    "params": {
        "body": {
            "global_brightness": 73
        }
    },
    "status": "ok"
}

Afspil/sæt canvas på pause

Angiver om canvas’et er aktivt. Hvis deaktiveret, modtager alle enheder sort (#000000) for alle farveforespørgsler.

curl -X PATCH -d "{\"enabled\":false}" http://localhost:16038/api/v1/lighting/enabled

{
    "api_version": "1.0",
    "data": {
        "attributes": {
            "enabled": false,
            "global_brightness": 73
        },
        "type": "effect"
    },
    "id": 4,
    "method": "/api/v1/lighting/enabled",
    "params": {
        "body": {
            "enabled": false
        }
    },
    "status": "ok"
}

Hent installerede effekter

Returnerer en liste over alle brugerens installerede effekter.

• På grund af den potentielle payload-størrelse for dette endepunkt bør antallet af kald holdes så lavt som muligt.

curl http://localhost:16038/api/v1/lighting/effects

{
    "apiVersion": "1.0",
    "data": {
        "items": [
            {
                "attributes": {
                    "name": " Wolfenstein II: TNC"
                },
                "id": "-MQtFeX-o2hMR6sv8aFr",
                "links": {
                    "apply": "/api/v1/lighting/effects/-MQtFeX-o2hMR6sv8aFr/apply",
                    "self": "/api/v1/lighting/effects/-MQtFeX-o2hMR6sv8aFr"
                },
                "type": "effect"
            },
            {
                "attributes": {
                    "name": "4th Dimension"
                },
                "id": "-N-YhDDs2ZIGJ42azDgJ",
                "links": {
                    "apply": "/api/v1/lighting/effects/-N-YhDDs2ZIGJ42azDgJ/apply",
                    "self": "/api/v1/lighting/effects/-N-YhDDs2ZIGJ42azDgJ"
                },
                "type": "effect"
            },
          ...
        ],
        "type": "effects"
    },
    "id": 7,
    "method": "/api/v1/lighting/effects",
    "params": {},
    "status": "ok"
}

Hent effektoplysninger

Returnerer detaljerede oplysninger om en bestemt effekt.

• Hvis den angivne effekt-ID ikke eksisterer, returnerer dette endepunkt en 404-fejl.

curl http://localhost:16038/api/v1/lighting/effects/-Mg1qujV9F4rabJxlSOS

{
    "api_version": "1.0",
    "data": {
        "attributes": {
            "description": "A colorful drizzle of softly moving lines.",
            "developer_effect": false,
            "image": "https://imagedelivery.net/uPA_EtOZxmT3DaI0aRG2mQ/-Mg1qujV9F4rabJxlSOS/main/dashcard",
            "name": "Drizzle",
            "parameters": {
                "backColorMode": {
                    "label": "Background Color Mode",
                    "type": "combobox",
                    "value": "Static"
                },
                "backHue": {
                    "label": "Background Color (Static)",
                    "type": "color",
                    "value": "#320056"
                },
                "confHue": {
                    "label": "Line Color (Static)",
                    "type": "color",
                    "value": "#ff0000"
                },
                "confLength": {
                    "label": "Line Length",
                    "type": "number",
                    "value": 70
                }
            },
            "publisher": "SignalRGB",
            "uses_audio": false,
            "uses_input": false,
            "uses_meters": false,
            "uses_video": false
        },
        "id": "-Mg1qujV9F4rabJxlSOS",
        "links": {
            "apply": "/api/v1/lighting/effects/-Mg1qujV9F4rabJxlSOS/apply",
            "self": "/api/v1/lighting/effects/-Mg1qujV9F4rabJxlSOS"
        },
        "type": "effect"
    },
    "id": 1,
    "method": "/api/v1/lighting/effects/-Mg1qujV9F4rabJxlSOS",
    "params": {
        "id": "-Mg1qujV9F4rabJxlSOS"
    },
    "status": "ok"
}

{
    "api_version": "1.0",
    "errors": [
        {
            "code": "404",
            "detail": "The requested effect was not found",
            "title": "Not Found"
        }
    ],
    "id": 2,
    "method": "/api/v1/lighting/effects/-Mg1qujV9F4rabJxlSO",
    "params": {
        "id": "-Mg1qujV9F4rabJxlSO"
    },
    "status": "error"
}

Hent effekt-presets

Returnerer en liste over tilgængelige presets for denne effekt.

• Hvis den angivne effekt-ID ikke eksisterer, returnerer dette endepunkt en 404-fejl.

curl http://localhost:16038/api/v1/lighting/effects/-Mg1qujV9F4rabJxlSOS/presets

{
    "api_version": "1.0",
    "data": {
        "id": "-Mg1qujV9F4rabJxlSOS",
        "items": [
            {
                "id": "My Fancy Preset 1",
                "type": "preset"
            },
            {
                "id": "My Other Preset",
                "type": "preset"
            }
        ],
        "type": "presets"
    },
    "id": 1,
    "method": "/api/v1/lighting/effects/-Mg1qujV9F4rabJxlSOS/presets",
    "params": {
        "id": "-Mg1qujV9F4rabJxlSOS"
    },
    "status": "ok"
}

{
    "api_version": "1.0",
    "errors": [
        {
            "code": "404",
            "detail": "The requested effect was not found",
            "title": "Not Found"
        }
    ],
    "id": 4,
    "method": "/api/v1/lighting/effects/-Mg1qujV9F4rabJxlSS/presets",
    "params": {
        "id": "-Mg1qujV9F4rabJxlSS"
    },
    "status": "error"
}

Anvend effekt-preset

Anvender mål-effekt-preset’et for den angivne effekt-ID.

• Hvis den angivne effekt-ID eller preset’et ikke eksisterer, returnerer dette endepunkt en 404-fejl.

curl -X PATCH -d "{\"preset\":\"My Fancy Preset 1\"}" http://localhost:16038/api/v1/lighting/effects/-Mg1qujV9F4rabJxlSOS/presets

Anvend effekt

Anvender den angivne effekt-ID, hvis den eksisterer.

• Hvis den angivne effekt-ID ikke eksisterer, returnerer dette endepunkt en 404-fejl.

curl -X POST http://localhost:16038/api/v1/lighting/effects/-Mg1qujV9F4rabJxlSOS/apply

{
    "api_version": "1.0",
    "id": 3,
    "method": "/api/v1/lighting/effects/-Mg1qujV9F4rabJxlSOS/apply",
    "params": {
        "id": "-Mg1qujV9F4rabJxlSOS"
    },
    "status": "ok"
}

{
    "api_version": "1.0",
    "errors": [
        {
            "code": "404",
            "detail": "The requested effect was not found",
            "title": "Not Found"
        }
    ],
    "id": 4,
    "method": "/api/v1/lighting/effects/-Mg1qujV9F4rabJxlSS/apply",
    "params": {
        "id": "-Mg1qujV9F4rabJxlSS"
    },
    "status": "error"
}

Hent næste effekt

Returnerer oplysninger om den næste effekt i historikken, hvis tilgængelig. Hvis effekthistorikken ikke indeholder en næste effekt, returnerer dette endepunkt en 409-fejl.

curl http://localhost:16038/api/v1/lighting/next

{
    "api_version": "1.0",
    "data": {
        "attributes": {
            "name": "Drizzle"
        },
        "id": "-Mg1qujV9F4rabJxlSOS",
        "links": {
            "self": "/api/v1/lighting/effects/-Mg1qujV9F4rabJxlSOS"
        },
        "type": "effect"
    },
    "id": 5,
    "method": "/api/v1/lighting/next",
    "params": {},
    "status": "ok"
}

{
    "api_version": "1.0",
    "errors": [
        {
            "code": "409",
            "detail": "Effect History doesn't contain a next effect",
            "title": "No Next Effect"
        }
    ],
    "id": 24,
    "method": "/api/v1/lighting/next",
    "params": {},
    "status": "error"
}

Anvend næste effekt

Simulerer en medie-fremspol-operation for den aktuelt afspillede effekt. Hvis der ikke er nogen næste effekt i historikken, vælger SignalRGB en tilfældig installeret effekt, der ikke er en spilintegrations- eller udviklingseffekt.

Returnerer den nyligt anvendte effekt.

curl -X POST http://localhost:16038/api/v1/lighting/next

{
    "api_version": "1.0",
    "data": {
        "attributes": {
            "name": "Drizzle"
        },
        "id": "-Mg1qujV9F4rabJxlSOS",
        "links": {
            "self": "/api/v1/lighting/effects/-Mg1qujV9F4rabJxlSOS"
        },
        "type": "effect"
    },
    "id": 5,
    "method": "/api/v1/lighting/next",
    "params": {},
    "status": "ok"
}

{
    "api_version": "1.0",
    "errors": [
        {
            "code": "409",
            "detail": "Effect History doesn't contain a next effect",
            "title": "No Next Effect"
        }
    ],
    "id": 24,
    "method": "/api/v1/lighting/next",
    "params": {},
    "status": "error"
}

Hent forrige effekt

Returnerer oplysninger om den forrige effekt i historikken, hvis tilgængelig. Hvis effekthistorikken ikke indeholder en forrige effekt, returnerer dette endepunkt en 409-fejl.

curl http://localhost:16038/api/v1/lighting/previous

{
    "api_version": "1.0",
    "data": {
        "attributes": {
            "name": "Gradient Generator"
        },
        "id": "-MA7wCKkv_359cmwPOEK",
        "links": {
            "self": "/api/v1/lighting/effects/-MA7wCKkv_359cmwPOEK"
        },
        "type": "effect"
    },
    "id": 7,
    "method": "/api/v1/lighting/previous",
    "params": {},
    "status": "ok"
}

{
    "api_version": "1.0",
    "errors": [
        {
            "code": "409",
            "detail": "Effect History doesn't contain a previous effect",
            "title": "No Previous Effect"
        }
    ],
    "id": 15,
    "method": "/api/v1/lighting/previous",
    "params": {},
    "status": "error"
}

Anvend forrige effekt

Simulerer en medie-tilbagespoling-operation for den aktuelt afspillede effekt. Hvis der ikke er nogen forrige effekt i historikken, returnerer dette endepunkt en 409-fejl.

Returnerer den nyligt anvendte effekt.

curl -X POST http://localhost:16038/api/v1/lighting/previous

{
    "api_version": "1.0",
    "data": {
        "attributes": {
            "name": "Gradient Generator"
        },
        "id": "-MA7wCKkv_359cmwPOEK",
        "links": {
            "self": "/api/v1/lighting/effects/-MA7wCKkv_359cmwPOEK"
        },
        "type": "effect"
    },
    "id": 7,
    "method": "/api/v1/lighting/previous",
    "params": {},
    "status": "ok"
}

{
    "api_version": "1.0",
    "errors": [
        {
            "code": "409",
            "detail": "Effect History doesn't contain a previous effect",
            "title": "No Previous Effect"
        }
    ],
    "id": 15,
    "method": "/api/v1/lighting/previous",
    "params": {},
    "status": "error"
}

Anvend tilfældig effekt

Simulerer en medie-shuffle-operation for den aktuelt afspillede effekt. SignalRGB vælger en tilfældig installeret effekt, der ikke er en spilintegrations- eller udviklingseffekt.

Returnerer den nyligt anvendte effekt.

curl -X POST http://localhost:16038/api/v1/lighting/shuffle

{
    "api_version": "1.0",
    "data": {
        "attributes": {
            "name": "Borealis"
        },
        "id": "-N1LC8HkC4fZ6IlFA30j",
        "links": {
            "self": "/api/v1/lighting/effects/-N1LC8HkC4fZ6IlFA30j"
        },
        "type": "effect"
    },
    "id": 6,
    "method": "/api/v1/lighting/shuffle",
    "params": {},
    "status": "ok"
}