@hyext/types-ext-sdk-hy 3.17.0-beta.9 → 3.17.0

package/index.d.ts

@@ -853,6 +853,12 @@ namespace advance {
      * @param params - 礼物信息
      */
     function sendGiftToUser(params: SendGiftTUInfo): Promise<void>;
+    /**
+     * 定制送礼接口
+     * @param params - 参数
+     * @returns 调用结果
+     */
+    function sendActivityGift(params: SendActivityGiftReq): Promise<SendActivityGiftRsp>;
     /**
      * 获取交友直播间上麦用户信息
      * @returns 上麦用户信息列表
@@ -992,6 +998,24 @@ namespace advance {
      * @returns 调用结果
      */
     function offCommonQueueStatusChange(params: OffCommonQueueStatusChangeReq): Promise<void>;
+    /**
+     * 获取直播间当前特效状态
+     * @param params - 参数
+     * @returns 调用结果
+     */
+    function getLiveroomEffectStatus(params: GetLiveroomEffectStatusReq): Promise<GetLiveroomEffectStatusRsp>;
+    /**
+     * 监听直播间特效状态变化
+     * @param params - 参数
+     * @returns 调用结果
+     */
+    function onLiveroomEffectStatusChange(params: OnLiveroomEffectStatusChangeReq): Promise<void>;
+    /**
+     * 取消监听直播间特效状态变化
+     * @param params - 参数
+     * @returns 调用结果
+     */
+    function offLiveroomEffectStatusChange(params: OffLiveroomEffectStatusChangeReq): Promise<void>;
 }
 
 /**
@@ -1309,6 +1333,38 @@ type SendGiftTUInfo = {
     mapParam?: any;
 };
 
+/**
+ * 定制送礼接口结果
+ * @property code - 端上送礼结果返回, 0-成功, 1-余额不足, 2-弹窗确认取消送出, 3-需要鉴权的礼物没有这个身份（比如守护、贵族）, 4-断网
+ * @property err - 错误信息
+ * @property consumeRsp - 接口回包的base64字符串
+ */
+type SendActivityGiftRsp = {
+    code: number;
+    err: string;
+    consumeRsp: string;
+};
+
+/**
+ * 定制送礼接口参数
+ * @property giftId - giftId
+ * @property giftCount - giftCount
+ * @property [useSelectMic] - useSelectMic
+ * @property sourceType - sourceTyp
+ * @property [mapParam] - mapParam
+ * @property [uid] - uid
+ * @property [secondConfirm] - secondConfirm
+ */
+type SendActivityGiftReq = {
+    giftId: number;
+    giftCount: number;
+    useSelectMic?: boolean;
+    sourceType: string;
+    mapParam?: any;
+    uid?: string;
+    secondConfirm?: boolean;
+};
+
 /**
  * 上麦用户信息
  * @property uid - 用户的uid
@@ -1671,6 +1727,55 @@ type OffCommonQueueStatusChangeReq = {
     type: string;
 };
 
+/**
+ * 获取直播间当前特效状态结果
+ * @property id - 当前生效的特效，id为空则表示没有此类型的特效在播
+ */
+type GetLiveroomEffectStatusRsp = {
+    id: string;
+};
+
+/**
+ * 获取直播间当前特效状态参数
+ * @property type - 类型
+ */
+type GetLiveroomEffectStatusReq = {
+    type: string;
+};
+
+/**
+ * 队列状态变化
+ * @property id - 特效id
+ * @property status - 状态, show-显示, hide-隐藏
+ */
+type LiveroomEffectStatus = {
+    id: string;
+    status: string;
+};
+
+/**
+ * @param status - 回调参数
+ */
+type LiveroomEffectStatusChange = (status: LiveroomEffectStatus) => void;
+
+/**
+ * 监听直播间特效状态变化参数
+ * @property type - 类型
+ * @property callback - 特效状态变化回调
+ */
+type OnLiveroomEffectStatusChangeReq = {
+    type: string;
+    callback: LiveroomEffectStatusChange;
+};
+
+/**
+ * 取消监听直播间特效状态变化参数
+ * @property type - 类型
+ */
+type OffLiveroomEffectStatusChangeReq = {
+    type: string;
+};
+
 /**
  * app模块
  */
@@ -1724,6 +1829,129 @@ function onAppear(callback: LifeCallback): void;
  */
 function onDisappear(callback: LifeCallback): void;
 
+/**
+ * audio模块
+ */
+namespace audio {
+    /**
+     * 创建音频播放器
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function createAudio(params: CreateAudioReq): Promise<CreateAudioRsp>;
+    /**
+     * 监听音频播放器事件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function onAudioNotices(params: OnAudioNoticesReq): Promise<void>;
+    /**
+     * 取消监听音频播放器事件
+     * @param [params] - 传入参数
+     * @returns 调用结果
+     */
+    function offAudioNotices(params?: OffAudioNoticesReq): Promise<void>;
+    /**
+     * 播放音频
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function playAudio(params: PlayAudioReq): Promise<void>;
+    /**
+     * 停止音频播放
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function stopAudio(params: StopAudioReq): Promise<void>;
+    /**
+     * 音频是否在播放中
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function isAudioPlaying(params: IsAudioPlayingReq): Promise<IsAudioPlayingRsp>;
+}
+
+/**
+ * 创建音频播放器参数
+ * @property url - 音频地址
+ */
+type CreateAudioReq = {
+    url: string;
+};
+
+/**
+ * 创建音频播放器结果
+ * @property audioId - 播放器实例播放器ID
+ */
+type CreateAudioRsp = {
+    audioId: string;
+};
+
+/**
+ * 音频播放器事件回调信息
+ * @property audioId - 播放器实例ID
+ * @property eventName - 事件名, ended-播放完毕, error-播放出错
+ * @property data - 回调信息
+ */
+type AudioEventInfo = {
+    audioId: string;
+    eventName: string;
+    data: any;
+};
+
+/**
+ * @param info - 回调信息
+ */
+type AudioEventCallback = (info: AudioEventInfo) => void;
+
+/**
+ * 监听音频播放器事件参数
+ * @property callback - 音频播放器事件回调
+ */
+type OnAudioNoticesReq = {
+    callback: AudioEventCallback;
+};
+
+/**
+ * 取消监听音频播放器事件参数
+ * @property [callback] - 音频播放器事件回调
+ */
+type OffAudioNoticesReq = {
+    callback?: AudioEventCallback;
+};
+
+/**
+ * 播放音频参数
+ * @property audioId - 播放器实例ID
+ */
+type PlayAudioReq = {
+    audioId: string;
+};
+
+/**
+ * 停止播放参数
+ * @property audioId - 播放器实例ID
+ */
+type StopAudioReq = {
+    audioId: string;
+};
+
+/**
+ * 音频是否在播放中参数
+ * @property audioId - 播放器实例ID
+ */
+type IsAudioPlayingReq = {
+    audioId: string;
+};
+
+/**
+ * 音频是否在播放中结果
+ * @property isPlaying - 是否在播放中
+ */
+type IsAudioPlayingRsp = {
+    isPlaying: boolean;
+};
+
 /**
  * auth模块
  */
@@ -4770,7 +4998,7 @@ type AccessReq = {
  * @property filePath - 要追加内容的文件路径 (本地路径)
  * @property data - 要追加的文本或二进制数据
  * @property [dataType] - 追加数据类型, string-string, ArrayBuffer-ArrayBuffer
- * @property [encoding] - 指定读取文件的字符编码, base64-base64, utf8-utf8
+ * @property [encoding] - 指定读取文件的字符编码, base64-base64, utf8-utf8, binary-二进制
  */
 type AppendFileReq = {
     filePath: string;
@@ -4869,10 +5097,12 @@ type OpenReq = {
  * 文件信息
  * @property bytesRead - 实际读取的字节数
  * @property arrayBuffer - 被写入的缓存区的对象
+ * @property originData - 原始数据
  */
 type ReadRsp = {
     bytesRead: number;
     arrayBuffer: ArrayBuffer;
+    originData: string;
 };
 
 /**
@@ -4894,9 +5124,11 @@ type ReadReq = {
 /**
  * 压缩类型的本地文件内容
  * @property data - 文件内容
+ * @property originData - 原始数据
  */
 type ReadCompressedFileRsp = {
     data: ArrayBuffer;
+    originData: string;
 };
 
 /**
@@ -4936,7 +5168,7 @@ type ReadFileRsp = {
 /**
  * 读取文件参数
  * @property filePath - 要读取的文件的路径 (本地路径)
- * @property [encoding] - 指定读取文件的字符编码, base64-base64, utf8-utf8
+ * @property [encoding] - 指定读取文件的字符编码, base64-base64, utf8-utf8, binary-二进制
  * @property [position] - 从文件指定位置开始读，如果不指定，则从文件头开始读
  * @property [length] - 指定文件的长度，如果不指定，则读到文件末尾。
  */
@@ -4965,16 +5197,30 @@ type ReadZipEntryRsp = {
     entries: any;
 };
 
+/**
+ * 读取压缩包内的文件参数
+ * @property path - 压缩包内文件路径
+ * @property [encoding] - 指定读取文件的字符编码, base64-base64, utf8-utf8, binary-二进制
+ * @property [position] - 从文件指定位置开始读，如果不指定，则从文件头开始读
+ * @property [length] - 指定文件的长度，如果不指定，则读到文件末尾
+ */
+type EntrieInfo = {
+    path: string;
+    encoding?: string;
+    position?: number;
+    length?: number;
+};
+
 /**
  * 读取压缩包内的文件参数
  * @property filePath - 要读取的文件的路径 (本地路径)
- * @property [encoding] - 指定读取文件的字符编码, base64-base64, utf8-utf8
+ * @property [encoding] - 统一指定读取文件的字符编码，只在entries值为"all"时有效，entries值为"all"时不传默认返回二进制内容
  * @property entries - 要读取的压缩包内的文件列表（当传入"all" 时表示读取压缩包内所有文件）
  */
 type ReadZipEntryReq = {
     filePath: string;
     encoding?: string;
-    entries: string[] | 'all';
+    entries: EntrieInfo[] | 'all';
 };
 
 /**
@@ -5033,12 +5279,30 @@ type SaveFileReq = {
     filePath?: string;
 };
 
+/**
+ * 文件状态
+ * @property mode - 文件的类型和存取的权限
+ * @property size - 文件大小，单位：B
+ * @property lastAccessedTime - 文件最近一次被存取或被执行的时间戳
+ * @property lastModifiedTime - 文件最后一次被修改的时间戳
+ * @property isDirectory - 判断当前文件是否一个目录
+ * @property isFile - 判断当前文件是否一个普通文件
+ */
+type FileStats = {
+    mode: number;
+    size: number;
+    lastAccessedTime: number;
+    lastModifiedTime: number;
+    isDirectory: boolean;
+    isFile: boolean;
+};
+
 /**
  * 文件Stats对象结果
  * @property stats - 当recursive为false时，res.stats是一个Stats对象。当recursive为true且path是一个目录的路径时，res.stats是一个Array，数组的每一项是一个对象，每个对象包含path和stats
  */
 type StatRsp = {
-    stats: FileStats | FileStats[];
+    stats: FileStats[] | FileStats;
 };
 
 /**
@@ -5076,7 +5340,7 @@ type UnlinkReq = {
  * @property [dataType] - 追加数据类型, string-string, ArrayBuffer-ArrayBuffer
  * @property [offset] - 在 data 是 ArrayBuffer 时要写入的 arrayBuffer 中的索引，默认0
  * @property [length] - 在 data 是 ArrayBuffer 时指定要写入的字节数
- * @property [encoding] - 指定写入文件的字符编码, base64-base64, utf8-utf8
+ * @property [encoding] - 指定写入文件的字符编码, base64-base64, utf8-utf8, binary-二进制
  * @property [position] - 指定文件开头的偏移量，即数据要被写入的位置
  */
 type WriteReq = {
@@ -5102,7 +5366,7 @@ type WriteRsp = {
  * @property filePath - 要写入的文件路径 (本地路径)
  * @property data - 要写入的文本或二进制数据
  * @property [dataType] - 追加数据类型, string-string, ArrayBuffer-ArrayBuffer
- * @property [encoding] - 指定写入文件的字符编码, base64-base64, utf8-utf8
+ * @property [encoding] - 指定写入文件的字符编码, base64-base64, utf8-utf8, binary-二进制
  */
 type WriteFileReq = {
     filePath: string;
@@ -5111,24 +5375,6 @@ type WriteFileReq = {
     encoding?: string;
 };
 
-/**
- * 文件状态
- * @property mode - 文件的类型和存取的权限
- * @property size - 文件大小，单位：B
- * @property lastAccessedTime - 文件最近一次被存取或被执行的时间戳
- * @property lastModifiedTime - 文件最后一次被修改的时间戳
- * @property isDirectory - 判断当前文件是否一个目录
- * @property isFile - 判断当前文件是否一个普通文件
- */
-type FileStats = {
-    mode: number;
-    size: number;
-    lastAccessedTime: number;
-    lastModifiedTime: number;
-    isDirectory: boolean;
-    isFile: boolean;
-};
-
 /**
  * 获取文件的状态信息参数
  * @property stats - 文件状态

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyext/types-ext-sdk-hy",
-  "version": "3.17.0-beta.9",
+  "version": "3.17.0",
   "description": "TypeScript definitions for sdk",
   "types": "./index.d.ts",
   "main": "",