Iluminação

Os recursos de iluminação interagem com o canvas e os efeitos em reprodução no momento. Aqui você pode ver o efeito atual, alterá-lo, mudar seu preset ou iterar por todos os efeitos instalados pelo usuário.

Método	Endpoint
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

Obter Efeito Atual

Busca informações sobre o efeito em reprodução no momento, o Brilho Global e o Estado de Reprodução do Canvas. O link self pode ser usado para obter mais informações sobre este efeito, se desejado.

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"
}

Definir Brilho Global

Define o Brilho Global atual.

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"
}

Reproduzir/Pausar Canvas

Define se o Canvas está ativo no momento. Quando desativado, todos os dispositivos receberão preto (#000000) para todas as solicitações de cor.

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"
}

Obter Efeitos Instalados

Retorna uma lista de todos os efeitos instalados pelo usuário.

• Dado o tamanho potencial do payload deste endpoint, tome cuidado para reduzir o número de chamadas a ele.

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"
}

Obter Informações do Efeito

Retorna informações detalhadas sobre um efeito específico.

• Se o id do efeito fornecido não existir, este endpoint retornará um erro 404.

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"
}

Obter Presets do Efeito

Retorna uma lista de Presets disponíveis para este efeito.

• Se o id do efeito fornecido não existir, este endpoint retornará um erro 404.

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"
}

Aplicar Preset do Efeito

Aplica o preset de efeito alvo para o id de efeito fornecido.

• Se o id do efeito ou o preset fornecido não existir, este endpoint retornará um erro 404.

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

Aplicar Efeito

Aplica o id de efeito fornecido, se existir.

• Se o id do efeito fornecido não existir, este endpoint retornará um erro 404.

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"
}

Obter Próximo Efeito

Retorna informações sobre o próximo efeito no histórico, se disponível. Se o histórico de efeitos não contiver um próximo efeito, este endpoint retornará um erro 409.

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"
}// Click to edit code

Aplicar Próximo Efeito

Simula uma operação de Avanço Rápido de Mídia no efeito em reprodução no momento. Se não houver um próximo efeito no histórico, o SignalRGB vai embaralhar um efeito instalado aleatório, que não seja de integração com jogo nem de desenvolvedor.

Retorna o efeito recém-aplicado.

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"
}

Obter Efeito Anterior

Retorna informações sobre o efeito anterior no histórico, se disponível. Se o histórico de efeitos não contiver um efeito anterior, este endpoint retornará um erro 409.

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"
}

Aplicar Efeito Anterior

Simula uma operação de Retroceder Mídia no efeito em reprodução no momento. Se não houver um efeito anterior no histórico, retornará um erro 409.

Retorna o efeito recém-aplicado.

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"
}

Aplicar Efeito Aleatório

Simula uma operação de Embaralhar Mídia no efeito em reprodução no momento. O SignalRGB vai embaralhar um efeito instalado aleatório, que não seja de integração com jogo nem de desenvolvedor.

Retorna o efeito recém-aplicado.

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"
}