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.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-polly-browser\n```\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`PollyClient`) and the commands you need, for example `DeleteLexiconCommand`:\n\n```javascript\n//JavaScript\nconst { PollyClient } = require(\"@aws-sdk/client-polly-browser/PollyClient\");\nconst {\n DeleteLexiconCommand\n} = require(\"@aws-sdk/client-polly-browser/commands/DeleteLexiconCommand\");\n```\n\n```javascript\n//TypeScript\nimport { PollyClient } from \"@aws-sdk/client-polly-browser/PollyClient\";\nimport { DeleteLexiconCommand } from \"@aws-sdk/client-polly-browser/commands/DeleteLexiconCommand\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst polly = new PollyClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n Name: /**a string value*/,\n};\nconst deleteLexiconCommand = new DeleteLexiconCommand(params);\npolly.send(deleteLexiconCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await polly.send(deleteLexiconCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\npolly.send(deleteLexiconCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/@aws-sdk/client-polly-browser/Polly\";\nconst polly = new AWS.Polly({ region: \"region\" });\npolly.deleteLexicon(params, (err, data) => {\n //do something\n});\n```\n\nFor operations containing stream response like `SynthesizeSpeech()`, you can get response stream by accessing to streaming member. e.g. data.AudioStream.getReader().read().then(/_ do something and continue reading _/).(`data` is the resolved response object)\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await polly.send(deleteLexiconCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-polly-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","license":"Apache-2.0","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-polly-browser has been renamed to @aws-sdk/client-polly. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon Polly","directories":{},"maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.5","@aws-sdk/json-parser":"^0.1.0-preview.5","@aws-sdk/core-handler":"^0.1.0-preview.5","@aws-sdk/json-builder":"^0.1.0-preview.5","@aws-sdk/signature-v4":"^0.1.0-preview.7","@aws-sdk/protocol-rest":"^0.1.0-preview.7","@aws-sdk/config-resolver":"^0.1.0-preview.5","@aws-sdk/middleware-stack":"^0.1.0-preview.6","@aws-sdk/retry-middleware":"^0.1.0-preview.5","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.5","@aws-sdk/signing-middleware":"^0.1.0-preview.7","@aws-sdk/url-parser-browser":"^0.1.0-preview.5","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.5","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.6","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.6","@aws-sdk/stream-collector-browser":"^0.1.0-preview.5","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.5","@aws-sdk/middleware-header-default":"^0.1.0-preview.5"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"jest":"^24.7.1","karma":"^4.1.0","rimraf":"^2.6.2","typedoc":"^0.14.2","puppeteer":"^1.0.0","typescript":"~3.4.0","@types/jest":"^24.0.12","jasmine-core":"^3.4.0","karma-jasmine":"^2.0.1","karma-coverage":"^1.1.1","karma-typescript":"^4.0.0","karma-chrome-launcher":"^3.0.0","@aws-sdk/karma-credential-loader":"^0.1.0-preview.7","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-polly-browser_0.1.0-preview.3_1568908585691_0.6117260488819667","host":"s3://npm-registry-packages"},"_id":"@aws-sdk/client-polly-browser@0.1.0-preview.3","version":"0.1.0-preview.3"}