@hyext/types-ext-sdk-hy 3.16.1 → 3.16.2

package/index.d.ts

@@ -474,7 +474,7 @@ type DestroyAdReq = {
 
 /**
  * 关闭信息
- * @property isEnded - 是否看完
+ * @property isEnded - 是否看完, 1-看完, 0-未看完
  */
 type CloseInfo = {
     isEnded: boolean;
@@ -1724,6 +1724,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模块
  */
@@ -2602,6 +2725,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;
@@ -2617,6 +2741,7 @@ type RespLiveInfo = {
     liveCompany: number;
     liveMode: string;
     liveSubMode: string;
+    liveId: string;
 };
 
 /**
@@ -3938,6 +4063,12 @@ namespace feedback {
      * @returns 返回结果
      */
     function openFeedbackForm(params: FeedbackParams): Promise<void>;
+    /**
+     * 反馈
+     * @param params - 请求参数
+     * @returns 返回结果
+     */
+    function sendFeedback(params: SendFeedbackReq): Promise<SendFeedbackRsp>;
 }
 
 /**
@@ -3965,6 +4096,24 @@ type FeedbackParams = {
     param: string;
 };
 
+/**
+ * 反馈请求参数
+ * @property fbType - 反馈类型
+ * @property fbContent - 反馈详情
+ */
+type SendFeedbackReq = {
+    fbType: string;
+    fbContent: string;
+};
+
+/**
+ * 反馈结果
+ * @property feedbackId - 反馈日志id
+ */
+type SendFeedbackRsp = {
+    feedbackId: string;
+};
+
 /**
  * 文件系统
  */
@@ -4179,6 +4328,23 @@ type CleanResParams = {
     reserveMD5List: string[];
 };
 
+/**
+ * 保存进度信息
+ * @property url - 文件url
+ * @property bytesTotal - 文件总大小，单位是字
+ * @property bytesLoaded - 已加载的大小，单位是字节
+ */
+type FileProgressInfo = {
+    url: string;
+    bytesTotal: number;
+    bytesLoaded: number;
+};
+
+/**
+ * @param info - 保存进度信息
+ */
+type SaveFileProgressCallback = (info: FileProgressInfo) => void;
+
 /**
  * 本地文件信息
  * @property status - 状态码，0是成功，非0失败
@@ -4220,12 +4386,14 @@ type SaveFileInfo = {
  * @property fileList - 要保留的资源md5列表，至少传入一个
  * @property [authKeys] - 需要授权的场景值
  * @property callback - 单个文件保存结果回调
+ * @property [progressCallback] - 单个文件保存进度回调
  */
 type SaveFilesReq = {
     type: string;
     fileList: SaveFileInfo[];
     authKeys?: string[];
     callback: SaveFileCallback;
+    progressCallback?: SaveFileProgressCallback;
 };
 
 /**
@@ -8822,6 +8990,11 @@ namespace yyb {
      * @returns 调用结果
      */
     function offCloudGameMsgFromYYB(): Promise<void>;
+    /**
+     * 获取云游分配的服务器节点信息
+     * @returns 节点数据
+     */
+    function getYYBCloudGameServerSource(): Promise<CloudGameServerSourceInfo>;
 }
 
 /**
@@ -8843,8 +9016,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;
@@ -8852,8 +9030,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;
 };
 
 /**
@@ -8879,5 +9062,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.16.1",
+  "version": "3.16.2",
   "description": "TypeScript definitions for sdk",
   "types": "./index.d.ts",
   "main": "",