Classes
The following classes are available globally.
-
Declaration
Objective-C
@interface AWSPollyDeleteLexiconInput
Swift
class AWSPollyDeleteLexiconInput
-
Declaration
Objective-C
@interface AWSPollyDeleteLexiconOutput
Swift
class AWSPollyDeleteLexiconOutput
-
Declaration
Objective-C
@interface AWSPollyDescribeVoicesInput
Swift
class AWSPollyDescribeVoicesInput
-
Declaration
Objective-C
@interface AWSPollyDescribeVoicesOutput
Swift
class AWSPollyDescribeVoicesOutput
-
Declaration
Objective-C
@interface AWSPollyGetLexiconInput
Swift
class AWSPollyGetLexiconInput
-
Declaration
Objective-C
@interface AWSPollyGetLexiconOutput
Swift
class AWSPollyGetLexiconOutput
-
Declaration
Objective-C
@interface AWSPollyGetSpeechSynthesisTaskInput
Swift
class AWSPollyGetSpeechSynthesisTaskInput
-
Declaration
Objective-C
@interface AWSPollyGetSpeechSynthesisTaskOutput
Swift
class AWSPollyGetSpeechSynthesisTaskOutput
-
Provides lexicon name and lexicon content in string format. For more information, see Pronunciation Lexicon Specification (PLS) Version 1.0.
See moreDeclaration
Objective-C
@interface AWSPollyLexicon
Swift
class AWSPollyLexicon
-
Contains metadata describing the lexicon such as the number of lexemes, language code, and so on. For more information, see Managing Lexicons.
See moreDeclaration
Objective-C
@interface AWSPollyLexiconAttributes
Swift
class AWSPollyLexiconAttributes
-
Describes the content of the lexicon.
See moreDeclaration
Objective-C
@interface AWSPollyLexiconDescription
Swift
class AWSPollyLexiconDescription
-
Declaration
Objective-C
@interface AWSPollyListLexiconsInput
Swift
class AWSPollyListLexiconsInput
-
Declaration
Objective-C
@interface AWSPollyListLexiconsOutput
Swift
class AWSPollyListLexiconsOutput
-
Declaration
Objective-C
@interface AWSPollyListSpeechSynthesisTasksInput
Swift
class AWSPollyListSpeechSynthesisTasksInput
-
Declaration
Objective-C
@interface AWSPollyListSpeechSynthesisTasksOutput
Swift
class AWSPollyListSpeechSynthesisTasksOutput
-
Declaration
Objective-C
@interface AWSPollyPutLexiconInput
Swift
class AWSPollyPutLexiconInput
-
Declaration
Objective-C
@interface AWSPollyPutLexiconOutput
Swift
class AWSPollyPutLexiconOutput
-
Declaration
Objective-C
@interface AWSPollyStartSpeechSynthesisTaskInput
Swift
class AWSPollyStartSpeechSynthesisTaskInput
-
Declaration
Objective-C
@interface AWSPollyStartSpeechSynthesisTaskOutput
Swift
class AWSPollyStartSpeechSynthesisTaskOutput
-
SynthesisTask object that provides information about a speech synthesis task.
See moreDeclaration
Objective-C
@interface AWSPollySynthesisTask
Swift
class AWSPollySynthesisTask
-
Declaration
Objective-C
@interface AWSPollySynthesizeSpeechInput
Swift
class AWSPollySynthesizeSpeechInput
-
Declaration
Objective-C
@interface AWSPollySynthesizeSpeechOutput
Swift
class AWSPollySynthesizeSpeechOutput
-
Description of the voice.
See moreDeclaration
Objective-C
@interface AWSPollyVoice
Swift
class AWSPollyVoice
-
Undocumented
See moreDeclaration
Objective-C
@interface AWSPollyResources : NSObject + (instancetype)sharedInstance; - (NSDictionary *)JSONObject; @end
Swift
class AWSPollyResources : NSObject
-
Amazon Polly is a web service that makes it easy to synthesize speech from text.
The Amazon Polly service provides API operations for synthesizing high-quality speech from plain text and Speech Synthesis Markup Language (SSML), along with managing pronunciations lexicons that enable you to get the best results for your application domain.
See moreDeclaration
Objective-C
@interface AWSPolly
Swift
class AWSPolly
-
Undocumented
See moreDeclaration
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
See moreDeclaration
Objective-C
@interface AWSPollySynthesizeSpeechURLBuilder : NSObject /** Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with `defaultServiceConfiguration` from `[AWSServiceManager defaultServiceManager]`. The reference to this object is maintained by the SDK, and you do not need to retain it manually. For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:` *Swift* func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider) AWSServiceManager.default().defaultServiceConfiguration = configuration return true } *Objective-C* - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:@"YourIdentityPoolId"]; AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1 credentialsProvider:credentialsProvider]; [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration; return YES; } Then call the following to get the default service client: *Swift* let PollyURLBuilder = AWSPollySynthesizeSpeechURLBuilder.default() *Objective-C* AWSPollySynthesizeSpeechURLBuilder *PollyURLBuilder = [AWSPollySynthesizeSpeechURLBuilder defaultPollySynthesizeSpeechURLBuilder]; @return The default service client. */ + (instancetype)defaultPollySynthesizeSpeechURLBuilder; /** Creates a service client with the given service configuration and registers it for the key. For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:` *Swift* func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) AWSPollySynthesizeSpeechURLBuilder.register(configuration, forKey: "USWest2Polly") return true } *Objective-C* - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:@"YourIdentityPoolId"]; AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 credentialsProvider:credentialsProvider]; [AWSPollySynthesizeSpeechURLBuilder registerPollySynthesizeSpeechURLBuilder:configuration forKey:@"USWest2Polly"]; return YES; } Then call the following to get the service client: *Swift* let PollyURLBuilder = AWSPollySynthesizeSpeechURLBuilder(forKey: "USWest2Polly") *Objective-C* AWSPollySynthesizeSpeechURLBuilder *PollyURLBuilder = [AWSPollySynthesizeSpeechURLBuilder PollySynthesizeSpeechURLBuilderForKey:@"USWest2Polly"]; @warning After calling this method, do not modify the configuration object. It may cause unspecified behaviors. @param configuration A service configuration object. @param key A string to identify the service client. */ + (void)registerPollySynthesizeSpeechURLBuilder:(AWSServiceConfiguration *)configuration forKey:(NSString *)key; /** Creates a service client with the given service configuration and registers it for the key. For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:` *Swift* func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) AWSPollySynthesizeSpeechURLBuilder.register(configuration, forKey: "USWest2Polly") return true } *Objective-C* - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:@"YourIdentityPoolId"]; AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 credentialsProvider:credentialsProvider]; [AWSPollySynthesizeSpeechURLBuilder registerPollySynthesizeSpeechURLBuilder:configuration forKey:@"USWest2Polly"]; return YES; } Then call the following to get the service client: *Swift* let Polly = AWSPollySynthesizeSpeechURLBuilder(forKey: "USWest2Polly") *Objective-C* AWSPollySynthesizeSpeechURLBuilder *Polly = [AWSPollySynthesizeSpeechURLBuilder PollySynthesizeSpeechURLBuilderForKey:@"USWest2Polly"]; @warning After calling this method, do not modify the configuration object. It may cause unspecified behaviors. @param configuration A service configuration object. @param key A string to identify the service client. */ + (instancetype)PollySynthesizeSpeechURLBuilderForKey:(NSString *)key; /** Removes the service client associated with the key and release it. @warning Before calling this method, make sure no method is running on this client. @param key A string to identify the service client. */ + (void)removePollySynthesizeSpeechURLBuilderForKey:(NSString *)key; /** Build a time-limited pre-signed URL to synthesize speech from Amazon Polly, return nil if build process failed. @param preSignedURLRequest The AWSPollySynthesizeSpeechURLBuilderRequest that defines the parameters of the operation. @return A pre-signed NSURL for the resource. return nil if any errors occured. @see AWSPollySynthesizeSpeechURLBuilderRequest */ - (AWSTask<NSURL *> *)getPreSignedURL:(AWSPollySynthesizeSpeechURLBuilderRequest *)getPreSignedURLRequest; @end
Swift
class AWSPollySynthesizeSpeechURLBuilder : NSObject