AWSPollyStartSpeechSynthesisTaskInput

Objective-C

@interface AWSPollyStartSpeechSynthesisTaskInput

Swift

class AWSPollyStartSpeechSynthesisTaskInput

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

    Declaration

    Objective-C

    @property (nonatomic) AWSPollyEngine engine;

    Swift

    var engine: AWSPollyEngine { get set }

  • Optional language code for the Speech Synthesis request. 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 uses 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.

    Declaration

    Objective-C

    @property (nonatomic) AWSPollyLanguageCode languageCode;

    Swift

    var languageCode: AWSPollyLanguageCode { get set }

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

    Declaration

    Objective-C

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

    Swift

    var lexiconNames: [String]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSPollyOutputFormat outputFormat;

    Swift

    var outputFormat: AWSPollyOutputFormat { get set }

  • Amazon S3 bucket name to which the output file will be saved.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable outputS3BucketName;

    Swift

    var outputS3BucketName: String? { get set }

  • The Amazon S3 key prefix for the output speech file.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable outputS3KeyPrefix;

    Swift

    var outputS3KeyPrefix: String? { get set }

  • The audio frequency specified in Hz.

    The valid values for mp3 and ogg_vorbis are “8000”, “16000”, “22050”, and “24000”. The default value for standard voices is “22050”. The default value for neural voices is “24000”. The default value for long-form voices is “24000”. The default value for generative voices is “24000”.

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable sampleRate;

    Swift

    var sampleRate: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable snsTopicArn;

    Swift

    var snsTopicArn: String? { get set }

  • The type of speech marks returned for the input text.

    Declaration

    Objective-C

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

    Swift

    var speechMarkTypes: [String]? { get set }

  • The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable text;

    Swift

    var text: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSPollyTextType textType;

    Swift

    var textType: AWSPollyTextType { get set }

  • Voice ID to use for the synthesis.

    Declaration

    Objective-C

    @property (nonatomic) AWSPollyVoiceId voiceId;

    Swift

    var voiceId: AWSPollyVoiceId { get set }