Text to Speech Module Reference

Related documents

• MVCS index

Table of contents

• Introduction
  • speech
• speech methods
  • speech.isSpeak()
  • speech.speak()

Introduction

The Text to Speech module contains an interface to the DOM or Cordova text-to-speech functions. WebApps will use the DOM, while native Cordova apps will use the Android or iOS native text-to-speech interface.

speech

Syntax

import {speech} from 'common/option/speech.js';

The speech object contains methods for the DOM text-to-speech functions.

speech methods

speech.isSpeak()

Syntax

ctxDraw.isSpeak()

Returns true if text-to-speech is available.

Return value

A Boolean.

speech.speak()

Syntax

ctxDraw.speak(text)
ctxDraw.speak(text, options)

Speaks the text on the device. The options argument can change the speech rate. The method returns a Promise that resolves when the speech is completed. It's up to the caller add delay between speech or to ensure that the next speach is queued only after current speach completes.

Parameters

• text
  A string to speak.
• options
  An object containing any of the following properties:
  • rate
    A number indicating the rate of speech. For example, a rate of 2 would double the speech speed. If omitted, 1 is assumed.

Return value

A Promise that resolves or rejects when the speech is complete.