Reference

Reference

• Recognition
  • startRec

    • Type: Function

    • Description: Starts recording.

    • Syntax:

      startRec();

  • speechRecVars

    • Type: Object

    • Description: All of the Speech Recognition Variables set.

    • Syntax:

      speechRecVars

  • setSpeechRecVar

    • Type: Function

    • Description: Sets a Speech Recognition Variable.

    • Syntax:

      setSpeechRecVar(name, value);

    • Parameters:

      • name: String. The name of the Speech Recognition Variable.
      • value: Object. The value of the Speech Recognition Variable.
  • speechRecognized

    • Type: Function

    • Description: Called when Speech is Recognized.

    • Syntax:

      function speechRecognized(result) {
          
      }

    • Parameters:

      • result: Object. The result of the recognization. It includes:
        • toString: String. What somebody sead.
        • toBool: Boolean. Is it any confident?
        • confidence (not there by default): Number. Confidence level.
        • isInterim: Boolean. Is the result an interim result?
        • toRaw: Object. The result of the recognization. Encoded.
• Synthesis
  • availableVoices

    • Type: Array

    • Description: An array of all of the available voices.

    • Syntax:

      availableVoices

  • getVoiceNames

    • Type: Function

    • Description: Returns an array of all of the voice names. Highly reccomended instead of availableVoices, unless you do not only want the voice names.

    • Syntax:

      getVoiceNames()

    • Returns: Array. An array of all of the voice names.

  • speechSynthVars

    • Type: Object

    • Description: All of the Speech Synthesis Variables set.

    • Syntax:

      speechSynthVars

  • setSpeechSynthVar

    • Type: Function

    • Description: Sets a Speech Synthesis Variable.

    • Syntax:

      setSpeechSynthVar(name, value);

    • Parameters:

      • name: String. The name of the Speech Synthesis Variable.
      • value: Object. The value of the Speech Synthesis Variable.
  • speak

    • Type: Function

    • Description: Lets the computer speak.

    • Syntax:

      speak(message);

    • Parameters

      • message: String. The thing that the computer is going to say.
  • startedSpeaking

    • Type: Function

    • Description: Makes a startedSpeaking event.

    • Syntax:

      startedSpeaking(callback);

      Note: The syntax might get changed later.

    • Parameters:

      • callback: Function. The thing that you want to happen when the computer starts speaking.
  • endedSpeaking

    • Type: Function

    • Description: Makes a endedSpeaking event.

    • Syntax:

      endedSpeaking(callback);

      Note: The syntax might get changed later.

    • Parameters:

      • callback: Function. The thing that you want to happen when the computer ends speaking.

Speech Variables

• Recognition
  • non-stop: Boolean. Set this to true if you don't want a one-time listen.
  • interim: Boolean. Set this to true if you want to get interim results.
  • get-confidence: Boolean. Set this to true if you want to get the confidence score when you get results.
  • language: String. The language that you're listening for. Default is whatever the language of the browser is.
• Synthesis
  • language: String. The language. Default is whatever the language of the browser is.
  • voice: String. The voice with which the computer is going to speak. Default depends on the language.
  • volume: Number. The volume at which the computer is going to speak. Range: 0.01-1. Default: 1.
  • rate: Number. The rate at which the computer is going to speak. Minimum: 0. Default: 1.
  • pitch: Number. The pitch at witch the computer is going to speak. Range: 0.01-2. Default: 1.