@aws-sdk/client-transcribe-streaming
![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-transcribe-streaming.svg)
Description
AWS SDK for JavaScript TranscribeStreaming Client for Node.js, Browser and React Native.
Operations and objects for transcribing streaming speech to text.
Installing
To install the this package, simply type add or install @aws-sdk/client-transcribe-streaming
using your favorite package manager:
npm install @aws-sdk/client-transcribe-streaming
yarn add @aws-sdk/client-transcribe-streaming
pnpm add @aws-sdk/client-transcribe-streaming
Getting Started
Import
The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the TranscribeStreamingClient
and
the commands you need, for example StartMedicalStreamTranscriptionCommand
:
const {
TranscribeStreamingClient,
StartMedicalStreamTranscriptionCommand,
} = require("@aws-sdk/client-transcribe-streaming");
import {
TranscribeStreamingClient,
StartMedicalStreamTranscriptionCommand,
} from "@aws-sdk/client-transcribe-streaming";
Usage
To send a request, you:
- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call
send
operation on client with command object as input. - If you are using a custom http handler, you may call
destroy()
to close open connections.
const client = new TranscribeStreamingClient({ region: "REGION" });
const params = {
};
const command = new StartMedicalStreamTranscriptionCommand(params);
Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
try {
const data = await client.send(command);
} catch (error) {
} finally {
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.
Promises
You can also use Promise chaining
to execute send operation.
client.send(command).then(
(data) => {
},
(error) => {
}
);
Promises can also be called using .catch()
and .finally()
as follows:
client
.send(command)
.then((data) => {
})
.catch((error) => {
})
.finally(() => {
});
Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
client.send(command, (err, data) => {
});
v2 compatible style
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-transcribe-streaming";
const client = new AWS.TranscribeStreaming({ region: "REGION" });
try {
const data = client.startMedicalStreamTranscription(params);
} catch (error) {
}
client
.startMedicalStreamTranscription(params)
.then((data) => {
})
.catch((error) => {
});
client.startMedicalStreamTranscription(params, (err, data) => {
});
Troubleshooting
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);
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
}
Getting Help
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.
To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.
Contributing
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-transcribe-streaming
package is updated.
To contribute to client you can check our generate clients scripts.
License
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.