Inputs.InputControllerHat

WebSocket event schema, payload, and examples
The properties defined in the event schema, with descriptions.
controller
object required
direction
string
index
integer required
value
integer required
The JSON Schema for the event payload, if available.
schema.json
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "InputControllerHatPayload",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "direction": {
      "type": [
        "null",
        "string"
      ]
    },
    "index": {
      "type": "integer"
    },
    "value": {
      "type": "integer"
    },
    "controller": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/$defs/InputControllerData"
        }
      ]
    }
  },
  "$defs": {
    "InputControllerData": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "integer"
        },
        "playerIndex": {
          "type": "integer"
        },
        "deviceName": {
          "type": [
            "null",
            "string"
          ]
        },
        "type": {
          "type": [
            "null",
            "string"
          ]
        },
        "isRawJoystick": {
          "type": "boolean"
        }
      }
    }
  }
}
An example JSON payload for the event, automatically generated using JSONSchemaFaker
example.json
{
  "direction": null,
  "index": -475,
  "value": -60,
  "controller": null
}
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.InputControllerHat" events and register a callback
client.on('Inputs.InputControllerHat', ({ 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);
});