/supported-formats

A package to test if your media file is supported for transcription.

Primary LanguageTypeScriptISC LicenseISC

Supported Formats

Circle CI Status 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.

Usage

$ npm install supported-formats
# $ yarn add supported-formats

Catch an error when a file isn't supported.

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.

$ npm install
# $ yarn

Tests

$ npm run test
# $ yarn test

Contributors

Would you like to contribute to this project? Check out our contributing guide.

Made with contrib.rocks.