WebSocket sub-actions¶

Client: connect / disconnect¶

Connects Cuebot to another program over a WebSocket, or ends that connection.

Setting	What to put in
Client	Which client: its name, or its number in your list (0 is the first).
State	Connect opens the connection, Disconnect closes it. Options: Connect, Disconnect. Starts as: `Connect`.

Type id: websocket.clientState

Sends a message to another program over a WebSocket connection Cuebot has made. Fails if the connection is not open.

Setting	What to put in
Client	Which client: its name, or its number in your list (0 is the first).
Message	The text to send.

Type id: websocket.clientSend

Sends a message to programs connected to one of your own WebSocket servers (an open line to another app). Use it to talk to your own tools.

Setting	What to put in
Server	Which server: its name, or its number in your list (0 is the first).
Message	The text to send.
Session id	Send to just one connected program: type its session id. Leave empty to send to all. In a message trigger, %sessionId% answers whoever wrote.

Variables it adds

Variable	What it holds
`%sentCount%`	How many programs got the message

Type id: websocket.serverSend

Starts or stops one of your own WebSocket servers (the open line other programs connect to).

Setting	What to put in
Server	Which server: its name, or its number in your list (0 is the first).
State	Start opens the server, Stop closes it. Options: Start, Stop. Starts as: `Start`.

Type id: websocket.serverState

Sends a message to every program connected to Cuebot's built-in WebSocket address (the one other apps use to talk to Cuebot).

Setting	What to put in
Message	The text to send. If it is written as JSON it is sent as data, otherwise as plain text.

Variables it adds

Variable	What it holds
`%sentCount%`	How many programs got the message

Type id: websocket.broadcast