@aws-sdk/client-polly
Advanced tools
AWS SDK for JavaScript Polly Client for Node.js, Browser and React Native
@aws-sdk/client-polly is an AWS SDK for JavaScript package that allows developers to interact with Amazon Polly, a service that turns text into lifelike speech. This package provides a variety of functionalities to synthesize speech, manage lexicons, and retrieve information about available voices and speech synthesis tasks.
Synthesize Speech
This feature allows you to convert text into speech. The code sample demonstrates how to synthesize speech using the PollyClient and SynthesizeSpeechCommand classes.
const { PollyClient, SynthesizeSpeechCommand } = require('@aws-sdk/client-polly');
const client = new PollyClient({ region: 'us-west-2' });
const params = {
OutputFormat: 'mp3',
Text: 'Hello, world!',
VoiceId: 'Joanna'
};
const command = new SynthesizeSpeechCommand(params);
client.send(command).then((data) => {
// Handle the audio stream in data.AudioStream
}).catch((error) => {
console.error(error);
});List Voices
This feature allows you to retrieve a list of available voices. The code sample demonstrates how to list voices using the PollyClient and DescribeVoicesCommand classes.
const { PollyClient, DescribeVoicesCommand } = require('@aws-sdk/client-polly');
const client = new PollyClient({ region: 'us-west-2' });
const command = new DescribeVoicesCommand({});
client.send(command).then((data) => {
console.log(data.Voices);
}).catch((error) => {
console.error(error);
});Manage Lexicons
This feature allows you to manage custom pronunciation lexicons. The code sample demonstrates how to list lexicons using the PollyClient and ListLexiconsCommand classes.
const { PollyClient, ListLexiconsCommand } = require('@aws-sdk/client-polly');
const client = new PollyClient({ region: 'us-west-2' });
const command = new ListLexiconsCommand({});
client.send(command).then((data) => {
console.log(data.Lexicons);
}).catch((error) => {
console.error(error);
});The google-cloud-text-to-speech package is a client library for Google's Text-to-Speech API. It provides similar functionalities to @aws-sdk/client-polly, such as converting text to speech and managing voices. However, it is specific to Google's cloud services and offers different voice options and languages.
The microsoft-cognitiveservices-speech-sdk package is a client library for Microsoft's Azure Cognitive Services Speech API. It offers text-to-speech conversion, speech recognition, and translation features. Compared to @aws-sdk/client-polly, it provides a broader range of speech-related functionalities and integrates with Microsoft's Azure ecosystem.
The ibm-watson package is a client library for IBM's Watson Text to Speech service. It allows developers to convert text to speech, manage custom voices, and handle pronunciation lexicons. While it offers similar text-to-speech capabilities as @aws-sdk/client-polly, it is tailored for IBM's Watson services and provides unique voice customization options.
AWS SDK for JavaScript Polly Client for Node.js, Browser and React Native.
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.
To install the this package, simply type add or install @aws-sdk/client-polly using your favorite package manager:
npm install @aws-sdk/client-pollyyarn add @aws-sdk/client-pollypnpm add @aws-sdk/client-pollyThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the PollyClient and
the commands you need, for example ListLexiconsCommand:
// ES5 example
const { PollyClient, ListLexiconsCommand } = require("@aws-sdk/client-polly");
// ES6+ example
import { PollyClient, ListLexiconsCommand } from "@aws-sdk/client-polly";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new PollyClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListLexiconsCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-polly";
const client = new AWS.Polly({ region: "REGION" });
// async/await.
try {
const data = await client.listLexicons(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listLexicons(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listLexicons(params, (err, data) => {
// process err and data.
});
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-polly package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
3.588.0 (2024-05-31)
FAQs
AWS SDK for JavaScript Polly Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-polly receives a total of 211,432 weekly downloads. As such, @aws-sdk/client-polly popularity was classified as popular.
We found that @aws-sdk/client-polly demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.
Security News
Research
The Socket Research Team uncovered a malicious Python package typosquatting the popular 'fabric' SSH library, silently exfiltrating AWS credentials from unsuspecting developers.
Security News
At its inaugural meeting, the JSR Working Group outlined plans for an open governance model and a roadmap to enhance JavaScript package management.