SpeechRecognition

class SpeechRecognition extends EventTarget

Annotations: @SupportedBrowser.new(SupportedBrowser.CHROME, '25'), @Native.new("SpeechRecognition,webkitSpeechRecognition")

Inheritance

Object → EventTarget → SpeechRecognition

Constructors

SpeechRecognition() factory

factory SpeechRecognition()

Implementation

factory SpeechRecognition() {
  return JS(
    'SpeechRecognition',
    'new (window.SpeechRecognition || window.webkitSpeechRecognition)()',
  );
}

Properties

audioTrack read / write

MediaStreamTrack? get audioTrack

Implementation

MediaStreamTrack? get audioTrack native;

set audioTrack(MediaStreamTrack? value) native;

continuous read / write

bool? get continuous

Implementation

bool? get continuous native;

set continuous(bool? value) native;

grammars read / write

SpeechGrammarList? get grammars

Implementation

SpeechGrammarList? get grammars native;

set grammars(SpeechGrammarList? value) native;

hashCode no setter inherited

int get hashCode

Inherited from Interceptor.

Implementation

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

interimResults read / write

bool? get interimResults

Implementation

bool? get interimResults native;

set interimResults(bool? value) native;

lang read / write

String? get lang

Implementation

String? get lang native;

set lang(String? value) native;

maxAlternatives read / write

int? get maxAlternatives

Implementation

int? get maxAlternatives native;

set maxAlternatives(int? 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);

onAudioEnd no setter

Stream<Event> get onAudioEnd

Stream of audioend events handled by this SpeechRecognition.

Implementation

Stream<Event> get onAudioEnd => audioEndEvent.forTarget(this);

onAudioStart no setter

Stream<Event> get onAudioStart

Stream of audiostart events handled by this SpeechRecognition.

Implementation

Stream<Event> get onAudioStart => audioStartEvent.forTarget(this);

onEnd no setter

Stream<Event> get onEnd

Stream of end events handled by this SpeechRecognition.

Implementation

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

onError no setter

Stream<SpeechRecognitionError> get onError

Stream of error events handled by this SpeechRecognition.

Implementation

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

onNoMatch no setter

Stream<SpeechRecognitionEvent> get onNoMatch

Stream of nomatch events handled by this SpeechRecognition.

Implementation

Stream<SpeechRecognitionEvent> get onNoMatch => noMatchEvent.forTarget(this);

onResult no setter

Stream<SpeechRecognitionEvent> get onResult

Stream of result events handled by this SpeechRecognition.

Implementation

Stream<SpeechRecognitionEvent> get onResult => resultEvent.forTarget(this);

onSoundEnd no setter

Stream<Event> get onSoundEnd

Stream of soundend events handled by this SpeechRecognition.

Implementation

Stream<Event> get onSoundEnd => soundEndEvent.forTarget(this);

onSoundStart no setter

Stream<Event> get onSoundStart

Stream of soundstart events handled by this SpeechRecognition.

Implementation

Stream<Event> get onSoundStart => soundStartEvent.forTarget(this);

onSpeechEnd no setter

Stream<Event> get onSpeechEnd

Stream of speechend events handled by this SpeechRecognition.

Implementation

Stream<Event> get onSpeechEnd => speechEndEvent.forTarget(this);

onSpeechStart no setter

Stream<Event> get onSpeechStart

Stream of speechstart events handled by this SpeechRecognition.

Implementation

Stream<Event> get onSpeechStart => speechStartEvent.forTarget(this);

onStart no setter

Stream<Event> get onStart

Stream of start events handled by this SpeechRecognition.

Implementation

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

runtimeType no setter inherited

Type get runtimeType

Inherited from Interceptor.

Implementation

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

Methods

abort()

void abort()

Implementation

void abort() native;

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,
]) {
  // TODO(leafp): This check is avoid a bug in our dispatch code when
  // listener is null.  The browser treats this call as a no-op in this
  // 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,
]) {
  // TODO(leafp): This check is avoid a bug in our dispatch code when
  // listener is null.  The browser treats this call as a no-op in this
  // case, so it's fine to short-circuit it, but we should not have to.
  if (listener != null) {
    _removeEventListener(type, listener, useCapture);
  }
}

start()

void start()

Implementation

void start() native;

stop()

void stop()

Implementation

void stop() native;

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);

Static Properties

supported no setter

bool get supported

Checks if this type is supported on the current platform.

Implementation

static bool get supported => JS(
  'bool',
  '!!(window.SpeechRecognition || window.webkitSpeechRecognition)',
);

Constants

audioEndEvent

const EventStreamProvider<Event> audioEndEvent

Static factory designed to expose audioend events to event handlers that are not necessarily instances of SpeechRecognition.

See EventStreamProvider for usage information.

Implementation

static const EventStreamProvider<Event> audioEndEvent =
    const EventStreamProvider<Event>('audioend');

audioStartEvent

const EventStreamProvider<Event> audioStartEvent

Static factory designed to expose audiostart events to event handlers that are not necessarily instances of SpeechRecognition.

See EventStreamProvider for usage information.

Implementation

static const EventStreamProvider<Event> audioStartEvent =
    const EventStreamProvider<Event>('audiostart');

endEvent

const EventStreamProvider<Event> endEvent

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

See EventStreamProvider for usage information.

Implementation

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

errorEvent

const EventStreamProvider<SpeechRecognitionError> errorEvent

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

See EventStreamProvider for usage information.

Implementation

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

noMatchEvent

const EventStreamProvider<SpeechRecognitionEvent> noMatchEvent

Static factory designed to expose nomatch events to event handlers that are not necessarily instances of SpeechRecognition.

See EventStreamProvider for usage information.

Implementation

static const EventStreamProvider<SpeechRecognitionEvent> noMatchEvent =
    const EventStreamProvider<SpeechRecognitionEvent>('nomatch');

resultEvent

const EventStreamProvider<SpeechRecognitionEvent> resultEvent

Static factory designed to expose result events to event handlers that are not necessarily instances of SpeechRecognition.

See EventStreamProvider for usage information.

Implementation

static const EventStreamProvider<SpeechRecognitionEvent> resultEvent =
    const EventStreamProvider<SpeechRecognitionEvent>('result');

soundEndEvent

const EventStreamProvider<Event> soundEndEvent

Static factory designed to expose soundend events to event handlers that are not necessarily instances of SpeechRecognition.

See EventStreamProvider for usage information.

Implementation

static const EventStreamProvider<Event> soundEndEvent =
    const EventStreamProvider<Event>('soundend');

soundStartEvent

const EventStreamProvider<Event> soundStartEvent

Static factory designed to expose soundstart events to event handlers that are not necessarily instances of SpeechRecognition.

See EventStreamProvider for usage information.

Implementation

static const EventStreamProvider<Event> soundStartEvent =
    const EventStreamProvider<Event>('soundstart');

speechEndEvent

const EventStreamProvider<Event> speechEndEvent

Static factory designed to expose speechend events to event handlers that are not necessarily instances of SpeechRecognition.

See EventStreamProvider for usage information.

Implementation

static const EventStreamProvider<Event> speechEndEvent =
    const EventStreamProvider<Event>('speechend');

speechStartEvent

const EventStreamProvider<Event> speechStartEvent

Static factory designed to expose speechstart events to event handlers that are not necessarily instances of SpeechRecognition.

See EventStreamProvider for usage information.

Implementation

static const EventStreamProvider<Event> speechStartEvent =
    const EventStreamProvider<Event>('speechstart');

startEvent

const EventStreamProvider<Event> startEvent

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

See EventStreamProvider for usage information.

Implementation

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