voice-to-text-converter
Version:
A modern, lightweight Node.js package for speech-to-text conversion with support for multiple engines
64 lines • 2.5 kB
TypeScript
export { VoiceToText } from './voice-to-text';
export * from './types';
export * from './engines';
export * from './utils';
import { VoiceToText } from './voice-to-text';
export default VoiceToText;
export { WebSpeechEngine } from './engines/web-speech-engine';
export { VoskEngine } from './engines/vosk-engine';
export { GoogleCloudEngine } from './engines/google-cloud-engine';
import { VoiceToTextOptions, SpeechRecognitionConfig, SpeechRecognitionResult, EngineConfig, MicrophoneOptions } from './types';
/**
* Quick transcription from microphone
* @param options Microphone and recognition options
* @returns Promise resolving to transcription results
*/
export declare function transcribeFromMicrophone(options?: MicrophoneOptions & {
engine?: EngineConfig['engine'];
language?: string;
config?: SpeechRecognitionConfig;
}): Promise<SpeechRecognitionResult[]>;
/**
* Quick transcription from audio file
* @param filePath Path to audio file
* @param options Recognition options
* @returns Promise resolving to transcription results
*/
export declare function transcribeFromFile(filePath: string, options?: {
engine?: EngineConfig['engine'];
language?: string;
config?: SpeechRecognitionConfig;
}): Promise<SpeechRecognitionResult[]>;
/**
* Quick transcription from audio stream
* @param stream Audio stream
* @param options Recognition options
* @returns Promise resolving to transcription results
*/
export declare function transcribeFromStream(stream: NodeJS.ReadableStream, options?: {
engine?: EngineConfig['engine'];
language?: string;
config?: SpeechRecognitionConfig;
}): Promise<SpeechRecognitionResult[]>;
/**
* Create a VoiceToText instance with default configuration
* @param options Configuration options
* @returns Configured VoiceToText instance
*/
export declare function createVoiceToText(options?: VoiceToTextOptions): VoiceToText;
/**
* Check system capabilities and available engines
* @returns System information and available engines
*/
export declare function getSystemInfo(): {
platform: string;
nodeVersion?: string;
browserSupport?: any;
availableEngines: Array<EngineConfig['engine']>;
engineCapabilities: {
[key: string]: any;
};
};
export declare const VERSION = "1.0.0";
export type { VoiceToTextOptions, SpeechRecognitionConfig, SpeechRecognitionResult, AudioInputConfig, EngineConfig, MicrophoneOptions, BrowserSupport } from './types';
//# sourceMappingURL=index.d.ts.map