silk-wasm/lib/index.d.ts

Tencent silk encoder for Node.js and browser

export interface EncodeResult {
    /** SILK */
    data: Uint8Array;
    /** in milliseconds */
    duration: number;
}
export interface DecodeResult {
    /** pcm_s16le */
    data: Uint8Array;
    /** in milliseconds */
    duration: number;
}
/** @deprecated use `EncodeResult` instead */
export interface encodeResult extends EncodeResult {
}
/** @deprecated use `DecodeResult` instead */
export interface decodeResult extends DecodeResult {
}
export interface WavFileInfo {
    chunkInfo: {
        chunkId: string;
        dataOffset: number;
        dataLength: number;
    }[];
    fmt: {
        formatCode: number;
        numberOfChannels: number;
        sampleRate: number;
        bytesPerSec: number;
        bytesPerFrame: number;
        bitsPerSample: number;
    };
}
/**
 * 编码为 SILK
 * @param input WAV 或单声道 pcm_s16le 文件
 * @param sampleRate `input` 的采样率，可为 8000/12000/16000/24000/32000/44100/48000，当 `input` 为 WAV 时可填入 0
 * @returns SILK
 */
export declare function encode(input: ArrayBufferView | ArrayBuffer, sampleRate: number): Promise<EncodeResult>;
/**
 * 将 SILK 解码为 PCM
 * @param input SILK 文件
 * @param sampleRate `input` 的采样率
 * @returns pcm_s16le
 */
export declare function decode(input: ArrayBufferView | ArrayBuffer, sampleRate: number): Promise<DecodeResult>;
/**
 * 获取 SILK 音频时长
 * @param data SILK 文件
 * @param frameMs SILK 的 frameMs，可为 20/40/60/80/100，默认为 20
 * @returns 单位为毫秒的时长
 */
export declare function getDuration(data: ArrayBufferView | ArrayBuffer, frameMs?: number): number;
/**
 * 检测是否为 WAV 文件
 * @param data 任意文件
 */
export declare function isWav(data: ArrayBufferView | ArrayBuffer): boolean;
/**
 * 获取 WAV 文件的信息
 * @param data WAV 文件
 * @returns metadata
 */
export declare function getWavFileInfo(data: ArrayBufferView | ArrayBuffer): WavFileInfo;
/**
 * 检测是否为 SILK 文件
 * @param data 任意文件
 */
export declare function isSilk(data: ArrayBufferView | ArrayBuffer): boolean;