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

package/index.d.ts

@@ -474,7 +474,7 @@ type DestroyAdReq = {
 
 /**
  * 关闭信息
- * @property isEnded - 是否看完
+ * @property isEnded - 是否看完, 1-看完, 0-未看完
  */
 type CloseInfo = {
     isEnded: boolean;
@@ -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模块
  */
@@ -2608,6 +2836,7 @@ type ContextInfo = {
  * @property liveCompany - 交友陪玩直播间, 1-为交友陪玩直播间, 0-为非交友陪玩直播间
  * @property liveMode - 开播模式, kGame-【PC主播端】端游直播, kEntertainment-【PC主播端】娱乐直播, kMobile-【PC主播端】手游直播, kMakeFriends-【PC主播端】交友直播, kThirdParty-【PC主播端】第三方推流, kScreenCAP-【助手APP】录屏直播, kCamera-【助手APP】摄像头直播, kVoice-【助手APP】语音直播,
  * @property liveSubMode - 开播子模式, process-【PC主播端】端游直播-捕捉游戏画面, desktop-【PC主播端】端游直播-全屏捕捉, area-【PC主播端】端游直播-截取屏幕, window-【PC主播端】端游直播-窗口捕捉, adr-【PC主播端】手游直播-安卓手机, ios-【PC主播端】手游直播-苹果手机, audio-【PC主播端】交友直播-语音开播, video-【PC主播端】交友直播-视频开播, multiPlayersVideo-【PC主播端】派对模式,
+ * @property liveId - 直播ID
  */
 type RespLiveInfo = {
     gameName: string;
@@ -2623,6 +2852,7 @@ type RespLiveInfo = {
     liveCompany: number;
     liveMode: string;
     liveSubMode: string;
+    liveId: string;
 };
 
 /**
@@ -3329,7 +3559,7 @@ namespace device {
     /**
      * 获取窗口信息
      */
-    function getWindowInfo(): Promise<WindowInfo>;
+    function getWindowInfo(): WindowInfo;
 }
 
 /**
@@ -4005,6 +4235,12 @@ namespace feedback {
      * @returns 返回结果
      */
     function openFeedbackForm(params: FeedbackParams): Promise<void>;
+    /**
+     * 反馈
+     * @param params - 请求参数
+     * @returns 返回结果
+     */
+    function sendFeedback(params: SendFeedbackReq): Promise<SendFeedbackRsp>;
 }
 
 /**
@@ -4032,6 +4268,24 @@ type FeedbackParams = {
     param: string;
 };
 
+/**
+ * 反馈请求参数
+ * @property fbType - 反馈类型
+ * @property fbContent - 反馈详情
+ */
+type SendFeedbackReq = {
+    fbType: string;
+    fbContent: string;
+};
+
+/**
+ * 反馈结果
+ * @property feedbackId - 反馈日志id
+ */
+type SendFeedbackRsp = {
+    feedbackId: string;
+};
+
 /**
  * 文件系统
  */
@@ -4123,7 +4377,7 @@ namespace fs {
      * @param params - 传入参数
      * @returns 调用结果
      */
-    function downloadFile(params: DownloadFileReq): Promise<void>;
+    function downloadFile(params: DownloadFileReq): Promise<DownloadFileRsp>;
     /**
      * 判断文件/目录是否存在
      * @param params - 传入参数
@@ -4350,13 +4604,13 @@ namespace fs {
      * @param params - 传入参数
      * @returns 调用结果
      */
-    function write(params: WriteReq): Promise<void>;
+    function write(params: WriteReq): Promise<WriteRsp>;
     /**
      * 同步写入文件
      * @param params - 传入参数
      * @returns 调用结果
      */
-    function writeSync(params: WriteReq): void;
+    function writeSync(params: WriteReq): WriteRsp;
     /**
      * 写文件
      * @param params - 传入参数
@@ -4579,14 +4833,14 @@ type SaveFileInfo = {
  * @property fileList - 要保留的资源md5列表，至少传入一个
  * @property [authKeys] - 需要授权的场景值
  * @property callback - 单个文件保存结果回调
- * @property progressCallback - 单个文件保存进度回调
+ * @property [progressCallback] - 单个文件保存进度回调
  */
 type SaveFilesReq = {
     type: string;
     fileList: SaveFileInfo[];
     authKeys?: string[];
     callback: SaveFileCallback;
-    progressCallback: SaveFileProgressCallback;
+    progressCallback?: SaveFileProgressCallback;
 };
 
 /**
@@ -4719,6 +4973,18 @@ type DownloadFileReq = {
     filePath?: string;
 };
 
+/**
+ * 下载文件结果
+ * @property tempFilePath - 临时文件路径 (本地路径)
+ * @property filePath - 用户文件路径 (本地路径)，跟传入的 filePath 一致
+ * @property statusCode - 状态码
+ */
+type DownloadFileRsp = {
+    tempFilePath: string;
+    filePath: string;
+    statusCode: number;
+};
+
 /**
  * 判断文件/目录是否存在参数
  * @property path - 要判断是否存在的文件/目录路径 (本地路径)
@@ -4731,11 +4997,13 @@ type AccessReq = {
  * 在文件结尾追加内容参数
  * @property filePath - 要追加内容的文件路径 (本地路径)
  * @property data - 要追加的文本或二进制数据
- * @property [encoding] - 指定读取文件的字符编码, base64-base64, utf8-utf8
+ * @property [dataType] - 追加数据类型, string-string, ArrayBuffer-ArrayBuffer
+ * @property [encoding] - 指定读取文件的字符编码, base64-base64, utf8-utf8, binary-二进制
  */
 type AppendFileReq = {
     filePath: string;
-    data: string;
+    data: string | ArrayBuffer;
+    dataType?: string;
     encoding?: string;
 };
 
@@ -4770,7 +5038,7 @@ type GetFileInfoRsp = {
 /**
  * 获取文件信息参数
  * @property filePath - 要读取的文件路径 (本地路径)
- * @property [digestAlgorithm] - 计算文件摘要的算法, md5-md5算法, sha1-sha1算法
+ * @property [digestAlgorithm] - 计算文件摘要的算法, md5-md5算法, sha1-sha1算法, sha256-sha256算法
  */
 type GetFileInfoReq = {
     filePath: string;
@@ -4828,11 +5096,13 @@ type OpenReq = {
 /**
  * 文件信息
  * @property bytesRead - 实际读取的字节数
- * @property ArrayBuffer - 被写入的缓存区的对象
+ * @property arrayBuffer - 被写入的缓存区的对象
+ * @property originData - 原始数据
  */
 type ReadRsp = {
     bytesRead: number;
-    ArrayBuffer: any;
+    arrayBuffer: ArrayBuffer;
+    originData: string;
 };
 
 /**
@@ -4845,7 +5115,7 @@ type ReadRsp = {
  */
 type ReadReq = {
     fd: string;
-    arrayBuffer: any;
+    arrayBuffer: ArrayBuffer;
     offset?: number;
     length?: number;
     position?: number;
@@ -4854,17 +5124,21 @@ type ReadReq = {
 /**
  * 压缩类型的本地文件内容
  * @property data - 文件内容
+ * @property originData - 原始数据
  */
 type ReadCompressedFileRsp = {
-    data: any;
+    data: ArrayBuffer;
+    originData: string;
 };
 
 /**
  * 读取指定压缩类型的本地文件内容参数
  * @property filePath - 要读取的文件的路径 (本地用户文件或代码包文件)
+ * @property compressionAlgorithm - 文件压缩类型, br-brotli压缩文件
  */
 type ReadCompressedFileReq = {
     filePath: string;
+    compressionAlgorithm: string;
 };
 
 /**
@@ -4888,13 +5162,13 @@ type ReaddirReq = {
  * @property data - 文件数据
  */
 type ReadFileRsp = {
-    data: any;
+    data: string | ArrayBuffer;
 };
 
 /**
  * 读取文件参数
  * @property filePath - 要读取的文件的路径 (本地路径)
- * @property [encoding] - 指定读取文件的字符编码, base64-base64, utf8-utf8
+ * @property [encoding] - 指定读取文件的字符编码, base64-base64, utf8-utf8, binary-二进制
  * @property [position] - 从文件指定位置开始读，如果不指定，则从文件头开始读
  * @property [length] - 指定文件的长度，如果不指定，则读到文件末尾。
  */
@@ -4905,24 +5179,48 @@ type ReadFileReq = {
     length?: number;
 };
 
+/**
+ * 文件信息
+ * @property data - 文件内容string|ArrayBuffer
+ * @property errMsg - 错误信息
+ */
+type FileItem = {
+    data: string | ArrayBuffer;
+    errMsg: string;
+};
+
 /**
  * 读取压缩包内的文件
- * @property entries - 文件读取结果，key是文件路径，value是一个对象 FileItem ，表示该文件的读取结果。每个 FileItem 包含 data （文件内容） 和 errMsg （错误信息） 属性。
+ * @property entries - 文件读取结果，key是文件路径，value是一个对象FileItem，表示该文件的读取结果。每个FileItem包含data（文件内容）和errMsg（错误信息）属性
  */
 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: any;
+    entries: EntrieInfo[] | 'all';
 };
 
 /**
@@ -4981,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: any;
+    stats: FileStats[] | FileStats;
 };
 
 /**
@@ -5021,50 +5337,44 @@ type UnlinkReq = {
  * 写文件参数
  * @property fd - 文件描述符
  * @property data - 要写入的文本或二进制数据
+ * @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 = {
     fd: string;
-    data: string;
+    data: string | ArrayBuffer;
+    dataType?: string;
     offset?: number;
     length?: number;
     encoding?: string;
     position?: number;
 };
 
+/**
+ * 写文件结果
+ * @property bytesWritten - 实际被写入到文件中的字节数
+ */
+type WriteRsp = {
+    bytesWritten: number;
+};
+
 /**
  * 写文件参数
  * @property filePath - 要写入的文件路径 (本地路径)
  * @property data - 要写入的文本或二进制数据
- * @property [encoding] - 指定写入文件的字符编码, base64-base64, utf8-utf8
+ * @property [dataType] - 追加数据类型, string-string, ArrayBuffer-ArrayBuffer
+ * @property [encoding] - 指定写入文件的字符编码, base64-base64, utf8-utf8, binary-二进制
  */
 type WriteFileReq = {
     filePath: string;
-    data: string;
+    data: string | ArrayBuffer;
+    dataType?: string;
     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 - 文件状态
@@ -9569,6 +9879,11 @@ namespace yyb {
      * @returns 调用结果
      */
     function offCloudGameMsgFromYYB(): Promise<void>;
+    /**
+     * 获取云游分配的服务器节点信息
+     * @returns 节点数据
+     */
+    function getYYBCloudGameServerSource(): Promise<CloudGameServerSourceInfo>;
 }
 
 /**
@@ -9590,8 +9905,13 @@ type LaunchYYBCloudGameReq = {
  * @property cloudGameSource - 游戏来源
  * @property cloudGamePackageName - 游戏包名
  * @property entranceId - 游戏ID
- * @property needShowFloatingWindow - 是否需要显示悬浮球
+ * @property needShowFloatingWindow - 是否需要显示悬浮球, 1-显示, 0-不显示
  * @property gameIconUrl - 游戏图标链接
+ * @property [needUseCustomLoadingUI] - 是否使用自定义加载页面, 1-是, 0-否
+ * @property [loadBgUrl] - 加载过程的背景url
+ * @property [loadMsg] - 加载过程的文案
+ * @property [needObserPerformance] - 是否需要监听性能数据, 1-是, 0-否
+ * @property [performanceFrequency] - 性能数据回调频控，单位秒
  */
 type StartYYBCloudGameReq = {
     bizIdDev: string;
@@ -9599,8 +9919,13 @@ type StartYYBCloudGameReq = {
     cloudGameSource: string;
     cloudGamePackageName: string;
     entranceId: string;
-    needShowFloatingWindow: boolean;
+    needShowFloatingWindow: number;
     gameIconUrl: string;
+    needUseCustomLoadingUI?: number;
+    loadBgUrl?: string;
+    loadMsg?: string;
+    needObserPerformance?: number;
+    performanceFrequency?: number;
 };
 
 /**
@@ -9626,5 +9951,15 @@ type OnYYBCloudGameMsgReq = {
     callback: YYBCloudGameMsgCallback;
 };
 
+/**
+ * 节点数据
+ * @property deviceArea - 节点信息，如guangzhou、shenzhen等
+ * @property deviceId - 节点id
+ */
+type CloudGameServerSourceInfo = {
+    deviceArea: string;
+    deviceId: string;
+};
+
 
 }

package/package.json

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