@hyext/types-ext-sdk-hy 3.20.0 → 4.0.0-beta.10

package/index.d.ts

@@ -2528,22 +2528,22 @@ type SafeAreaInfo = {
  * @property screenWidth - 屏幕宽度
  * @property screenHeight - 屏幕高度
  * @property isLandscape - 屏幕是否是横屏高度
- * @property pixelRatio - 设备像素比
+ * @property [pixelRatio] - 设备像素比
  * @property windowWidth - 可使用窗口宽度，单位 px
  * @property windowHeight - 可使用窗口高度，单位 px
- * @property statusBarHeight - 状态栏的高度，单位 px
- * @property screenTop - 窗口上边缘的 y 值
+ * @property [statusBarHeight] - 状态栏的高度，单位 px
+ * @property [screenTop] - 窗口上边缘的 y 值
  * @property [safeArea] - 在竖屏正方向下的安全区域。部分机型没有安全区域概念，则不返回 safeArea 字段
  */
 type Consts = {
     screenWidth: number;
     screenHeight: number;
     isLandscape: boolean;
-    pixelRatio: number;
+    pixelRatio?: number;
     windowWidth: number;
     windowHeight: number;
-    statusBarHeight: number;
-    screenTop: number;
+    statusBarHeight?: number;
+    screenTop?: number;
     safeArea?: SafeAreaInfo;
 };
 
@@ -2559,14 +2559,14 @@ namespace context {
      * @param callback - 收到消息时回调 返回消息内容
      * @returns 调用结果
      */
-    function on(topic: string, callback: ContextOnCallback): void;
+    function on(topic: string, callback: ContextOnCallback): Promise<void>;
     /**
      * 取消监听直播间消息
      * @param topic - 宿主消息名, activated-小程序激活, subscribeSubmit-【观众端】当前观众订阅状态发生变化, giftSubmit-【观众端】当前观众送礼, barrageSubmit-当前用户发送弹幕, unzipProgress-每个任务的解压进度, userInteract-用户交互信息, openCoinPanelClosed-能量豆弹窗关闭, uiVisibilityStateChange-工具栏状态
      * @param [callback] - 收到消息时回调 返回消息内容
      * @returns 调用结果
      */
-    function off(topic: string, callback?: ContextOnCallback): void;
+    function off(topic: string, callback?: ContextOnCallback): Promise<void>;
     /**
      * 显示互动通道入口红点
      * @returns 返回是否显示成功
@@ -3115,7 +3115,7 @@ type StreamerInfo = {
     streamerNick: string;
     streamerAvatarUrl: string;
     streamerSex: number;
-    streamerRoomId: string;
+    streamerRoomId: number;
     streamerLevel: number;
     streamerUnionId: string;
 };
@@ -3142,10 +3142,10 @@ type ContextInfo = {
  * @property template - 直播间模版, MobileLiveRoom-颜值, FMLiveRoom-多人语音, MatchLiveRoom-赛事, TVLiveRoom-虎牙电视台, GameRoom-游戏, ImmerseRoom-沉浸式, MultiLinkVideoRoom-派对
  * @property sourceType - 直播间来源
  * @property liveImmersion - 沉浸式直播间, 1-为沉浸式直播间, 0-为非沉浸式直播间
- * @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
+ * @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;
@@ -3158,10 +3158,10 @@ type RespLiveInfo = {
     template: string;
     sourceType: number;
     liveImmersion: number;
-    liveCompany: number;
-    liveMode: string;
-    liveSubMode: string;
-    liveId: string;
+    liveCompany?: number;
+    liveMode?: string;
+    liveSubMode?: string;
+    liveId?: string;
 };
 
 /**
@@ -4188,22 +4188,22 @@ type SafeArea = {
  * @property screenWidth - 屏幕宽度
  * @property screenHeight - 屏幕高度
  * @property isLandscape - 屏幕是否是横屏高度
- * @property pixelRatio - 设备像素比
+ * @property [pixelRatio] - 设备像素比
  * @property windowWidth - 可使用窗口宽度，单位 px
  * @property windowHeight - 可使用窗口高度，单位 px
- * @property statusBarHeight - 状态栏的高度，单位 px
- * @property screenTop - 窗口上边缘的 y 值
+ * @property [statusBarHeight] - 状态栏的高度，单位 px
+ * @property [screenTop] - 窗口上边缘的 y 值
  * @property [safeArea] - 在竖屏正方向下的安全区域。部分机型没有安全区域概念，则不返回 safeArea 字段
  */
 type WindowInfo = {
     screenWidth: number;
     screenHeight: number;
     isLandscape: boolean;
-    pixelRatio: number;
+    pixelRatio?: number;
     windowWidth: number;
     windowHeight: number;
-    statusBarHeight: number;
-    screenTop: number;
+    statusBarHeight?: number;
+    screenTop?: number;
     safeArea?: SafeArea;
 };
 
@@ -6521,21 +6521,24 @@ namespace ob {
      * @param callback - 收到消息时回调
      * @returns 调用结果
      */
-    function on(topic: string, callback: OBCallback): void;
+    function on(topic: string, callback: OBCallback): Promise<void>;
     /**
      * 取消监听ob消息
      * @param topic - 消息名 matchStatusChange-比赛状态改变(默认), perspectiveChange-当前视角改变
      * @param [callback] - 调用ob.on()时传入的函数的引用
      * @returns 调用结果
      */
-    function off(topic: string, callback?: OBCallback): void;
+    function off(topic: string, callback?: OBCallback): Promise<void>;
 }
 
 /**
- * @property state - 状态值
+ * 比赛状态信息
+ * @property [state] - 状态值
+ * @property status - 状态值
  */
-type MatchInfo = {
-    state: string;
+type MatchInfoRsp = {
+    state?: string;
+    status: string;
 };
 
 /**
@@ -6562,12 +6565,12 @@ type PerspectiveParams = {
 
 /**
  * 视角信息
- * @property pid - 视角id
- * @property name - 视角名称
+ * @property [pid] - 视角id
+ * @property [name] - 视角名称
  */
 type PerspectiveInfo = {
-    pid: number;
-    name: string;
+    pid?: number;
+    name?: string;
 };
 
 /**
@@ -6586,14 +6589,14 @@ namespace observer {
      * @param callback - 收到消息时回调 返回对应消息名的后台消息content
      * @returns 调用结果
      */
-    function on(topic: string, callback: ObserverCallback): void;
+    function on(topic: string, callback: ObserverCallback): Promise<void>;
     /**
      * 取消监听后台消息
      * @param topic - 消息名
      * @param [callback] - 消息回调
      * @returns 调用结果
      */
-    function off(topic: string, callback?: ObserverCallback): void;
+    function off(topic: string, callback?: ObserverCallback): Promise<void>;
     /**
      * 触发小程序消息
      * @param topic - 小程序消息名
@@ -7157,14 +7160,14 @@ namespace player {
      * @param callback - 事件回调
      * @returns 调用结果
      */
-    function on(topic: string, callback: (...params: any[]) => any): void;
+    function on(topic: string, callback: (...params: any[]) => any): Promise<void>;
     /**
      * 取消事件监听
      * @param topic - 事件名 waiting-waiting, seeking-seeking, seeked-seeked, playing-playing, ended-ended, canplay-canplay, loadedmetadata-loadedmetadata, pause-pause, play-play, timeupdate-timeupdate, videoFrameReduceStart-videoFrameReduceStart, videoFrameGrowEnd-videoFrameGrowEnd
      * @param [callback] - 事件回调
      * @returns 调用结果
      */
-    function off(topic: string, callback?: (...params: any[]) => any): void;
+    function off(topic: string, callback?: (...params: any[]) => any): Promise<void>;
     /**
      * 切换当前直播间线路
      * @param params - 切换线路参数
@@ -7345,13 +7348,13 @@ type CurrentLineInfo = {
 
 /**
  * 视频信息
- * @property duration - 视频时长
- * @property currentTime - 当前播放时间
+ * @property [duration] - 视频时长
+ * @property [currentTime] - 当前播放时间
  * @property isPlaying - 是否正在播放
  */
 type VideoInfo = {
-    duration: number;
-    currentTime: number;
+    duration?: number;
+    currentTime?: number;
     isPlaying: boolean;
 };
 

package/package.json

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