akasha.speech

Class SpeechSynthesisUtterance

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.speech.SpeechSynthesisUtterance

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

The SpeechSynthesisUtterance interface of the Web Speech API represents a speech request. It contains the content the speech service should read and information about how to read it (e.g. language, pitch and volume.)

See Also:

SpeechSynthesisUtterance - MDN, SpeechSynthesisUtterance - Web Speech API

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	lang The lang property of the SpeechSynthesisUtterance interface gets and sets the language of the utterance.
SpeechSynthesisEventHandler	onboundary The onboundary property of the SpeechSynthesisUtterance interface represents an event handler that will run when the spoken utterance reaches a word or sentence boundary (when the boundary event fires.)
SpeechSynthesisEventHandler	onend The onend property of the SpeechSynthesisUtterance interface represents an event handler that will run when the utterance has finished being spoken (when the end event fires.)
SpeechSynthesisErrorEventHandler	onerror The onerror property of the SpeechSynthesisUtterance interface represents an event handler that will run when an error occurs that prevents the utterance from being succesfully spoken (when the error event fires.)
SpeechSynthesisEventHandler	onmark The onmark property of the SpeechSynthesisUtterance interface represents an event handler that will run when the spoken utterance reaches a named SSML mark tag (when the mark event fires.)
SpeechSynthesisEventHandler	onpause The onpause property of the SpeechSynthesisUtterance interface represents an event handler that will run when the utterance is paused part way through (when the pause event fires.)
SpeechSynthesisEventHandler	onresume The onresume property of the SpeechSynthesisUtterance interface represents an event handler that will run when a paused utterance is resumed (when the resume event fires.)
SpeechSynthesisEventHandler	onstart The onstart property of the SpeechSynthesisUtterance interface represents an event handler that will run when the utterance has begun to be spoken (when the start event fires.)
float	pitch The pitch property of the SpeechSynthesisUtterance interface gets and sets the pitch at which the utterance will be spoken at.
float	rate The rate property of the SpeechSynthesisUtterance interface gets and sets the speed at which the utterance will be spoken at.
java.lang.String	text The text property of the SpeechSynthesisUtterance interface gets and sets the text that will be synthesised when the utterance is spoken.
SpeechSynthesisVoice	voice The voice property of the SpeechSynthesisUtterance interface gets and sets the voice that will be used to speak the utterance.
float	volume The volume property of the SpeechSynthesisUtterance interface gets and sets the volume that the utterance will be spoken at.

Constructor Summary

Constructors

Constructor and Description
SpeechSynthesisUtterance() The SpeechSynthesisUtterance() constructor of the SpeechSynthesisUtterance interface returns a new SpeechSynthesisUtterance object instance.
SpeechSynthesisUtterance(java.lang.String text) The SpeechSynthesisUtterance() constructor of the SpeechSynthesisUtterance interface returns a new SpeechSynthesisUtterance object instance.

Method Summary

Modifier and Type	Method and Description
void	addBoundaryListener(SpeechSynthesisEventListener callback)
void	addBoundaryListener(SpeechSynthesisEventListener callback, AddEventListenerOptions options)
void	addBoundaryListener(SpeechSynthesisEventListener callback, boolean useCapture)
void	addEndListener(SpeechSynthesisEventListener callback)
void	addEndListener(SpeechSynthesisEventListener callback, AddEventListenerOptions options)
void	addEndListener(SpeechSynthesisEventListener callback, boolean useCapture)
void	addErrorListener(SpeechSynthesisErrorEventListener callback)
void	addErrorListener(SpeechSynthesisErrorEventListener callback, AddEventListenerOptions options)
void	addErrorListener(SpeechSynthesisErrorEventListener callback, boolean useCapture)
void	addMarkListener(SpeechSynthesisEventListener callback)
void	addMarkListener(SpeechSynthesisEventListener callback, AddEventListenerOptions options)
void	addMarkListener(SpeechSynthesisEventListener callback, boolean useCapture)
void	addPauseListener(SpeechSynthesisEventListener callback)
void	addPauseListener(SpeechSynthesisEventListener callback, AddEventListenerOptions options)
void	addPauseListener(SpeechSynthesisEventListener callback, boolean useCapture)
void	addResumeListener(SpeechSynthesisEventListener callback)
void	addResumeListener(SpeechSynthesisEventListener callback, AddEventListenerOptions options)
void	addResumeListener(SpeechSynthesisEventListener callback, boolean useCapture)
void	addStartListener(SpeechSynthesisEventListener callback)
void	addStartListener(SpeechSynthesisEventListener callback, AddEventListenerOptions options)
void	addStartListener(SpeechSynthesisEventListener callback, boolean useCapture)
void	removeBoundaryListener(SpeechSynthesisEventListener callback)
void	removeBoundaryListener(SpeechSynthesisEventListener callback, boolean useCapture)
void	removeBoundaryListener(SpeechSynthesisEventListener callback, EventListenerOptions options)
void	removeEndListener(SpeechSynthesisEventListener callback)
void	removeEndListener(SpeechSynthesisEventListener callback, boolean useCapture)
void	removeEndListener(SpeechSynthesisEventListener callback, EventListenerOptions options)
void	removeErrorListener(SpeechSynthesisErrorEventListener callback)
void	removeErrorListener(SpeechSynthesisErrorEventListener callback, boolean useCapture)
void	removeErrorListener(SpeechSynthesisErrorEventListener callback, EventListenerOptions options)
void	removeMarkListener(SpeechSynthesisEventListener callback)
void	removeMarkListener(SpeechSynthesisEventListener callback, boolean useCapture)
void	removeMarkListener(SpeechSynthesisEventListener callback, EventListenerOptions options)
void	removePauseListener(SpeechSynthesisEventListener callback)
void	removePauseListener(SpeechSynthesisEventListener callback, boolean useCapture)
void	removePauseListener(SpeechSynthesisEventListener callback, EventListenerOptions options)
void	removeResumeListener(SpeechSynthesisEventListener callback)
void	removeResumeListener(SpeechSynthesisEventListener callback, boolean useCapture)
void	removeResumeListener(SpeechSynthesisEventListener callback, EventListenerOptions options)
void	removeStartListener(SpeechSynthesisEventListener callback)
void	removeStartListener(SpeechSynthesisEventListener callback, boolean useCapture)
void	removeStartListener(SpeechSynthesisEventListener callback, EventListenerOptions options)

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

lang

@Nonnull
public java.lang.String lang

The lang property of the SpeechSynthesisUtterance interface gets and sets the language of the utterance.

See Also:

SpeechSynthesisUtterance.lang - MDN, lang - Web Speech API

onboundary

@Nullable
public SpeechSynthesisEventHandler onboundary

The onboundary property of the SpeechSynthesisUtterance interface represents an event handler that will run when the spoken utterance reaches a word or sentence boundary (when the boundary event fires.)

See Also:

SpeechSynthesisUtterance.onboundary - MDN, onboundary - Web Speech API

onend

@Nullable
public SpeechSynthesisEventHandler onend

The onend property of the SpeechSynthesisUtterance interface represents an event handler that will run when the utterance has finished being spoken (when the end event fires.)

See Also:

SpeechSynthesisUtterance.onend - MDN, onend - Web Speech API

onerror

@Nullable
public SpeechSynthesisErrorEventHandler onerror

The onerror property of the SpeechSynthesisUtterance interface represents an event handler that will run when an error occurs that prevents the utterance from being succesfully spoken (when the error event fires.)

See Also:

SpeechSynthesisUtterance.onerror - MDN, onerror - Web Speech API

onmark

@Nullable
public SpeechSynthesisEventHandler onmark

The onmark property of the SpeechSynthesisUtterance interface represents an event handler that will run when the spoken utterance reaches a named SSML mark tag (when the mark event fires.)

See Also:

SpeechSynthesisUtterance.onmark - MDN, onmark - Web Speech API

onpause

@Nullable
public SpeechSynthesisEventHandler onpause

The onpause property of the SpeechSynthesisUtterance interface represents an event handler that will run when the utterance is paused part way through (when the pause event fires.)

See Also:

SpeechSynthesisUtterance.onpause - MDN, onpause - Web Speech API

onresume

@Nullable
public SpeechSynthesisEventHandler onresume

The onresume property of the SpeechSynthesisUtterance interface represents an event handler that will run when a paused utterance is resumed (when the resume event fires.)

See Also:

SpeechSynthesisUtterance.onresume - MDN, onresume - Web Speech API

onstart

@Nullable
public SpeechSynthesisEventHandler onstart

The onstart property of the SpeechSynthesisUtterance interface represents an event handler that will run when the utterance has begun to be spoken (when the start event fires.)

See Also:

SpeechSynthesisUtterance.onstart - MDN, onstart - Web Speech API

pitch

public float pitch

The pitch property of the SpeechSynthesisUtterance interface gets and sets the pitch at which the utterance will be spoken at.

See Also:

SpeechSynthesisUtterance.pitch - MDN, pitch - Web Speech API

rate

public float rate

The rate property of the SpeechSynthesisUtterance interface gets and sets the speed at which the utterance will be spoken at.

See Also:

SpeechSynthesisUtterance.rate - MDN, rate - Web Speech API

text

@Nonnull
public java.lang.String text

The text property of the SpeechSynthesisUtterance interface gets and sets the text that will be synthesised when the utterance is spoken.

See Also:

SpeechSynthesisUtterance.text - MDN, text - Web Speech API

voice

@Nullable
public SpeechSynthesisVoice voice

The voice property of the SpeechSynthesisUtterance interface gets and sets the voice that will be used to speak the utterance.

See Also:

SpeechSynthesisUtterance.voice - MDN, voice - Web Speech API

volume

public float volume

The volume property of the SpeechSynthesisUtterance interface gets and sets the volume that the utterance will be spoken at.

See Also:

SpeechSynthesisUtterance.volume - MDN, volume - Web Speech API

Constructor Detail

SpeechSynthesisUtterance

public SpeechSynthesisUtterance(@Nonnull
                                java.lang.String text)

The SpeechSynthesisUtterance() constructor of the SpeechSynthesisUtterance interface returns a new SpeechSynthesisUtterance object instance.

See Also:

SpeechSynthesisUtterance.SpeechSynthesisUtterance - MDN, SpeechSynthesisUtterance() - Web Speech API

SpeechSynthesisUtterance

public SpeechSynthesisUtterance()

The SpeechSynthesisUtterance() constructor of the SpeechSynthesisUtterance interface returns a new SpeechSynthesisUtterance object instance.

See Also:

SpeechSynthesisUtterance.SpeechSynthesisUtterance - MDN, SpeechSynthesisUtterance() - Web Speech API

Method Detail

addBoundaryListener

@JsOverlay
public final void addBoundaryListener(@Nonnull
                                                 SpeechSynthesisEventListener callback,
                                                 @Nonnull
                                                 AddEventListenerOptions options)

addBoundaryListener

@JsOverlay
public final void addBoundaryListener(@Nonnull
                                                 SpeechSynthesisEventListener callback,
                                                 boolean useCapture)

addBoundaryListener

@JsOverlay
public final void addBoundaryListener(@Nonnull
                                                 SpeechSynthesisEventListener callback)

removeBoundaryListener

@JsOverlay
public final void removeBoundaryListener(@Nonnull
                                                    SpeechSynthesisEventListener callback,
                                                    @Nonnull
                                                    EventListenerOptions options)

removeBoundaryListener

@JsOverlay
public final void removeBoundaryListener(@Nonnull
                                                    SpeechSynthesisEventListener callback,
                                                    boolean useCapture)

removeBoundaryListener

@JsOverlay
public final void removeBoundaryListener(@Nonnull
                                                    SpeechSynthesisEventListener callback)

addEndListener

@JsOverlay
public final void addEndListener(@Nonnull
                                            SpeechSynthesisEventListener callback,
                                            @Nonnull
                                            AddEventListenerOptions options)

addEndListener

@JsOverlay
public final void addEndListener(@Nonnull
                                            SpeechSynthesisEventListener callback,
                                            boolean useCapture)

addEndListener

@JsOverlay
public final void addEndListener(@Nonnull
                                            SpeechSynthesisEventListener callback)

removeEndListener

@JsOverlay
public final void removeEndListener(@Nonnull
                                               SpeechSynthesisEventListener callback,
                                               @Nonnull
                                               EventListenerOptions options)

removeEndListener

@JsOverlay
public final void removeEndListener(@Nonnull
                                               SpeechSynthesisEventListener callback,
                                               boolean useCapture)

removeEndListener

@JsOverlay
public final void removeEndListener(@Nonnull
                                               SpeechSynthesisEventListener callback)

addErrorListener

@JsOverlay
public final void addErrorListener(@Nonnull
                                              SpeechSynthesisErrorEventListener callback,
                                              @Nonnull
                                              AddEventListenerOptions options)

addErrorListener

@JsOverlay
public final void addErrorListener(@Nonnull
                                              SpeechSynthesisErrorEventListener callback,
                                              boolean useCapture)

addErrorListener

@JsOverlay
public final void addErrorListener(@Nonnull
                                              SpeechSynthesisErrorEventListener callback)

removeErrorListener

@JsOverlay
public final void removeErrorListener(@Nonnull
                                                 SpeechSynthesisErrorEventListener callback,
                                                 @Nonnull
                                                 EventListenerOptions options)

removeErrorListener

@JsOverlay
public final void removeErrorListener(@Nonnull
                                                 SpeechSynthesisErrorEventListener callback,
                                                 boolean useCapture)

removeErrorListener

@JsOverlay
public final void removeErrorListener(@Nonnull
                                                 SpeechSynthesisErrorEventListener callback)

addMarkListener

@JsOverlay
public final void addMarkListener(@Nonnull
                                             SpeechSynthesisEventListener callback,
                                             @Nonnull
                                             AddEventListenerOptions options)

addMarkListener

@JsOverlay
public final void addMarkListener(@Nonnull
                                             SpeechSynthesisEventListener callback,
                                             boolean useCapture)

addMarkListener

@JsOverlay
public final void addMarkListener(@Nonnull
                                             SpeechSynthesisEventListener callback)

removeMarkListener

@JsOverlay
public final void removeMarkListener(@Nonnull
                                                SpeechSynthesisEventListener callback,
                                                @Nonnull
                                                EventListenerOptions options)

removeMarkListener

@JsOverlay
public final void removeMarkListener(@Nonnull
                                                SpeechSynthesisEventListener callback,
                                                boolean useCapture)

removeMarkListener

@JsOverlay
public final void removeMarkListener(@Nonnull
                                                SpeechSynthesisEventListener callback)

addPauseListener

@JsOverlay
public final void addPauseListener(@Nonnull
                                              SpeechSynthesisEventListener callback,
                                              @Nonnull
                                              AddEventListenerOptions options)

addPauseListener

@JsOverlay
public final void addPauseListener(@Nonnull
                                              SpeechSynthesisEventListener callback,
                                              boolean useCapture)

addPauseListener

@JsOverlay
public final void addPauseListener(@Nonnull
                                              SpeechSynthesisEventListener callback)

removePauseListener

@JsOverlay
public final void removePauseListener(@Nonnull
                                                 SpeechSynthesisEventListener callback,
                                                 @Nonnull
                                                 EventListenerOptions options)

removePauseListener

@JsOverlay
public final void removePauseListener(@Nonnull
                                                 SpeechSynthesisEventListener callback,
                                                 boolean useCapture)

removePauseListener

@JsOverlay
public final void removePauseListener(@Nonnull
                                                 SpeechSynthesisEventListener callback)

addResumeListener

@JsOverlay
public final void addResumeListener(@Nonnull
                                               SpeechSynthesisEventListener callback,
                                               @Nonnull
                                               AddEventListenerOptions options)

addResumeListener

@JsOverlay
public final void addResumeListener(@Nonnull
                                               SpeechSynthesisEventListener callback,
                                               boolean useCapture)

addResumeListener

@JsOverlay
public final void addResumeListener(@Nonnull
                                               SpeechSynthesisEventListener callback)

removeResumeListener

@JsOverlay
public final void removeResumeListener(@Nonnull
                                                  SpeechSynthesisEventListener callback,
                                                  @Nonnull
                                                  EventListenerOptions options)

removeResumeListener

@JsOverlay
public final void removeResumeListener(@Nonnull
                                                  SpeechSynthesisEventListener callback,
                                                  boolean useCapture)

removeResumeListener

@JsOverlay
public final void removeResumeListener(@Nonnull
                                                  SpeechSynthesisEventListener callback)

addStartListener

@JsOverlay
public final void addStartListener(@Nonnull
                                              SpeechSynthesisEventListener callback,
                                              @Nonnull
                                              AddEventListenerOptions options)

addStartListener

@JsOverlay
public final void addStartListener(@Nonnull
                                              SpeechSynthesisEventListener callback,
                                              boolean useCapture)

addStartListener

@JsOverlay
public final void addStartListener(@Nonnull
                                              SpeechSynthesisEventListener callback)

removeStartListener

@JsOverlay
public final void removeStartListener(@Nonnull
                                                 SpeechSynthesisEventListener callback,
                                                 @Nonnull
                                                 EventListenerOptions options)

removeStartListener

@JsOverlay
public final void removeStartListener(@Nonnull
                                                 SpeechSynthesisEventListener callback,
                                                 boolean useCapture)

removeStartListener

@JsOverlay
public final void removeStartListener(@Nonnull
                                                 SpeechSynthesisEventListener callback)