Project: /_project.yaml Book: /_book.yaml

fuchsia.accessibility.tts

PROTOCOLS

Engine {:#Engine}

Defined in fuchsia.accessibility.tts/tts.fidl

An interface to produce speech output. Assistive technology use an Engine to start producing speech output and set configuration parameters that control the speech. TODO(MI4-2452): Implement pause, stop and resume.

Enqueue {:#Enqueue}

Enqueues an utterance to be spoken. Speech is not started until Speak is called.

Request

Response

Speak {:#Speak}

Speaks all enqueued utterances. The method returns the value when they are all finished playing.

Request

Response

Cancel {:#Cancel}

Cancels current speech and also empties the queue.

Request

Response

TtsManager {:#TtsManager}

Defined in fuchsia.accessibility.tts/tts_manager.fidl

An interface to manage TTS for assistive technology.

The TTS Manager offers assistive technology a way to open a TTS engine to start producing speech output.

OpenEngine {:#OpenEngine}

A speaker is an assistive technology that wants to produce speech output. Only one speaker is allowed to have an open connection to the engine at a time. If already in use, BUSY error is returned.

Request

Response

EngineRegistry {:#EngineRegistry}

Defined in fuchsia.accessibility.tts/tts_registration.fidl

An interface for TTS Engines provide speech output.

RegisterEngine {:#RegisterEngine}

A TTS engine registers itself to start listening for incoming speech output requests through |engine|. At the moment, only one TTS Engine can be registered at a time. This registry owners the first engine to register itself. If an engine crashes and wants to register again, calling this method will restart the connection. An error is returned if another engine is already registered.

Request

Response

STRUCTS

Engine_Enqueue_Response {:#Engine_Enqueue_Response}

Defined in fuchsia.accessibility.tts/generated

Engine_Speak_Response {:#Engine_Speak_Response}

Defined in fuchsia.accessibility.tts/generated

TtsManager_OpenEngine_Response {:#TtsManager_OpenEngine_Response}

Defined in fuchsia.accessibility.tts/generated

EngineRegistry_RegisterEngine_Response {:#EngineRegistry_RegisterEngine_Response}

Defined in fuchsia.accessibility.tts/generated

ENUMS

Error {:#Error}

Type: uint32

Defined in fuchsia.accessibility.tts/tts.fidl

Error codes for TTS operations.

TABLES

VoiceParameters {:#VoiceParameters}

Defined in fuchsia.accessibility.tts/tts.fidl

Parameters of a voice. TODO(MI4-2453): Add extra voice parameters such as speech rate and pitch.

Utterance {:#Utterance}

Defined in fuchsia.accessibility.tts/tts.fidl

An utterance holds information about its message and how it should be spoken.

UNIONS

Engine_Enqueue_Result {:#Engine_Enqueue_Result}

Defined in fuchsia.accessibility.tts/generated

Engine_Speak_Result {:#Engine_Speak_Result}

Defined in fuchsia.accessibility.tts/generated

TtsManager_OpenEngine_Result {:#TtsManager_OpenEngine_Result}

Defined in fuchsia.accessibility.tts/generated

EngineRegistry_RegisterEngine_Result {:#EngineRegistry_RegisterEngine_Result}

Defined in fuchsia.accessibility.tts/generated