akasha.speech

Class SpeechSynthesis

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.speech.SpeechSynthesis

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="Object")
public class SpeechSynthesis
extends EventTarget

The SpeechSynthesis interface of the Web Speech API is the controller interface for the speech service; this can be used to retrieve information about the synthesis voices available on the device, start and pause speech, and other commands besides.

See Also:

SpeechSynthesis - MDN, # tts-section

Field Summary

Fields

Modifier and Type	Field and Description
@JsNullable EventHandler	onvoiceschanged The onvoiceschanged property of the SpeechSynthesis interface represents an event handler that will run when the list of SpeechSynthesisVoice objects that would be returned by the SpeechSynthesis.getVoices() method has changed (when the voiceschanged event fires.)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SpeechSynthesis()

Method Summary

Modifier and Type	Method and Description
void	addVoiceschangedListener(EventListener callback)
void	addVoiceschangedListener(EventListener callback, AddEventListenerOptions options)
void	addVoiceschangedListener(EventListener callback, boolean useCapture)
void	cancel() The cancel() method of the SpeechSynthesis interface removes all utterances from the utterance queue.
@JsNonNull JsArray<SpeechSynthesisVoice>	getVoices() The getVoices() method of the SpeechSynthesis interface returns a list of SpeechSynthesisVoice objects representing all the available voices on the current device.
void	pause() The pause() method of the SpeechSynthesis interface puts the SpeechSynthesis object into a paused state.
boolean	paused() The paused read-only property of the SpeechSynthesis interface is a Boolean that returns true if the SpeechSynthesis object is in a paused state, or false if not.
boolean	pending() The pending read-only property of the SpeechSynthesis interface is a Boolean that returns true if the utterance queue contains as-yet-unspoken utterances.
void	removeVoiceschangedListener(EventListener callback)
void	removeVoiceschangedListener(EventListener callback, boolean useCapture)
void	removeVoiceschangedListener(EventListener callback, EventListenerOptions options)
void	resume() The resume() method of the SpeechSynthesis interface puts the SpeechSynthesis object into a non-paused state: resumes it if it was already paused.
void	speak(SpeechSynthesisUtterance utterance) The speak() method of the SpeechSynthesis interface adds an utterance to the utterance queue; it will be spoken when any other utterances queued before it have been spoken.
boolean	speaking() The speaking read-only property of the SpeechSynthesis interface is a Boolean that returns true if an utterance is currently in the process of being spoken — even if SpeechSynthesis is in a paused state.

Methods inherited from class akasha.EventTarget

addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

onvoiceschanged

public @JsNullable EventHandler onvoiceschanged

The onvoiceschanged property of the SpeechSynthesis interface represents an event handler that will run when the list of SpeechSynthesisVoice objects that would be returned by the SpeechSynthesis.getVoices() method has changed (when the voiceschanged event fires.)

See Also:

SpeechSynthesis.onvoiceschanged - MDN, onvoiceschanged - Web Speech API

Constructor Detail

SpeechSynthesis

protected SpeechSynthesis()

Method Detail

paused

@JsProperty(name="paused")
public boolean paused()

The paused read-only property of the SpeechSynthesis interface is a Boolean that returns true if the SpeechSynthesis object is in a paused state, or false if not.

See Also:

SpeechSynthesis.paused - MDN, paused - Web Speech API

pending

@JsProperty(name="pending")
public boolean pending()

The pending read-only property of the SpeechSynthesis interface is a Boolean that returns true if the utterance queue contains as-yet-unspoken utterances.

See Also:

SpeechSynthesis.pending - MDN, pending - Web Speech API

speaking

@JsProperty(name="speaking")
public boolean speaking()

The speaking read-only property of the SpeechSynthesis interface is a Boolean that returns true if an utterance is currently in the process of being spoken — even if SpeechSynthesis is in a paused state.

See Also:

SpeechSynthesis.speaking - MDN, speaking - Web Speech API

cancel

public void cancel()

The cancel() method of the SpeechSynthesis interface removes all utterances from the utterance queue.

See Also:

SpeechSynthesis.cancel - MDN, cancel() - Web Speech API

getVoices

public @JsNonNull JsArray<SpeechSynthesisVoice> getVoices()

The getVoices() method of the SpeechSynthesis interface returns a list of SpeechSynthesisVoice objects representing all the available voices on the current device.

See Also:

SpeechSynthesis.getVoices - MDN, getVoices() - Web Speech API

pause

public void pause()

The pause() method of the SpeechSynthesis interface puts the SpeechSynthesis object into a paused state.

See Also:

SpeechSynthesis.pause - MDN, pause() - Web Speech API

resume

public void resume()

The resume() method of the SpeechSynthesis interface puts the SpeechSynthesis object into a non-paused state: resumes it if it was already paused.

See Also:

SpeechSynthesis.resume - MDN, resume() - Web Speech API

speak

public void speak(@Nonnull
                  SpeechSynthesisUtterance utterance)

The speak() method of the SpeechSynthesis interface adds an utterance to the utterance queue; it will be spoken when any other utterances queued before it have been spoken.

See Also:

SpeechSynthesis.speak - MDN, speak() - Web Speech API

addVoiceschangedListener

@JsOverlay
public final void addVoiceschangedListener(@Nonnull
                                                      EventListener callback,
                                                      @Nonnull
                                                      AddEventListenerOptions options)

addVoiceschangedListener

@JsOverlay
public final void addVoiceschangedListener(@Nonnull
                                                      EventListener callback,
                                                      boolean useCapture)

addVoiceschangedListener

@JsOverlay
public final void addVoiceschangedListener(@Nonnull
                                                      EventListener callback)

removeVoiceschangedListener

@JsOverlay
public final void removeVoiceschangedListener(@Nonnull
                                                         EventListener callback,
                                                         @Nonnull
                                                         EventListenerOptions options)

removeVoiceschangedListener

@JsOverlay
public final void removeVoiceschangedListener(@Nonnull
                                                         EventListener callback,
                                                         boolean useCapture)

removeVoiceschangedListener

@JsOverlay
public final void removeVoiceschangedListener(@Nonnull
                                                         EventListener callback)