AWSPollySynthesizeSpeechURLBuilderRequest

Objective-C

@interface AWSPollySynthesizeSpeechURLBuilderRequest :NSObject

/**
 <p>List of one or more lexicon names you want the service to apply during synthesis. For information about storing lexicons, see .</p>
 */
@property (nonatomic, strong) NSArray<NSString *> * _Nullable lexiconNames;

/**
 <p>Optional language code for the Synthesize Speech 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). </p><p>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 <a href="https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html">DescribeVoices</a> operation for the <code>LanguageCode</code> parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.</p>
 */
@property (nonatomic, assign) AWSPollyLanguageCode languageCode;

/**
<p> Input text to synthesize. If you specify <code>ssml</code> as the <code>TextType</code>, follow the SSML format for the input text. </p>
 */
@property (nonatomic, strong) NSArray<NSString *> * _Nullable speechMarkTypes;

/**
 <p>Format to use for the resulting audio stream.</p>
 */
@property (nonatomic, assign) AWSPollyOutputFormat outputFormat;

/**
 <p>The audio frequency specified in Hz. </p><p> The valid values for <code>mp3</code> and <code>ogg_vorbis</code> are "8000", "16000", and "22050". The default value is 22050.</p><p>Valid values for <code>pcm</code> are "8000" and "16000". The default value is ???.</p>
 */
@property (nonatomic, strong) NSString * _Nullable sampleRate;

/**
 <p>Input text to synthesize. If you specify <code>ssml</code> as the <code>TextType</code>, follow the SSML format for the input text.</p>
 */
@property (nonatomic, strong) NSString * text;

/**
 <p>Specifies whether the input text is plain text or SSML. The default value is text. For more information about SSML, see <a>examples-ssml-input</a>.</p>
 */
@property (nonatomic, assign) AWSPollyTextType textType;

/**
 <p>Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the operation.</p>
 */
@property (nonatomic, assign) AWSPollyVoiceId voiceId;

/**
 The time when the signature expires, specified as an NSDate object.
 */
@property (nonatomic, strong) NSDate *expires;

/**
 Specifies the engine (standard or neural) 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.
 */
@property (nonatomic, assign) AWSPollyEngine engine;

@end

Swift

class AWSPollySynthesizeSpeechURLBuilderRequest : NSObject

Undocumented

  • List of one or more lexicon names you want the service to apply during synthesis. For information about storing lexicons, see .

    Declaration

    Objective-C

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

    Swift

    var lexiconNames: [String]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSPollyLanguageCode languageCode;

    Swift

    var languageCode: AWSPollyLanguageCode { get set }

  • 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) NSArray<NSString *> *_Nullable speechMarkTypes;

    Swift

    var speechMarkTypes: [String]? { get set }

  • Format to use for the resulting audio stream.

    Declaration

    Objective-C

    @property (nonatomic) AWSPollyOutputFormat outputFormat;

    Swift

    var outputFormat: AWSPollyOutputFormat { get set }

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

    Declaration

    Objective-C

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

    Swift

    var sampleRate: String? { get set }

  • 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 *_Nonnull text;

    Swift

    var text: String { get set }

  • Specifies whether the input text is plain text or SSML. The default value is text. For more information about SSML, see examples-ssml-input.

    Declaration

    Objective-C

    @property (nonatomic) AWSPollyTextType textType;

    Swift

    var textType: AWSPollyTextType { get set }

  • Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the operation.

    Declaration

    Objective-C

    @property (nonatomic) AWSPollyVoiceId voiceId;

    Swift

    var voiceId: AWSPollyVoiceId { get set }

  • The time when the signature expires, specified as an NSDate object.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nonnull expires;

    Swift

    var expires: Date { get set }

  • Specifies the engine (standard or neural) 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 }