Razer Chroma SDK v4.0
Razer Chroma SDK Websocket Documentation
Create effects for Desktop

Creating effects on desktop by sending any one of the effect data below to the URI.

Remarks

Each parameters are different depending on the types of effect. Data parameters closely represented by the data structures in the C++ interface defined in RzChromaSDKTypes.h.


To turn off effect to set to Black color, use CHROMA_NONE

JSON Data

Field Description Type
"endpoint" Endpoint String
"effect" Effect type String
{
"endpoint":"devid=EB96AB11-E327-4BC0-B3E3-862BBB963B5D",
"effect": "CHROMA_NONE"
}

Response

Field Description Type
"result" Error code defined in RzErrors.h Number
{
"result" : 0
}

To create a static effect use CHROMA_STATIC and specify the color value.

Field Description Type
"endpoint" Endpoint String
"effect" Effect type String
"param" Effect definition Object
"color" Color value in BGR format Number
{
"endpoint":"devid=EB96AB11-E327-4BC0-B3E3-862BBB963B5D",
"effect": "CHROMA_STATIC",
"param": {
"color": 255
}
}

Response

Field Description Type
"result" Error code defined in RzErrors.h Number
{
"result" : 0
}

To create a custom effect use CHROMA_CUSTOM and fill in the colors in each element in the array.

JSON Data

Field Description Type
"endpoint" Endpoint String
"effect" Effect type. String
"param" 2 dimensional array of size 19 rows by 37 columns. Each cell containing the color value in BGR format Array
{
"endpoint":"devid=EB96AB11-E327-4BC0-B3E3-862BBB963B5D",
"effect":"CHROMA_CUSTOM",
"param":[
[ 255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255 ],
[ 65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280,65280 ],
[ 16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680,16711680 ],
[ 65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535,65535 ],
[ 16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960,16776960 ],
[ 16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935,16711935 ],
[ 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215 ],
[ 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D, 7D ],
[ 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000, 32000 ],
[ 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125, 32125 ],
[ 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000, 8192000 ],
[ 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125, 8192125 ],
[ 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000, 8224000 ],
[ 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125, 8224125 ],
[ 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64, 64 ]
[ 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384, 16384 ],
[ 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448, 16448 ],
[ 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304, 4194304 ]
[ 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368, 4194368 ]
]
}

Response

Field Description Type
"result" Please refer to RzError.h Number
{
"result" : 0
}