SpeechSynthesisUtterance#

class SpeechSynthesisUtterance extends EventTarget

Annotations: @Native.new("SpeechSynthesisUtterance")

Inheritance

Object → EventTarget → SpeechSynthesisUtterance

Constructors#

SpeechSynthesisUtterance() factory#

factory SpeechSynthesisUtterance([ String? text])

Implementation

factory SpeechSynthesisUtterance([String? text]) {
  if (text != null) {
    return SpeechSynthesisUtterance._create_1(text);
  }
  return SpeechSynthesisUtterance._create_2();
}

Properties#

hashCode no setter inherited#

int get hashCode

Inherited from Interceptor.

Implementation

int get hashCode => Primitives.objectHashCode(this);

lang read / write#

String? get lang

Implementation

String? get lang native;

set lang(String? value) native;

on no setter inherited#

Events get on

This is an ease-of-use accessor for event streams which should only be used when an explicit accessor is not available.

Inherited from EventTarget.

Implementation

Events get on => new Events(this);

onBoundary no setter#

Stream<SpeechSynthesisEvent> get onBoundary

Stream of boundary events handled by this SpeechSynthesisUtterance.

Implementation

Stream<SpeechSynthesisEvent> get onBoundary => boundaryEvent.forTarget(this);

onEnd no setter#

Stream<SpeechSynthesisEvent> get onEnd

Stream of end events handled by this SpeechSynthesisUtterance.

Implementation

Stream<SpeechSynthesisEvent> get onEnd => endEvent.forTarget(this);

onError no setter#

Stream<Event> get onError

Stream of error events handled by this SpeechSynthesisUtterance.

Implementation

Stream<Event> get onError => errorEvent.forTarget(this);

onMark no setter#

Stream<SpeechSynthesisEvent> get onMark

Stream of mark events handled by this SpeechSynthesisUtterance.

Implementation

Stream<SpeechSynthesisEvent> get onMark => markEvent.forTarget(this);

onPause no setter#

Stream<Event> get onPause

Stream of pause events handled by this SpeechSynthesisUtterance.

Implementation

Stream<Event> get onPause => pauseEvent.forTarget(this);

onResume no setter#

Stream<SpeechSynthesisEvent> get onResume

Stream of resume events handled by this SpeechSynthesisUtterance.

Implementation

Stream<SpeechSynthesisEvent> get onResume => resumeEvent.forTarget(this);

onStart no setter#

Stream<SpeechSynthesisEvent> get onStart

Stream of start events handled by this SpeechSynthesisUtterance.

Implementation

Stream<SpeechSynthesisEvent> get onStart => startEvent.forTarget(this);

pitch read / write#

num? get pitch

Implementation

num? get pitch native;

set pitch(num? value) native;

rate read / write#

num? get rate

Implementation

num? get rate native;

set rate(num? value) native;

runtimeType no setter inherited#

Type get runtimeType

Inherited from Interceptor.

Implementation

Type get runtimeType =>
    getRuntimeTypeOfInterceptorNotArray(getInterceptor(this), this);

text read / write#

String? get text

Implementation

String? get text native;

set text(String? value) native;

voice read / write#

SpeechSynthesisVoice? get voice

Implementation

SpeechSynthesisVoice? get voice native;

set voice(SpeechSynthesisVoice? value) native;

volume read / write#

num? get volume

Implementation

num? get volume native;

set volume(num? value) native;

Methods#

addEventListener() inherited#

void addEventListener( String type, dynamic Function(Event event)? listener, [ bool? useCapture, ]);

Inherited from EventTarget.

Implementation

void addEventListener(
  String type,
  EventListener? listener, [
  bool? useCapture,
]) {
  &#47;&#47; TODO(leafp): This check is avoid a bug in our dispatch code when
  &#47;&#47; listener is null.  The browser treats this call as a no-op in this
  &#47;&#47; case, so it's fine to short-circuit it, but we should not have to.
  if (listener != null) {
    _addEventListener(type, listener, useCapture);
  }
}

dispatchEvent() inherited#

bool dispatchEvent(Event event)

Inherited from EventTarget.

Implementation

bool dispatchEvent(Event event) native;

noSuchMethod() inherited#

dynamic noSuchMethod(Invocation invocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Interceptor.

Implementation

dynamic noSuchMethod(Invocation invocation) {
  throw NoSuchMethodError.withInvocation(this, invocation);
}

removeEventListener() inherited#

void removeEventListener( String type, dynamic Function(Event event)? listener, [ bool? useCapture, ]);

Inherited from EventTarget.

Implementation

void removeEventListener(
  String type,
  EventListener? listener, [
  bool? useCapture,
]) {
  &#47;&#47; TODO(leafp): This check is avoid a bug in our dispatch code when
  &#47;&#47; listener is null.  The browser treats this call as a no-op in this
  &#47;&#47; case, so it's fine to short-circuit it, but we should not have to.
  if (listener != null) {
    _removeEventListener(type, listener, useCapture);
  }
}

toString() inherited#

String toString()

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Interceptor.

Implementation

String toString() => Primitives.objectToHumanReadableString(this);

Operators#

operator ==() inherited#

bool operator ==(Object other)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

Total: It must return a boolean for all arguments. It should never throw.
Reflexive: For all objects o, o == o must be true.
Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.
Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Interceptor.

Implementation

bool operator ==(Object other) => identical(this, other);

Constants#

boundaryEvent#

const EventStreamProvider<SpeechSynthesisEvent> boundaryEvent

Static factory designed to expose boundary events to event handlers that are not necessarily instances of SpeechSynthesisUtterance.

See EventStreamProvider for usage information.

Implementation

static const EventStreamProvider<SpeechSynthesisEvent> boundaryEvent =
    const EventStreamProvider<SpeechSynthesisEvent>('boundary');

endEvent#

const EventStreamProvider<SpeechSynthesisEvent> endEvent

Static factory designed to expose end events to event handlers that are not necessarily instances of SpeechSynthesisUtterance.

See EventStreamProvider for usage information.

Implementation

static const EventStreamProvider<SpeechSynthesisEvent> endEvent =
    const EventStreamProvider<SpeechSynthesisEvent>('end');

errorEvent#

const EventStreamProvider<Event> errorEvent

Static factory designed to expose error events to event handlers that are not necessarily instances of SpeechSynthesisUtterance.

See EventStreamProvider for usage information.

Implementation

static const EventStreamProvider<Event> errorEvent =
    const EventStreamProvider<Event>('error');

markEvent#

const EventStreamProvider<SpeechSynthesisEvent> markEvent

Static factory designed to expose mark events to event handlers that are not necessarily instances of SpeechSynthesisUtterance.

See EventStreamProvider for usage information.

Implementation

static const EventStreamProvider<SpeechSynthesisEvent> markEvent =
    const EventStreamProvider<SpeechSynthesisEvent>('mark');

pauseEvent#

const EventStreamProvider<Event> pauseEvent

Static factory designed to expose pause events to event handlers that are not necessarily instances of SpeechSynthesisUtterance.

See EventStreamProvider for usage information.

Implementation

static const EventStreamProvider<Event> pauseEvent =
    const EventStreamProvider<Event>('pause');

resumeEvent#

const EventStreamProvider<SpeechSynthesisEvent> resumeEvent

Static factory designed to expose resume events to event handlers that are not necessarily instances of SpeechSynthesisUtterance.

See EventStreamProvider for usage information.

Implementation

static const EventStreamProvider<SpeechSynthesisEvent> resumeEvent =
    const EventStreamProvider<SpeechSynthesisEvent>('resume');

startEvent#

const EventStreamProvider<SpeechSynthesisEvent> startEvent

Static factory designed to expose start events to event handlers that are not necessarily instances of SpeechSynthesisUtterance.

See EventStreamProvider for usage information.

Implementation

static const EventStreamProvider<SpeechSynthesisEvent> startEvent =
    const EventStreamProvider<SpeechSynthesisEvent>('start');