Inputs.InputMouseClick

WebSocket event schema, payload, and examples

Properties

button
integer required
clicks
integer required
x
integer required
y
integer required

Schema

The JSON Schema for the event payload, if available.
schema.json
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "InputMouseClickPayload",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "button": {
      "type": "integer",
      "format": "int32"
    },
    "clicks": {
      "type": "integer"
    },
    "x": {
      "type": "integer",
      "format": "int32"
    },
    "y": {
      "type": "integer",
      "format": "int32"
    }
  }
}

JSON Payload

An example JSON payload for the event, automatically generated using JSONSchemaFaker
example.json
{
  "button": -24803549,
  "clicks": -93584944,
  "x": -18847345,
  "y": 4067443
}

Client Example

Example code showing how to subscribe to this event using the Streamer.bot WebSocket Client
index.js
// Initialize the Streamer.bot WebSocket Client
const client = new StreamerbotClient();

// Subscribe to "Inputs.InputMouseClick" events and register a callback
client.on('Inputs.InputMouseClick', ({ event, data }) => {
  // Code here will run every time the event is received!
  console.log('Received event:', event.source, event.type);
  console.log('Event data:', data);
});