SynthesisTask

SynthesisTask object that provides information about a speech synthesis task.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Timestamp for the time the synthesis task was started.

Link copied to clipboard

Specifies the engine (standard, neural, long-form or generative) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.

Link copied to clipboard

Optional language code for a synthesis task. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

Link copied to clipboard

List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.

Link copied to clipboard

The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

Link copied to clipboard

Pathway for the output speech file.

Link copied to clipboard

Number of billable characters synthesized.

Link copied to clipboard

The audio frequency specified in Hz.

Link copied to clipboard

ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

Link copied to clipboard

The type of speech marks returned for the input text.

Link copied to clipboard

The Amazon Polly generated identifier for a speech synthesis task.

Link copied to clipboard

Current status of the individual speech synthesis task.

Link copied to clipboard

Reason for the current status of a specific speech synthesis task, including errors if the task has failed.

Link copied to clipboard

Specifies whether the input text is plain text or SSML. The default value is plain text.

Link copied to clipboard

Voice ID to use for the synthesis.

Functions

Link copied to clipboard
inline fun copy(block: SynthesisTask.Builder.() -> Unit = {}): SynthesisTask
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String