whisper.rn/lib/typescript/index.d.ts

React Native binding of whisper.cpp

import './jsi';
import type { NativeWhisperContext, NativeWhisperVadContext, TranscribeOptions, TranscribeResult, VadOptions, VadSegment } from './NativeRNWhisper';
type CoreMLModelAssetOptions = {
    filename: string;
    assets: string[] | number[];
};
export declare const installJsi: () => Promise<void>;
export type { TranscribeOptions, TranscribeResult, VadOptions, VadSegment, };
export type TranscribeNewSegmentsResult = {
    nNew: number;
    totalNNew: number;
    result: string;
    segments: TranscribeResult['segments'];
};
export interface TranscribeFileOptions extends TranscribeOptions {
    /** Progress callback, the progress is between 0 and 100 */
    onProgress?: (progress: number) => void;
    /** Callback when new segments are transcribed */
    onNewSegments?: (result: TranscribeNewSegmentsResult) => void;
}
export type BenchResult = {
    config: string;
    nThreads: number;
    encodeMs: number;
    decodeMs: number;
    batchMs: number;
    promptMs: number;
};
export declare class WhisperContext {
    ptr: number;
    id: number;
    gpu: boolean;
    reasonNoGPU: string;
    constructor({ contextPtr, contextId, gpu, reasonNoGPU, }: NativeWhisperContext);
    private runTranscription;
    /**
     * Transcribe audio file (path or base64 encoded wav file)
     * base64: need add `data:audio/wav;base64,` prefix
     */
    transcribe(filePathOrBase64: string | number, options?: TranscribeFileOptions): {
        /** Stop the transcribe */
        stop: () => Promise<void>;
        /** Transcribe result promise */
        promise: Promise<TranscribeResult>;
    };
    /**
     * Transcribe audio data (base64 encoded float32 PCM data or ArrayBuffer)
     */
    transcribeData(data: string | ArrayBuffer, options?: TranscribeFileOptions): {
        stop: () => Promise<void>;
        promise: Promise<TranscribeResult>;
    };
    bench(maxThreads: number): Promise<BenchResult>;
    release(): Promise<void>;
}
export type ContextOptions = {
    filePath: string | number;
    /**
     * CoreML model assets, if you're using `require` on filePath,
     * use this option is required if you want to enable Core ML,
     * you will need bundle weights/weight.bin, model.mil, coremldata.bin into app by `require`
     */
    coreMLModelAsset?: CoreMLModelAssetOptions;
    /** Is the file path a bundle asset for pure string filePath */
    isBundleAsset?: boolean;
    /** Prefer to use Core ML model if exists. If set to false, even if the Core ML model exists, it will not be used. */
    useCoreMLIos?: boolean;
    /** Use GPU if available. Currently iOS only, if it's enabled, Core ML option will be ignored. */
    useGpu?: boolean;
    /** Use Flash Attention, only recommended if GPU available */
    useFlashAttn?: boolean;
};
/**
 * Initialize a whisper context with a GGML model file
 * @param options Whisper context options
 * @returns Promise resolving to WhisperContext instance
 */
export declare function initWhisper({ filePath, coreMLModelAsset, isBundleAsset, useGpu, useCoreMLIos, useFlashAttn, }: ContextOptions): Promise<WhisperContext>;
export declare function releaseAllWhisper(): Promise<void>;
/** Current version of whisper.cpp */
export declare const libVersion: string;
/** Is use CoreML models on iOS */
export declare const isUseCoreML: boolean;
/** Is allow fallback to CPU if load CoreML model failed */
export declare const isCoreMLAllowFallback: boolean;
export type VadContextOptions = {
    filePath: string | number;
    /** Is the file path a bundle asset for pure string filePath */
    isBundleAsset?: boolean;
    /** Use GPU if available. Currently iOS only */
    useGpu?: boolean;
    /** Number of threads to use during computation (Default: 2 for 4-core devices, 4 for more cores) */
    nThreads?: number;
};
export declare class WhisperVadContext {
    id: number;
    gpu: boolean;
    reasonNoGPU: string;
    constructor({ contextId, gpu, reasonNoGPU }: NativeWhisperVadContext);
    /**
     * Detect speech segments in audio file (path or base64 encoded wav file)
     * base64: need add `data:audio/wav;base64,` prefix
     */
    detectSpeech(filePathOrBase64: string | number, options?: VadOptions): Promise<VadSegment[]>;
    /**
     * Detect speech segments in raw audio data (base64 encoded float32 PCM data or ArrayBuffer)
     */
    detectSpeechData(audioData: string | ArrayBuffer, options?: VadOptions): Promise<VadSegment[]>;
    release(): Promise<void>;
}
/**
 * Initialize a VAD context for voice activity detection
 * @param options VAD context options
 * @returns Promise resolving to WhisperVadContext instance
 */
export declare function initWhisperVad({ filePath, isBundleAsset, useGpu, nThreads, }: VadContextOptions): Promise<WhisperVadContext>;
/**
 * Release all VAD contexts and free their memory
 * @returns Promise resolving when all contexts are released
 */
export declare function releaseAllWhisperVad(): Promise<void>;
/** Enable or disable native whisper.cpp logging */
export declare function toggleNativeLog(enabled: boolean): Promise<void>;
/** Add a listener for native whisper.cpp log output */
export declare function addNativeLogListener(listener: (level: string, text: string) => void): {
    remove: () => void;
};
//# sourceMappingURL=index.d.ts.map