`SpeechToText.Dictation`

WebSocket event schema, payload, and examples

Properties

The properties defined in the event schema, with descriptions.

alternatives

AlternativePhrase[]

confidence

number required

text

string

Schema

The JSON Schema for the event payload, if available.

schema.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "SpeechToTextEvent",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "text": {
      "type": [
        "null",
        "string"
      ]
    },
    "confidence": {
      "type": "number"
    },
    "alternatives": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/AlternativePhrase"
      }
    }
  },
  "$defs": {
    "AlternativePhrase": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "text": {
          "type": [
            "null",
            "string"
          ]
        },
        "confidence": {
          "type": "number"
        }
      }
    }
  }
}

JSON Payload

An example JSON payload for the event, automatically generated using JSONSchemaFaker

example.json

{
  "text": "UqgACu",
  "confidence": -498.05172346532345,
  "alternatives": [
    {
      "text": null,
      "confidence": 492.54197953268886
    },
    {
      "text": null,
      "confidence": -206.40815375372767
    },
    {
      "text": "5X4djrIgm",
      "confidence": 326.7315379343927
    },
    {
      "text": "Zzpw",
      "confidence": 819.0045175142586
    },
    {
      "text": null,
      "confidence": 136.5682641044259
    }
  ]
}

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 "SpeechToText.Dictation" events and register a callback
client.on('SpeechToText.Dictation', ({ 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);
});