https://github.com/lukeocodes/supported-formats
A package to test if your media file is supported for transcription.
https://github.com/lukeocodes/supported-formats
ai audio deepgram javascript node srt subtitles transcribe transcript typescript video webvtt
Last synced: about 2 months ago
JSON representation
A package to test if your media file is supported for transcription.
- Host: GitHub
- URL: https://github.com/lukeocodes/supported-formats
- Owner: lukeocodes
- License: isc
- Created: 2022-02-25T06:19:35.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-19T10:30:59.000Z (over 2 years ago)
- Last Synced: 2025-02-13T23:46:33.520Z (about 1 year ago)
- Topics: ai, audio, deepgram, javascript, node, srt, subtitles, transcribe, transcript, typescript, video, webvtt
- Language: TypeScript
- Homepage:
- Size: 247 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Supported Formats
[](https://app.circleci.com/pipelines/github/lukeocodes/supported-formats?filter=all)
[](https://choosealicense.com/licenses/isc/)
This package is simply a small test to check if your filetype is supported for transcription by Deepgram. Deepgram supports over 100 different audio formats and encodings. For example, some of the most common audio formats and encodings we support include MP3, MP4, MP2, AAC, WAV, FLAC, PCM, M4A, Ogg, Opus, and WebM.
> Because audio format is largely unconstrained, we always recommend to ensure compatibility by testing small sets of audio when first operating with new audio sources.
This is not an exhaustive or official list. If it isn't on the list, try it anyway. You might find the audio source can be transcribed.
# Issues
For problems directly related to this package, [add an issue on GitHub](https://github.com/lukeocodes/supported-formats/issues/new).
# Usage
```sh-session
$ npm install supported-formats
# $ yarn add supported-formats
```
Catch an error when a file isn't supported.
```js
import { supported } from "supported-formats";
try {
supported(filePath);
// is supported
} catch (err: any) {
this.error(err);
// is not supported
}
```
# Developing
This project can be cloned and ran locally.
```sh-session
$ npm install
# $ yarn
```
# Tests
```sh-session
$ npm run test
# $ yarn test
```
# Contributors
Would you like to contribute to this project? Check out our [contributing guide](./.github/CONTRIBUTING.md).
Made with [contrib.rocks](https://contrib.rocks).