Pencahayaan

Sumber pencahayaan berinteraksi dengan kanvas dan kesan yang sedang dimainkan. Di sini Anda boleh melihat kesan semasa, menukarnya, menukar praset, atau mengulang semua kesan yang dipasang pengguna.

Kaedah	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

Mendapatkan Kesan Semasa

Mendapatkan maklumat tentang kesan yang sedang dimainkan, kecerahan global, dan status main balik kanvas. Pautan self boleh digunakan untuk mendapatkan maklumat lanjut tentang kesan ini jika diperlukan.

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

Menetapkan Kecerahan Global

Menetapkan kecerahan global semasa.

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

Main/Jeda Kanvas

Menentukan sama ada kanvas sedang aktif. Jika dinyahaktifkan, semua peranti menerima hitam (#000000) untuk semua pertanyaan warna.

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

Mendapatkan Kesan yang Dipasang

Mengembalikan senarai semua kesan yang dipasang oleh pengguna.

• Disebabkan saiz payload yang berpotensi besar pada endpoint ini, bilangan panggilan harus diminimumkan.

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

Mendapatkan Maklumat Kesan

Mengembalikan maklumat terperinci tentang kesan tertentu.

• Jika ID kesan yang diberikan tidak wujud, endpoint ini mengembalikan ralat 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"
}

Mendapatkan Praset Kesan

Mengembalikan senarai praset yang tersedia untuk kesan ini.

• Jika ID kesan yang diberikan tidak wujud, endpoint ini mengembalikan ralat 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"
}

Menggunakan Praset Kesan

Menggunakan praset kesan sasaran untuk ID kesan yang diberikan.

• Jika ID kesan atau praset yang diberikan tidak wujud, endpoint ini mengembalikan ralat 404.

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

Menggunakan Kesan

Menggunakan ID kesan yang diberikan jika wujud.

• Jika ID kesan yang diberikan tidak wujud, endpoint ini mengembalikan ralat 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"
}

Mendapatkan Kesan Seterusnya

Mengembalikan maklumat tentang kesan seterusnya dalam sejarah, jika ada. Jika sejarah kesan tidak mengandungi kesan seterusnya, endpoint ini mengembalikan ralat 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

Menggunakan Kesan Seterusnya

Mensimulasikan operasi maju media untuk kesan yang sedang dimainkan. Jika tiada kesan seterusnya dalam sejarah, SignalRGB memilih kesan yang dipasang secara rawak yang bukan kesan integrasi permainan atau kesan pembangun.

Mengembalikan kesan yang baru digunakan.

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

Mendapatkan Kesan Sebelumnya

Mengembalikan maklumat tentang kesan sebelumnya dalam sejarah, jika ada. Jika sejarah kesan tidak mengandungi kesan sebelumnya, endpoint ini mengembalikan ralat 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"
}

Menggunakan Kesan Sebelumnya

Mensimulasikan operasi undur media untuk kesan yang sedang dimainkan. Jika tiada kesan sebelumnya dalam sejarah, endpoint ini mengembalikan ralat 409.

Mengembalikan kesan yang baru digunakan.

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

Menggunakan Kesan Rawak

Mensimulasikan operasi kocok media untuk kesan yang sedang dimainkan. SignalRGB memilih kesan yang dipasang secara rawak yang bukan kesan integrasi permainan atau kesan pembangun.

Mengembalikan kesan yang baru digunakan.

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