@ray-js/api 1.8.0-beta.1 → 1.8.0-beta.11

package/@types/WearKit.d.ts

@@ -0,0 +1,607 @@
+/**
+ * WearKit
+ *
+ * @version 1.1.6
+ */
+declare namespace ty.wear {
+  export type RecordTransferRealTimeRecognizeStatus = {
+    /** 设备id */
+    deviceId: string;
+    /** 实时转写记录id */
+    recordId: string;
+    /** 实时转写请求id */
+    requestId: string;
+    /** 实时转写asrId */
+    asrId: number;
+    /** 声道 */
+    channel: number;
+    /** 阶段  0.任务 1.收音 2.发数据 3.收数据 4.asr 5.text 6.skill 7.tts */
+    phase: number;
+    /** 阶段状态 0. 未开启 1.进行中 2.结束 3.取消 */
+    status: number;
+    /** 文本 */
+    text: string;
+    /** 开始时间，单位毫秒 */
+    beginOffset: number;
+    /** 结束时间，单位毫秒 */
+    endOffset: number;
+    /** 错误码 */
+    errorCode: number;
+    /** 错误消息 */
+    errorMessage?: string;
+  }
+  export type RecordTransferAmplitude = {
+    /** 设备id */
+    deviceId: string;
+    /** 振幅 0～1 */
+    amplitude: number;
+    /** 声道,只有同声传译时才有意义，0表示左耳，1表示右耳 */
+    channel: number;
+  }
+
+  export type RecordTransferStatus = {
+    /** 设备id */
+    deviceId: string;
+    /** 状态，0未知，1录音中，2暂停，3结束 */
+    state: number;
+    /** 是否正在开始中 */
+    isStarting: boolean;
+    /** 是否正在暂停中 */
+    isPausing: boolean;
+    /** 是否正在恢复中 */
+    isResuming: boolean;
+    /** 是否正在结束中 */
+    isStoping: boolean;
+  }
+  export type RecordTransferFinish = {
+    /** 设备id */
+    deviceId: string;
+    /** 错误码 */
+    code: number;
+    /** 错误消息 */
+    message?: string;
+  }
+
+  export type StartRecordTransferConfig = {
+    /** 录音类型，0呼叫，1会议，2同声传译 3:f2f翻译 */
+    recordType: number;
+    /** dp控制超时时间 单位秒 */
+    controlTimeout: number;
+    /** 录音通道 0 ble(opus) 1 Bt 2 micro 默认是0 为了适配原有逻辑 */
+    recordChannel: number;
+    /** 仅用于recordType == 3（面对面翻译确认数据来源方向）0: default  1: left 2:right */
+    f2fChannel: number;
+    /** 灌流超时时间 单位秒 */
+    dataTimeout: number;
+    /** 转写模式 0文件转写，1实时转写. 同声传译使用实时转写模式，设置为0并不起作用 */
+    transferType: number;
+    /** 是否需要翻译. 同声传译需要翻译，设置为false并不起作用 */
+    needTranslate: boolean;
+    /** 会议或者电话模式，表示起始语言 同声传译模式，表示左耳语言 */
+    originalLanguage?: string;
+    /** 会议或者电话模式，表示目标语言 同声传译模式，表示右耳语言 */
+    targetLanguage?: string;
+    /** 智能体id */
+    agentId?: string;
+    /** TTS流编码方式，通过编码后将流写入到耳机设备 0: opus_silk  1:opus_celt */
+    ttsEncode?: number;
+    /** 是否需要TTS. true:需要  false:不需要 */
+    needTts: boolean;
+  }
+
+  export type RecordTransferTaskResponse = {
+    /**
+     * 录音任务信息
+     */
+    task?: {
+      /** 状态，0未知，1录音中，2暂停，3结束 */
+      state: number;
+      /** 用户录音时间 单位毫秒 */
+      userRecordDuration: number;
+      /** 音频类型 0呼叫 1会议 2同声传译 */
+      recordType: number;
+      /** 转写模式 0文件转写，1实时转写 */
+      transferType: number;
+      /** 是否需要翻译 */
+      needTranslate: boolean;
+      /** 会议或者电话模式，表示起始语言 同声传译模式，表示左耳语言 */
+      originalLanguage?: string;
+      /** 会议或者电话模式，表示目标语言 同声传译模式，表示右耳语言 */
+      targetLanguage?: string;
+      /** 是否正在开始中 */
+      isStarting: boolean;
+      /** 是否正在暂停中 */
+      isPausing: boolean;
+      /** 是否正在恢复中 */
+      isResuming: boolean;
+      /** 是否正在结束中 */
+      isStoping: boolean;
+      /** 当前正在实时转写的asrId */
+      currentRealTimeAsrId?: string;
+      /** 实时转写记录id */
+      recordId?: string;
+    };
+  }
+
+  export type RecordTransferRealTimeItem = {
+    /** asrId */
+    asrId: number;
+    /** 录音转写id */
+    recordTransferId: number;
+    /** 开始偏移时间 */
+    beginOffset: number;
+    /** 结束偏移时间 */
+    endOffset: number;
+    /** 文案 */
+    text?: string;
+    /** 请求id */
+    requestId: string;
+    /** 实时转写记录id */
+    recordId: string;
+    /** 声道. 会议模式只有0声道 电话模式有0、1声道（其中0声道表示近端，1声道表示远端） 同声传译模式有0、1声道（其中0声道表示左耳，1声道表示右耳） */
+    channel: number;
+    /** 转录状态，0未转录或转写中、1转录成功、2转录失败 */
+    status: number;
+    /** asr文案 */
+    asr?: string;
+    /** translate文案 */
+    translate?: string;
+  }
+
+  export type GetRecordTransferRealTimeResultResponse = {
+    /** 实时转写数据列表 */
+    list?: Array<RecordTransferRealTimeItem>;
+  }
+
+  export type RecordTransferResultListRes = {
+    /** 录音转写id */
+    recordTransferId: number;
+    /** 目录id */
+    directoryId: number;
+    /** 设备生成的录音文件唯一标识符 */
+    deviceUniqueId: string;
+    /** 文件名称 */
+    name: string;
+    /** 录音时间 时间戳 单位秒 */
+    recordTime: number;
+    /** 录音时长 单位毫秒 */
+    duration: number;
+    /** 音频类型 0呼叫、1会议、2同声传译 */
+    recordType: number;
+    /** 音频格式 */
+    audioFormat: number;
+    /** 设备id */
+    deviceId: string;
+    /** 录音文件路径 */
+    filePath?: string;
+    /** 录音wav文件路径 */
+    wavFilePath?: string;
+    /** 振幅字符串，以**,**格开 */
+    amplitudes?: string;
+    /** 文件同步状态，0未上传、1上传中、2已上传、3上传失败 */
+    status: number;
+    /** 是否已经点击过 */
+    visit: boolean;
+    /** 是否被移除，移到垃圾桶 */
+    remove: boolean;
+    /** 云端存储的key */
+    storageKey?: string;
+    /** 转录状态，0未转录、1转录中、2已转录、3转录失败 */
+    transfer: number;
+    /** 音频文件来源，0表示app，1表示设备 */
+    source: number;
+    /** 转写模式 0文件转写，1实时转写 */
+    transferType: number;
+    /** 是否需要翻译 */
+    needTranslate: boolean;
+    /** 起始语言 */
+    originalLanguage?: string;
+    /** 目标语言 */
+    targetLanguage?: string;
+    /** 实时转写记录id */
+    recordId?: string;
+    /** 实时转写智能体id */
+    agentId?: string;
+  }
+
+  export type getRecordTransferProcessStatusRes = {
+    /** 转写成功的文件id列表 */
+    success: Array<string>;
+    /** 转写失败的文件id列表 */
+    fail: Array<string>;
+  }
+
+  /**
+   * @description 开始录音转写
+   */
+  export function startRecordTransfer(params: {
+    /** 设备id */
+    deviceId: number
+    /** 开始录音的配置参数 */
+    config: StartRecordTransferConfig
+    success?: (params: null) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * @description 暂停录音
+   */
+  export function pauseRecordTransfer(params: {
+    /** 设备id */
+    deviceId: number
+    success?: (params: null) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * @description 恢复录音
+   */
+  export function resumeRecordTransfer(params: {
+    /** 设备id */
+    deviceId: number
+    success?: (params: null) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * @description 结束录音
+   */
+  export function stopRecordTransfer(params: {
+    /** 设备id */
+    deviceId: number
+    success?: (params: null) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * @description 获取录音转写任务
+   */
+  export function recordTransferTask(params: {
+    /** 设备id */
+    deviceId: number
+    success?: (params: RecordTransferTaskResponse) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * @description 获取实时转写数据
+   */
+  export function getRecordTransferRealTimeResult(params: {
+    /** 文件id */
+    fileId?: string;
+    /** 实时转写记录id */
+    recordId?: string;
+    /** 查询小于等于asrId的数据 */
+    asrId?: string;
+    success?: (params: GetRecordTransferRealTimeResultResponse) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * @description 获取录音转写列表
+   */
+  export function getRecordTransferResultList(params: {
+    /** 目录id, 不传会查出所有目录 */
+    directoryId?: string;
+    /** 音频类型, 0呼叫、1会议、2同声传译、 不传会查出所有音频类型 */
+    recordType?: string;
+    /** 设备id, 不传会查出所有设备 */
+    deviceId?: string;
+    /** 是否垃圾桶, 0未删除、1已删除、不传会查出删除和未删除 */
+    remove?: string;
+    /** 转写状态, 0未转写、1转写中、2转写成功、3转写失败、不传会查所有状态 */
+    transfer?: string;
+    /** 音频文件来源，0表示app，1表示设备，不传会查所有来源 */
+    source?: string;
+    /** 排序规则  0-fileId、1-recordTime、2-updateAt，不传默认fileId */
+    orderBy?: string;
+    /** 排序 0降序 1升序，不传默认降序 */
+    asc?: string;
+    /** 最后一个记录id，不传或0 表示不做限制 */
+    lastRecordTransferId?: string;
+    /** 分页大小，不传或0 表示不分页（全部） */
+    pageSize?: number;
+    success?: (params: RecordTransferResultListRes[]) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * @description 获取录音详情
+   */
+  export function getRecordTransferResultDetail(params: {
+    /** 录音转写id */
+    recordTransferId: number;
+    /** 振幅最大个数 */
+    amplitudeMaxCount?: string;
+    success?: (params: RecordTransferResultListRes) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * @description 更新录音文件信息
+   */
+  export function updateRecordTransferResult(params: {
+    /** 录音转写id */
+    recordTransferId: number;
+    /** 目录id, 不传表示不更新 */
+    directoryId?: string;
+    /** 文件名称, 不传表示不更新 */
+    name?: string;
+    /** 录音文件名称, 不传表示不更新 */
+    fileName?: string;
+    /** 录音wav文件名称, 不传表示不更新 */
+    wavFileName?: string;
+    /** 振幅字符串，以**,**格开, 不传表示不更新 */
+    amplitudes?: string;
+    /** 文件同步状态，0未上传、1上传中、2已上传、3上传失败, 不传表示不更新 */
+    status?: string;
+    /** 是否已经点击过, 不传表示不更新 */
+    visit?: string;
+    /** 是否被移除，移到垃圾桶, 不传表示不更新 */
+    remove?: string;
+    /** 云端存储的key, 不传表示不更新 */
+    storageKey?: string;
+    /** 转录状态，0未转录、1转录中、2已转录、3转录失败, 不传表示不更新 */
+    transfer?: string;
+    success?: (params: null) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * @description 批量删除录音文件
+   */
+  export function removeFileList(params: {
+    /** 多个文件 */
+    fileIds?: Array<number>;
+    success?: (params: null) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * @description 保存转写结果
+   */
+  export function saveRecordTransferRecognizeResult(params: {
+    /** 录音转写id */
+    recordTransferId: number;
+    /** 转写结果 */
+    text: string;
+    success?: (params: null) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * @description 保存转写结果
+   */
+  export function saveRecordTransferSummaryResult(params: {
+    /** 录音转写id */
+    recordTransferId: number;
+    /** 转写结果 */
+    text: string;
+    success?: (params: null) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * @description 更新转写结果
+   */
+  export function saveRecordTransferRealTimeRecognizeResult(params: {
+    /** 请求id */
+    asrId: number;
+    /** 文案 */
+    text?: string;
+    /** asr文案 */
+    asr?: string;
+    /** translate文案 */
+    translate?: string;
+    success?: (params: null) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * @description 转写状态查询
+   */
+  export function getRecordTransferProcessStatus(params: {
+    /** 设备id */
+    deviceId: string;
+    /** 文件id列表 */
+    fileIds: Array<string>;
+    success?: (params: getRecordTransferProcessStatusRes) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * @description 转写结果查询
+   */
+  export function getRecordTransferRecognizeResult(params: {
+    /** 录音转写id */
+    recordTransferId: number;
+    /** 来源：0本地 1云端 */
+    from: number;
+    success?: (params: {
+      /** 转写结果 */
+      text: string
+    }) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * @description 对录音转写记录进行转写操作
+   */
+  export function processRecordTransferResult(params: {
+    /** 录音转写id */
+    recordTransferId: number;
+    /** 模版 */
+    template: string;
+    /** 语言 */
+    language: string;
+    success?: (params: null) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * @description 转写总结查询
+   */
+  export function getRecordTransferSummaryResult(params: {
+    /** 录音转写id */
+    recordTransferId: number;
+    /** 来源：0本地 1云端 */
+    from: number;
+    success?: (params: {
+      /** 总结文案 */
+      text: string;
+    }) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * @description 实时翻译录音事件通知
+   */
+  export function onRecordTransferRealTimeRecognizeStatusUpdateEvent(listener: (params: RecordTransferRealTimeRecognizeStatus) => void): void
+  /**
+   * @description 监听声音振幅
+   */
+  export function onRecordTransferAmplitudeUpdateEvent(listener: (params: RecordTransferAmplitude) => void): void
+  /**
+   * @description 录音状态变更事件
+   */
+  export function onRecordTransferStatusUpdateEvent(listener: (params: RecordTransferStatus) => void): void
+  /**
+   * @description 录音结束的通知
+   */
+  export function onRecordTransferFinishEvent(listener: (params: RecordTransferFinish) => void): void
+  /**
+   * @description 移除实时翻译录音事件通知
+   */
+  export function offRecordTransferRealTimeRecognizeStatusUpdateEvent(listener: (params: RecordTransferRealTimeRecognizeStatus) => void): void
+  /**
+   * @description 移除监听声音振幅
+   */
+  export function offRecordTransferAmplitudeUpdateEvent(listener: (params: RecordTransferAmplitude) => void): void
+  /**
+   * @description 移除录音状态变更事件
+   */
+  export function offRecordTransferStatusUpdateEvent(listener: (params: RecordTransferStatus) => void): void
+  /**
+   * @description 移除录音结束的通知
+   */
+  export function offRecordTransferFinishEvent(listener: (params: RecordTransferFinish) => void): void
+}

package/@types/all-kits.d.ts

@@ -12,3 +12,4 @@
 /// <reference path="./AIKit.d.ts" />
 /// <reference path="./IPCKit.d.ts" />
 /// <reference path="./PlayNetKit.d.ts" />
+/// <reference path="./WearKit.d.ts" />