dom/webidl/SpeechRecognition.webidl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   4  * You can obtain one at http://mozilla.org/MPL/2.0/.
   5  *
   6  * The origin of this IDL file is
   7  * http://dvcs.w3.org/hg/speech-api/raw-file/tip/speechapi.html
   8  *
   9  * Copyright © 2012 W3C® (MIT, ERCIM, Keio), All Rights Reserved. W3C
  10  * liability, trademark and document use rules apply.
  11  */
  12
  13 [Constructor,
  14  Pref="media.webspeech.recognition.enable"]
  15 interface SpeechRecognition : EventTarget {
  16     // recognition parameters
  17     [Throws]
  18     attribute SpeechGrammarList grammars;
  19     [Throws]
  20     attribute DOMString lang;
  21     [Throws]
  22     attribute boolean continuous;
  23     [Throws]
  24     attribute boolean interimResults;
  25     [Throws]
  26     attribute unsigned long maxAlternatives;
  27     [Throws]
  28     attribute DOMString serviceURI;
  29
  30     // methods to drive the speech interaction
  31     [Throws]
  32     void start(optional MediaStream stream);
  33     void stop();
  34     void abort();
  35
  36     // event methods
  37     attribute EventHandler onaudiostart;
  38     attribute EventHandler onsoundstart;
  39     attribute EventHandler onspeechstart;
  40     attribute EventHandler onspeechend;
  41     attribute EventHandler onsoundend;
  42     attribute EventHandler onaudioend;
  43     attribute EventHandler onresult;
  44     attribute EventHandler onnomatch;
  45     attribute EventHandler onerror;
  46     attribute EventHandler onstart;
  47     attribute EventHandler onend;
  48 };