@cloud-app-dev/vidc 4.0.15 → 4.1.0

package/es/recorder/index.d.ts

@@ -0,0 +1,294 @@
+interface RecorderConfig {
+    sampleBits?: number;
+    sampleRate?: number;
+    numChannels?: number;
+    compiling?: boolean;
+}
+declare class Recorder {
+    private isrecording;
+    private isplaying;
+    private ispause;
+    private context;
+    private config;
+    private size;
+    private lBuffer;
+    private rBuffer;
+    private PCM;
+    private tempPCM;
+    private audioInput;
+    private inputSampleRate;
+    private source;
+    private recorder;
+    private outputSampleRate;
+    private oututSampleBits;
+    private analyser;
+    private littleEdian;
+    private prevDomainData;
+    private playStamp;
+    private playTime;
+    private totalPlayTime;
+    private offset;
+    private stream;
+    fileSize: number;
+    duration: number;
+    onprogress?: (payload: {
+        duration: number;
+        fileSize: number;
+        vol: number;
+        data: Array<DataView>;
+    }) => void | undefined;
+    /**
+     * @param {Object} options 包含以下三个参数：
+     * sampleBits，采样位数，一般8,16，默认16
+     * sampleRate，采样率，一般 11025、16000、22050、24000、44100、48000，默认为浏览器自带的采样率
+     * numChannels，声道，1或2
+     */
+    constructor(options?: RecorderConfig);
+    /**
+     * 初始化录音实例
+     */
+    initRecorder(): void;
+    /**
+     * 开始录音
+     *
+     * @returns {Promise<{}>}
+     * @memberof Recorder
+     */
+    start(): Promise<any>;
+    /**
+     * 暂停录音
+     *
+     * @memberof Recorder
+     */
+    pause(): void;
+    /**
+     * 继续录音
+     *
+     * @memberof Recorder
+     */
+    resume(): void;
+    /**
+     * 停止录音
+     *
+     * @memberof Recorder
+     */
+    stop(): void;
+    /**
+     * 播放录音
+     *
+     * @memberof Recorder
+     */
+    play(): void;
+    /**
+     * 获取音频文件已经播放了的时间
+     *
+     * @returns {number}
+     * @memberof Recorder
+     */
+    getPlayTime(): number;
+    /**
+     * 暂停播放录音
+     *
+     * @memberof Recorder
+     */
+    pausePlay(): void;
+    /**
+     * 恢复播放录音
+     *
+     * @memberof Recorder
+     */
+    resumePlay(): void;
+    /**
+     * 停止播放
+     *
+     * @memberof Recorder
+     */
+    stopPlay(): void;
+    /**
+     * 获取当前已经录音的PCM音频数据
+     *
+     * @returns[DataView]
+     * @memberof Recorder
+     */
+    getWholeData(): DataView[];
+    /**
+     * 获取余下的新数据，不包括 getNextData 前一次获取的数据
+     *
+     * @returns [DataView]
+     * @memberof Recorder
+     */
+    getNextData(): ArrayBuffer | undefined;
+    /**
+     * 利用 decodeAudioData播放录音数据，每次播放都需创建，因为buffersource只能被使用一次
+     *
+     * @private
+     * @memberof Recorder
+     */
+    private playAudioData;
+    /**
+     * 获取当前录音的波形数据，
+     * 调取频率由外部控制。
+     *
+     * @memberof Recorder
+     */
+    getRecordAnalyseData(): any;
+    /**
+     * 获取录音播放时的波形数据，
+     *
+     * @memberof Recorder
+     */
+    getPlayAnalyseData(): any;
+    /**
+     * 获取PCM编码的二进制数据(dataview)
+     *
+     * @returns {dataview}  PCM二进制数据
+     * @memberof Recorder
+     */
+    private getPCM;
+    /**
+     * 获取PCM格式的blob数据
+     *
+     * @returns { blob }  PCM格式的blob数据
+     * @memberof Recorder
+     */
+    getPCMBlob(): Blob;
+    /**
+     * 下载录音pcm数据
+     *
+     * @param {string} [name='recorder']    重命名的名字
+     * @memberof Recorder
+     */
+    downloadPCM(name?: string): void;
+    /**
+     * 获取WAV编码的二进制数据(dataview)
+     *
+     * @returns {dataview}  WAV编码的二进制数据
+     * @memberof Recorder
+     */
+    private getWAV;
+    /**
+     * 获取WAV音频的blob数据
+     *
+     * @returns { Blob }    wav格式blob数据
+     * @memberof Recorder
+     */
+    getWAVBlob(): Blob;
+    /**
+     * 下载录音的wav数据
+     *
+     * @param {string} [name='recorder']    重命名的名字
+     * @memberof Recorder
+     */
+    downloadWAV(name?: string): void;
+    /**
+     * 将获取到到左右声道的Float32Array数据编码转化
+     *
+     * @param {Float32Array} lData  左声道数据
+     * @param {Float32Array} rData  有声道数据
+     * @returns DataView
+     */
+    private transformIntoPCM;
+    /**
+     * 销毁录音对象
+     * @memberof Recorder
+     */
+    destroy(): Promise<any>;
+    /**
+     * 终止流（这可以让浏览器上正在录音的标志消失掉）
+     * @private
+     * @memberof Recorder
+     */
+    private stopStream;
+    /**
+     * close兼容方案
+     * 如firefox 30 等低版本浏览器没有 close方法
+     */
+    private closeAudioContext;
+    /**
+     * 下载录音文件
+     * @private
+     * @param {*} blob      blob数据
+     * @param {string} name 下载的文件名
+     * @param {string} type 下载的文件后缀
+     * @memberof Recorder
+     */
+    private download;
+    /**
+     * 清空状态，重新开始录音（变量初始化）
+     *
+     * @private
+     * @memberof Recorder
+     */
+    private clear;
+    /**
+     * 将二维数组转一维
+     *
+     * @private
+     * @returns  {float32array}     音频pcm二进制数据
+     * @memberof Recorder
+     */
+    private flat;
+    /**
+     * 播放外部音乐文件
+     *
+     * @param {float32array} blob    blob音频数据
+     * @memberof Recorder
+     */
+    static playAudio(blob: Blob): void;
+    /**
+     * 数据合并压缩
+     * 根据输入和输出的采样率压缩数据，
+     * 比如输入的采样率是48k的，我们需要的是（输出）的是16k的，由于48k与16k是3倍关系，
+     * 所以输入数据中每隔3取1位
+     *
+     * @static
+     * @param {float32array} data       [-1, 1]的pcm数据
+     * @param {number} inputSampleRate  输入采样率
+     * @param {number} outputSampleRate 输出采样率
+     * @returns  {float32array}         压缩处理后的二进制数据
+     * @memberof Recorder
+     */
+    static compress(data: {
+        left: Float32Array;
+        right: Float32Array;
+    }, inputSampleRate: number, outputSampleRate: number): Float32Array;
+    /**
+     * 转换到我们需要的对应格式的编码
+     *
+     * @static
+     * @param {Float32Array} bytes      pcm二进制数据
+     * @param {number}  sampleBits      采样位数
+     * @param {boolean} littleEdian     是否是小端字节序
+     * @returns {dataview}              pcm二进制数据
+     * @memberof Recorder
+     */
+    static encodePCM(bytes: Float32Array, sampleBits: number, littleEdian?: boolean): DataView;
+    /**
+     * 编码wav，一般wav格式是在pcm文件前增加44个字节的文件头，
+     * 所以，此处只需要在pcm数据前增加下就行了。
+     *
+     * @static
+     * @param {DataView} bytes           pcm二进制数据
+     * @param {number}  inputSampleRate  输入采样率
+     * @param {number}  outputSampleRate 输出采样率
+     * @param {number}  numChannels      声道数
+     * @param {number}  oututSampleBits  输出采样位数
+     * @param {boolean} littleEdian      是否是小端字节序
+     * @returns {DataView}               wav二进制数据
+     * @memberof Recorder
+     */
+    static encodeWAV(bytes: DataView, inputSampleRate: number, outputSampleRate: number, numChannels: number, oututSampleBits: number, littleEdian?: boolean): DataView;
+    /**
+     * 异常处理
+     * @static
+     * @param {*} message   错误消息
+     * @memberof Recorder
+     */
+    static throwError(message: any): void;
+    /**
+     * 在没有权限的时候，让弹出获取麦克风弹窗
+     *
+     */
+    static getPermission(): Promise<void>;
+}
+export default Recorder;