WebSocket API

Control Speaker.bot in real-time via WebSocket!

Configuration

  • Navigate to Settings -> WebSocket Server in Speaker.bot

Auto Start

  • Type: Boolean
  • Default: false

Enable this flag to automatically start the WebSocket Server when Speaker.bot is launched.

If this is not enabled, you must manually click the Start Server button any time you want to enable WebSocket connectivity.

Address

  • Type: String
  • Default: 127.0.0.1

Change the WebSocket Server host address.

This can be useful if you want to expose the WebSocket server to additional machines on your local network, or even over the internet.

Port

  • Type: Number
  • Default: 7680

Change the WebSocket Server port.

It is not recommended to change this unless you have another service using this port or know what you are doing.

Endpoint

  • Type: String
  • Default: /

Change the WebSocket Server endpoint.

This will change the URL endpoint used to connect to the server, e.g. http://127.0.0.1/myendpoint

Request Format

All WebSocket Server requests follow a similar format, which is also used by Streamer.bot.

Request Format
{
  "id": "<id>",
  "request": "<command>"
}

id

  • Type: String

Any identifier or nonce you wish to use to identify your request.

request

  • Type: String

The name of the supported request.

All supported requests are documented on the next page.