Configuration

Navigate to Servers/Clients > WebSocket Server in Streamer.bot

WebSocket Server Settings

Options

Auto Start

Toggle

default:true

Automatically start the WebSocket Server when Streamer.bot starts

Address

Text

default:127.0.0.1

The IP address the WebSocket Server will bind to

You can set this to 0.0.0.0 to bind to all available network interfaces and make the server accessible from other devices on your network.

Port

Number

default:8080

The port the WebSocket Server will listen on

Endpoint

Text

default:/

The endpoint path for the WebSocket Server

Authentication

Toggle

default:false

Enable authentication for WebSocket clients

By default, authentication is only enforced on priveleged requests, such as SendMessage To enforce authentication for all requests, enable the Enforce option outlined below

Enforce

Toggle

default:false

Enforce authentication for all requests

If enabled, all clients must authenticate using the Authenticate request

Password

Text

The password required for clients to connect if authentication is enabled

Example

To connect to the WebSocket Server using the Streamer.bot Client

const client = new StreamerbotClient();

You can also specify custom connection options, if you have changed the default settings outlined above.

const client = new StreamerbotClient({
  host: '127.0.0.1',
  port: 8080,
  endpoint: '/',
  password: 'my-secret-password' // Only needed if authentication is enabled
});

Refer to the Streamer.bot Client documentation for more details

All C# Methods

Reference of all C# Methods in Streamer.bot

WebSocket Requests

Reference of all requests that can be made to the Streamer.bot WebSocket Server