# @dytesdk/aws-transcribe

> Package for audio transcriptions using Google Media Translation APIs.

Latest version **0.0.2** (published 2023-07-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @dytesdk/aws-transcribe
pnpm add @dytesdk/aws-transcribe
yarn add @dytesdk/aws-transcribe
bun add @dytesdk/aws-transcribe
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2023-07-20 |
| First published | 2023-07-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 200 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | https://github.com/dyte-in |
| Maintainers | dyteindia |

## Links

- npm: https://www.npmjs.com/package/@dytesdk/aws-transcribe
- Issues: https://community.dyte.io
- npm.io page: https://npm.io/package/@dytesdk/aws-transcribe

## Dependencies (5)

- [buffer](https://npm.io/package/buffer.md) ^6.0.3
- [events](https://npm.io/package/events.md) ^3.3.0
- [loglevel](https://npm.io/package/loglevel.md) ^1.8.0
- [@aws-sdk/util-utf8-node](https://npm.io/package/@aws-sdk/util-utf8-node.md) ^3.259.0
- [@aws-sdk/eventstream-marshaller](https://npm.io/package/@aws-sdk/eventstream-marshaller.md) ^3.120.0

## Recent versions

- 0.0.2 (latest) — 2023-07-20
- 0.0.1 — 2023-07-06

## README

<!-- PROJECT LOGO -->
<p align="center">
  <a href="https://dyte.io">
    <img src="https://dyte-uploads.s3.ap-south-1.amazonaws.com/dyte-logo-dark.svg" alt="Logo" width="80">
  </a>
  <h2 align="center">AWS Transcribe & translations by Dyte</h3>
  <p align="center">
    <br />
    <a href="https://docs.dyte.io"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://github.com/dyte-in/aws-transcribe/issues">Report Bug</a>
    •
    <a href="https://github.com/dyte-in/aws-transcribe/issues">Request Feature</a>
  </p>
</p>

<!-- TABLE OF CONTENTS -->
## Table of Contents
- [About the Project](#about-the-project)
  - [Built With](#built-with)
- [Getting Started](#getting-started)
  - [Prerequisites](#prerequisites)
  - [Installation](#installation)
  <!-- - [Quickstart](#quickstart) -->
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

## About The Project
This package provides audio transcriptions in various [languages](https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html).
### Built With
- [Dyte](https://dyte.io/)
- [Typescript](https://typescriptlang.org/)

<!-- GETTING STARTED -->
## Getting Started
### Prerequisites
- npm
- server, running https://github.com/dyte-in/aws-transcribe/tree/main/server, this runs a server on localhost:3001

### Installation
```sh
npm i @dytesdk/aws-transcribe
```

<!-- USAGE EXAMPLES -->
## Usage
A speech object can be created using `DyteAWSTranscribe` class.
```ts
import DyteAWSTranscribe from '@dytesdk/aws-transcribe';

const awsTranscribe = new DyteAWSTranscribe({
    meeting,
    target: 'hi', // Optional if translate is false, Supported languages: https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html
    translate: true, // Control whether to translate the source language to target language or just transcribe
    source: 'en-US', // Supported languages: https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html
    preSignedUrlEndpoint: 'http://localhost:3001/aws-transcribe-presigned-url',
    translationEndpoint: 'http://localhost:3001/translate',
});




awsTranscribe.on('transcription', async (data) => {
    // ... do something with transcription
    // console.log(speech.transcriptions);
});

awsTranscribe.transcribe();

```

## Contributing
We really appreciate contributions in the form of bug reports and feature suggestions. Help us make Dyte better with your valuable contributions on our [forum]('https://discord.com/invite/pxRcdNufvk') 🙂.

## License
All rights reserved. © Dyte Inc.

---
_Source: https://npm.io/package/@dytesdk/aws-transcribe · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._