AWSPollySynthesisTask Class Reference

Inherits from AWSModel : AWSMTLModel
Declared in AWSPollyModel.h
AWSPollyModel.m

Overview

SynthesisTask object that provides information about a speech synthesis task.

  creationTime

Timestamp for the time the synthesis task was started.

@property (nonatomic, strong) NSDate *creationTime

Declared In

AWSPollyModel.h

  languageCode

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

If a bilingual voice is used and no language code is specified, Amazon Polly will use the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

@property (nonatomic, assign) AWSPollyLanguageCode languageCode

Declared In

AWSPollyModel.h

  lexiconNames

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.

@property (nonatomic, strong) NSArray<NSString*> *lexiconNames

Declared In

AWSPollyModel.h

  outputFormat

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.

@property (nonatomic, assign) AWSPollyOutputFormat outputFormat

Declared In

AWSPollyModel.h

  outputUri

Pathway for the output speech file.

@property (nonatomic, strong) NSString *outputUri

Declared In

AWSPollyModel.h

  requestCharacters

Number of billable characters synthesized.

@property (nonatomic, strong) NSNumber *requestCharacters

Declared In

AWSPollyModel.h

  sampleRate

The audio frequency specified in Hz.

The valid values for mp3 and ogg_vorbis are "8000", "16000", and "22050". The default value is "22050".

Valid values for pcm are "8000" and "16000" The default value is "16000".

@property (nonatomic, strong) NSString *sampleRate

Declared In

AWSPollyModel.h

  snsTopicArn

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

@property (nonatomic, strong) NSString *snsTopicArn

Declared In

AWSPollyModel.h

  speechMarkTypes

The type of speech marks returned for the input text.

@property (nonatomic, strong) NSArray<NSString*> *speechMarkTypes

Declared In

AWSPollyModel.h

  taskId

The Amazon Polly generated identifier for a speech synthesis task.

@property (nonatomic, strong) NSString *taskId

Declared In

AWSPollyModel.h

  taskStatus

Current status of the individual speech synthesis task.

@property (nonatomic, assign) AWSPollyTaskStatus taskStatus

Declared In

AWSPollyModel.h

  taskStatusReason

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

@property (nonatomic, strong) NSString *taskStatusReason

Declared In

AWSPollyModel.h

  textType

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

@property (nonatomic, assign) AWSPollyTextType textType

Declared In

AWSPollyModel.h

  voiceId

Voice ID to use for the synthesis.

@property (nonatomic, assign) AWSPollyVoiceId voiceId

Declared In

AWSPollyModel.h