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 [Pref="media.webspeech.recognition.enable",
  14  LegacyFactoryFunction=webkitSpeechRecognition,
  15  Func="SpeechRecognition::IsAuthorized",
  16  Exposed=Window]
  17 interface SpeechRecognition : EventTarget {
  18     [Throws]
  19     constructor();
  20
  21     // recognition parameters
  22     attribute SpeechGrammarList grammars;
  23     attribute DOMString lang;
  24     [Throws]
  25     attribute boolean continuous;
  26     attribute boolean interimResults;
  27     attribute unsigned long maxAlternatives;
  28     [Throws]
  29     attribute DOMString serviceURI;
  30
  31     // methods to drive the speech interaction
  32     [Throws, NeedsCallerType]
  33     undefined start(optional MediaStream stream);
  34     undefined stop();
  35     undefined abort();
  36
  37     // event methods
  38     attribute EventHandler onaudiostart;
  39     attribute EventHandler onsoundstart;
  40     attribute EventHandler onspeechstart;
  41     attribute EventHandler onspeechend;
  42     attribute EventHandler onsoundend;
  43     attribute EventHandler onaudioend;
  44     attribute EventHandler onresult;
  45     attribute EventHandler onnomatch;
  46     attribute EventHandler onerror;
  47     attribute EventHandler onstart;
  48     attribute EventHandler onend;
  49 };