Errata in the Web Speech API Specification

This document is no longer maintained. Please refer to to the commit history for changes.

This document last updated:

June 6, 2014

A draft of the specification with these errata applied is at:

http://dvcs.w3.org/hg/speech-api/raw-file/tip/webspeechapi.html

This document records known errors in the document:

http://dvcs.w3.org/hg/speech-api/raw-file/tip/speechapi.html

Please email error reports to:

public-speech-api@w3.org (Public archive)

E01 2012-11-30 (Clarification):

Section 6.1 Example 4: recognition.interim should be recognition.interimResults.

E02 2012-12-07 (Important):

Rename final attribute to isFinal because final is a reserved word. Specifically:

Section 5.1 IDL: SpeechRecognitionResult "readonly attribute boolean final" should be "readonly attribute boolean isFinal"

Section 5.1.6 "final attribute" should be "isFinal attribute"

Section 6.1 Examples 3 and 4: should be event.results[i].isFinal

E03 2013-02-04 (Important):

Section 5.1.8 SpeechRecognitionEvent: emma attribute: "with EMMA namespace" should be "with EMMA namespace, or if the recognizer does not supply EMMA then the user agent may return null".

E04 2013-02-04 (Important):

Section 5.1 IDL: Remove "interface SpeechRecognitionResultList { ... }".

Section 5.1 IDL: "readonly attribute SpeechRecognitionResultList results;" should be "readonly attribute sequence<SpeechRecognitionResult> results".

E05 2013-02-04 (Important):

Section 5.2 IDL: Remove "interface SpeechSynthesisVoiceList { ... }".

Section 5.2 IDL: "SpeechSynthesisVoiceList getVoices();" should be "sequence<SpeechSynthesisVoice> getVoices();".

E06 2013-02-25 (Important):

E04 is deleted.

E07 2013-02-25 (Important):

Section 5.2 IDL: SpeechSynthesisUtterance "attribute DOMString voiceURI" should be "attribute SpeechSynthesisVoice voice".

Section 5.2.3 SpeechSynthesisUtterance Attributes: "voiceURI attribute" should be "voice attribute", with the following definition:

The voice attribute specifies speech synthesis voice that the web application wishes to use. If, at the time of the play method call, this attribute has been set to one of the SpeechSynthesisVoice objects returned by getVoices, then the user agent MUST use that voice. If this attribute is unset or null at the time of the play method call, then the user agent MUST use a user agent default voice. The user agent default voice SHOULD support the current language (see "lang" attribute) and can be a local or remote speech service and can incorporate end user choices via interfaces provided by the user agent such as browser configuration parameters.

Section 5.2.6 SpeechSynthesisVoice: voiceURI attribute: "as described in the SpeechSynthesisUtterance voiceURI attribute" should be "either through use of a URN with meaning to the user agent or by specifying a URL that the user agent recognizes as a local service."

E08 2013-03-22 (Important):

Section 5.2 IDL: "interface SpeechSynthesis" should be "interface SpeechSynthesis : EventTarget".

Section 5.2 IDL: "readonly attribute SpeechSynthesisUtterance utterance;" is added to "interface SpeechSynthesisEvent : Event".

Section 5.2.4 SpeechSynthesisUtterance Events: Add the sentence: "These events bubble up to SpeechSynthesis."

Section 5.2.5 SpeechSynthesisEvent Attributes: Add the following definition:

utterance attribute
This attribute contains the SpeechSynthesisUtterance that triggered this event.

E09 2013-09-24 (Clarification):

Section 6.2 Example 1: "speechSynthesis.speak(SpeechSynthesisUtterance('Hello World'));" should be "speechSynthesis.speak(new SpeechSynthesisUtterance('Hello World'));"

E10 2013-09-24 (Important):

Section 5.2.2 speak method: append at the end of the definition:

The SpeechSynthesis object takes exclusive ownership of the SpeechSynthesisUtterance object. Passing it as a speak() argument to another SpeechSynthesis object should throw an exception. (For example, two frames may have the same origin and each will contain a SpeechSynthesis object.)

E11 2013-10-17 (Important):

Section 5.2 IDL: "attribute EventHandler onvoiceschanged;" is added to "interface SpeechSynthesis : EventTarget".

Section 5.2.2 getVoices method: append at the end of the definition:

If there are no voices available, or if the the list of available voices is not yet known (for example: server-side synthesis where the list is determined asynchronously), then this method MUST return a SpeechSynthesisVoiceList of length zero.

New "Section 5.2.2.1 SpeechSynthesis Events" is created and contains:

voiceschanged: Fired when the contents of the SpeechSynthesisVoiceList, that the getVoices method will return, have changed. Examples include: server-side synthesis where the list is determined asynchronously, or when client-side voices are installed/uninstalled.

E12 2013-10-17 (Important):

Section 5.2 IDL: Add the following:

    interface SpeechSynthesisErrorEvent extends SpeechSynthesisEvent {
        enum ErrorCode {
          "canceled",
          "interrupted",
          "audio-busy",
          "audio-hardware",
          "network",
          "synthesis-unavailable",
          "synthesis-failed",
          "language-unavailable",
          "voice-unavailable",
          "text-too-long",
          "invalid-argument",
        };

        readonly attribute ErrorCode error;
    };
    

Section 5.2.4 SpeechSynthesisUtterance Events: change first sentence to:

Each of these events MUST use the SpeechSynthesisEvent interface, except the error event which MUST use the SpeechSynthesisErrorEvent interface.

New "Section 5.2.5.1 SpeechSynthesisErrorEvent Attributes" is added and contains:

error attribute
The errorCode is an enumeration indicating what has gone wrong. The values are:
"canceled" A cancel method call caused the SpeechSynthesisUtterance to be removed from the queue before it had begun being spoken.
"interrupted" A cancel method call caused the SpeechSynthesisUtterance to be interrupted after it has begun being spoken and before it completed.
"audio-busy" The operation cannot be completed at this time because the user-agent cannot access the audio output device. (For example, the user may need to correct this by closing another application.)
"audio-hardware" The operation cannot be completed at this time because the user-agent cannot identify an audio output device. (For example, the user may need to connect a speaker or configure system settings.)
"network" The operation cannot be completed at this time because some required network communication failed.
"synthesis-unavailable" The operation cannot be completed at this time because no synthesis engine is available. (For example, the user may need to install or configure a synthesis engine.)
"synthesis-failed" The operation failed because synthesis engine had an error.
"language-unavailable" No appropriate voice is available for the language designated in SpeechSynthesisUtterance lang.
"voice-unavailable" The voice designated in SpeechSynthesisUtterance voiceURI is not available.
"text-too-long" The contents of the SpeechSynthesisUtterance text attribute is too long to synthesize.
"invalid-argument" The contents of the SpeechSynthesisUtterance rate, pitch or volume attribute is not supported by synthesizer.

E13 2013-11-06 (Important):

Section 5.1.1 and Section 5.2.3: Replace the misspelled "hierachy" with the word "hierarchy".

E14 2013-11-06 (Important):

Section 4 Bullet 4: Delete the following sentence:

To minimize the chance of users unwittingly allowing web pages to record speech without their knowledge, implementations must abort an active speech input session if the web page lost input focus to another window or to another tab within the same user agent.

E15 2013-11-06 (Important):

Section 5.1.3: soundstart event: append at the end of the definition:

The audiostart event must always have been fired before the soundstart event.

Section 5.1.3: speechstart event: append at the end of the definition:

The audiostart event must always have been fired before the speechstart event.

Section 5.1.3: onresult event: append at the end of the definition:

The audiostart event must always have been fired before the onresult event.

Section 5.1.3: nomatch event: append at the end of the definition:

The audiostart event must always have been fired before the nomatch event.

Section 5.1.3: speechend event: replace the word "fire" with "fired".

E16 2014-06-06 (Clarification):

Section 6.1 Example 3: "resultIndex" should be "event.resultIndex".