Port | 7580 |
not recommended to change |
The settings for this are under Settings
-> WebSocket Server
, be sure to set auto start to enabled, so it'll run when you start TwitchSpeaker.
Request format
{
"request": "<command>",
"id": "<id>",
}
Much like Streamer.bot, TwitchSpeaker follows the same request format, where request
is the command you wish to perform, and id
is some identifier or nonce.
This is probably the command that will be used the most, this will make TwitchSpeaker speak the message
you want, using the voice
specified
{
"request": "Speak",
"voice": "EventVoice",
"message": "This is a test message",
"badWordFilter": true/false, // optional
"id": "<id>"
}
This will let you enable or disable events being spoken
{
"request": "Events",
"state": "[on|off]"
"id": "<id>",
}
This will let you change the speaking mode, from everything, to a command
{
"request": "Mode",
"mode": "[all|command]"
"id": "<id>",
}
If there are no commands already setup, switching to command, will return a failure response
{
"request": "Stop"
"id": "<id>",
}
{
"request": "Off"
"id": "<id>",
}
{
"request": "On"
"id": "<id>",
}
{
"request": "Enable"
"id": "<id>",
}
{
"request": "Disable"
"id": "<id>",
}
{
"request": "Pause"
"id": "<id>",
}
{
"request": "Resume"
"id": "<id>",
}
{
"request": "Clear"
"id": "<id>",
}