@hyext/types-ext-sdk-hy 4.2.2 → 4.2.3-beta.2

package/index.d.ts

@@ -2915,6 +2915,70 @@ namespace context {
      * @returns 调起成功
      */
     function requestPayment(params: RequestPaymentReq): Promise<void>;
+    /**
+     * 获取用户信息
+     * @returns 返回结果
+     */
+    function getUserInfoSafe(): Promise<GetUserInfoSafeRsp>;
+    /**
+     * 获取主播信息
+     * @returns 返回结果
+     */
+    function getStreamerInfoSafe(): Promise<GetStreamerInfoSafeRsp>;
+    /**
+     * 监听分享直播间事件
+     * @param params - 监听分享直播间参数
+     */
+    function onShareLiveNoticeSafe(params: OnShareLiveNoticeSafe): Promise<void>;
+    /**
+     * 取消监听分享直播间事件
+     */
+    function offShareLiveNoticeSafe(): Promise<void>;
+    /**
+     * 监听高级用户进场
+     * @param params - 参数
+     */
+    function onVipEnterBannerNoticeSafe(params: OnVipEnterBannerNoticeSafeReq): Promise<void>;
+    /**
+     * 取消监听高级用户进场
+     */
+    function offVipEnterBannerNoticeSafe(): Promise<void>;
+    /**
+     * 监听开通贵族
+     * @param params - 监听开通贵族参数
+     */
+    function onOpenNobleNoticeSafe(params: OnOpenNobleNoticeSafeReq): Promise<void>;
+    /**
+     * 关闭监听开通贵族
+     */
+    function offOpenNobleNoticeSafe(): Promise<void>;
+    /**
+     * 监听开通守护
+     * @param params - 监听开通守护参数
+     */
+    function onOpenGuardianNoticeSafe(params: OnOpenGuardianNoticeSafeReq): Promise<void>;
+    /**
+     * 关闭监听开通守护
+     */
+    function offOpenGuardianNoticeSafe(): Promise<void>;
+    /**
+     * 监听弹幕事件
+     * @param params - 监听弹幕事件参数
+     */
+    function onBarrageChangeSafe(params: OnBarrageChangeSafeReq): Promise<void>;
+    /**
+     * 取消监听弹幕事件
+     */
+    function offBarrageChangeSafe(): Promise<void>;
+    /**
+     * 监听当前直播间送礼事件
+     * @param params - 监听当前直播间送礼事件参数
+     */
+    function onGiftChangeSafe(params: OnGiftChangeSafeReq): Promise<void>;
+    /**
+     * 取消监听当前直播间送礼事件
+     */
+    function offGiftChangeSafe(): Promise<void>;
 }
 
 /**
@@ -3569,6 +3633,274 @@ type RequestPaymentReq = {
     paySign: string;
 };
 
+/**
+ * @property userNick - 用户昵称
+ * @property userAvatarUrl - 用户头像地址
+ * @property userLevel - 用户等级
+ * @property userUnionId - 用户的unionId
+ */
+type GetUserInfoSafeRsp = {
+    userNick: string;
+    userAvatarUrl: string;
+    userLevel: number;
+    userUnionId: string;
+};
+
+/**
+ * @property streamerNick - 主播昵称
+ * @property streamerAvatarUrl - 主播头像地址
+ * @property streamerSex - 主播性别, 1-表示男, 2-表示女
+ * @property streamerRoomId - 房间Id
+ * @property streamerLevel - 主播等级
+ * @property [streamerUnionId] - 主播unionId
+ */
+type GetStreamerInfoSafeRsp = {
+    streamerNick: string;
+    streamerAvatarUrl: string;
+    streamerSex: number;
+    streamerRoomId: number;
+    streamerLevel: number;
+    streamerUnionId?: string;
+};
+
+/**
+ * 直播间分享消息
+ * @property actionUrl - 直播间跳转链接
+ * @property content - 分享内容
+ * @property imageUrl - 分享图片的url
+ * @property presenterUnionId - 主播unionId
+ * @property roomId - 房间Id
+ * @property shareType - 分享类型，默认0
+ * @property sharerNick - 分享人的昵称
+ * @property sharerUnionId - 分享人的unionId
+ * @property subtitle - 直播间副标题
+ * @property title - 直播间标题
+ */
+type OnShareLiveNoticeSafeNotice = {
+    actionUrl: string;
+    content: string;
+    imageUrl: string;
+    presenterUnionId: string;
+    roomId: number;
+    shareType: number;
+    sharerNick: string;
+    sharerUnionId: string;
+    subtitle: string;
+    title: string;
+};
+
+/**
+ * 分享直播间回调
+ * @param notice - 直播间分享消息
+ */
+type OnShareLiveNoticeSafeCallback = (notice: OnShareLiveNoticeSafeNotice) => void;
+
+/**
+ * 监听分享直播间参数
+ * @property callback - 分享直播间回调
+ */
+type OnShareLiveNoticeSafe = {
+    callback: OnShareLiveNoticeSafeCallback;
+};
+
+/**
+ * 高级用户进场消息
+ * @property badgeName - 粉丝标签名
+ * @property fansLevel - 粉丝等级
+ * @property nobleLevel - 贵族等级
+ * @property nobleAttrType - 贵族等级类型
+ * @property nobleName - 贵族名
+ * @property unionId - 用户unionId
+ * @property roomId - 房间Id
+ * @property userAvatarUrl - 用户头像
+ * @property userNick - 用户昵称
+ */
+type OnVipEnterBannerNoticeSafeNotice = {
+    badgeName: string;
+    fansLevel: number;
+    nobleLevel: number;
+    nobleAttrType: number;
+    nobleName: string;
+    unionId: string;
+    roomId: number;
+    userAvatarUrl: string;
+    userNick: string;
+};
+
+/**
+ * 高级用户进场回调
+ * @param notice - 高级用户进场消息
+ */
+type OnVipEnterBannerNoticeSafeCallback = (notice: OnVipEnterBannerNoticeSafeNotice) => void;
+
+/**
+ * 监听高级用户进场参数
+ * @property callback - 高级用户进场信息回调
+ */
+type OnVipEnterBannerNoticeSafeReq = {
+    callback: OnVipEnterBannerNoticeSafeCallback;
+};
+
+/**
+ * 开启贵族消息
+ * @property startTime - 贵族生效unix时间戳，单位是秒
+ * @property endTime - 贵族失效unix时间戳，单位是秒
+ * @property openFlag - 标志, 1-首次(非贵族开通任一贵族,或者低等级贵族更换高等级的贵族操作,都并入到首开), 2-续费
+ * @property months - 开通月数
+ * @property nobleLevel - 贵族等级
+ * @property nobleAttrType - 贵族等级类型
+ * @property nobleName - 贵族名
+ * @property roomId - 房间Id
+ * @property unionId - 用户unionId
+ * @property userAvatarUrl - 用户头像
+ * @property userNick - 用户昵称
+ */
+type OnOpenNobleNoticeSafeNotice = {
+    startTime: number;
+    endTime: number;
+    openFlag: number;
+    months: number;
+    nobleLevel: number;
+    nobleAttrType: number;
+    nobleName: string;
+    roomId: number;
+    unionId: string;
+    userAvatarUrl: string;
+    userNick: string;
+};
+
+/**
+ * 开通贵族回调
+ * @param notice - 开启贵族消息
+ */
+type OnOpenNobleNoticeSafeCallback = (notice: OnOpenNobleNoticeSafeNotice) => void;
+
+/**
+ * 监听开通贵族参数
+ * @property callback - 监听开通贵族
+ */
+type OnOpenNobleNoticeSafeReq = {
+    callback: OnOpenNobleNoticeSafeCallback;
+};
+
+/**
+ * 开启守护消息
+ * @property openDays - 开通或者续费天数
+ * @property lastGuardianLevel - 开通或者续费之前的守护等级
+ * @property openGuardianLevel - 开通或续费后守护等级
+ * @property presenterNick - 主播昵称
+ * @property roomId - 房间Id
+ * @property unionId - 用户unionId
+ * @property userAvatarUrl - 用户头像
+ * @property userNick - 用户昵称
+ * @property guardType - 守护类型, 0-初爱守护, 2-超级守护, 3-至尊守护
+ */
+type OnOpenGuardianNoticeSafeNotice = {
+    openDays: number;
+    lastGuardianLevel: number;
+    openGuardianLevel: number;
+    presenterNick: string;
+    roomId: number;
+    unionId: string;
+    userAvatarUrl: string;
+    userNick: string;
+    guardType: number;
+};
+
+/**
+ * 开通守护回调
+ * @param notice - 开启守护消息
+ */
+type OnOpenGuardianNoticeSafeCallback = (notice: OnOpenGuardianNoticeSafeNotice) => void;
+
+/**
+ * 监听开通守护参数
+ * @property callback - 开通守护回调
+ */
+type OnOpenGuardianNoticeSafeReq = {
+    callback: OnOpenGuardianNoticeSafeCallback;
+};
+
+/**
+ * 弹幕消息
+ * @property sendNick - 发言人的昵称
+ * @property senderAvatarUrl - 发言人的头像地址
+ * @property senderGender - 发言人的性别, 0-女, 1-男
+ * @property nobleLevel - 发言人的贵族等级
+ * @property fansLevel - 发言人的粉丝等级
+ * @property content - 弹幕内容
+ * @property unionId - 用户unionId
+ * @property badgeName - 粉丝徽章名
+ */
+type OnBarrageChangeSafeNotice = {
+    sendNick: string;
+    senderAvatarUrl: string;
+    senderGender: number;
+    nobleLevel: number;
+    fansLevel: number;
+    content: string;
+    unionId: string;
+    badgeName: string;
+};
+
+/**
+ * 弹幕事件回调
+ * @param notice - 弹幕事件消息
+ */
+type OnBarrageChangeSafeCallback = (notice: OnBarrageChangeSafeNotice) => void;
+
+/**
+ * 监听弹幕事件参数
+ * @property callback - 弹幕事件回调
+ */
+type OnBarrageChangeSafeReq = {
+    callback: OnBarrageChangeSafeCallback;
+};
+
+/**
+ * 礼物事件消息
+ * @property sendNick - 送礼人的昵称
+ * @property senderAvatarUrl - 送礼人的头像地址
+ * @property itemId - 礼物Id
+ * @property itemName - 礼物名称
+ * @property sendItemCount - 礼物数量
+ * @property sendItemComboHits - 送礼连击数
+ * @property roomId - 房间号
+ * @property unionId - 用户unionId
+ * @property customText - 礼物的自定义文案
+ * @property nobleLevel - 贵族等级
+ * @property totalPay - 此次送礼支付总额（分）
+ * @property nobleAttrType - 贵族等级类型
+ */
+type OnGiftChangeSafeNotice = {
+    sendNick: string;
+    senderAvatarUrl: string;
+    itemId: number;
+    itemName: string;
+    sendItemCount: number;
+    sendItemComboHits: number;
+    roomId: number;
+    unionId: string;
+    customText: string;
+    nobleLevel: number;
+    totalPay: number;
+    nobleAttrType: number;
+};
+
+/**
+ * 礼物事件回调
+ * @param notice - 礼物事件消息
+ */
+type OnGiftChangeSafeCallback = (notice: OnGiftChangeSafeNotice) => void;
+
+/**
+ * 监听当前直播间送礼事件参数
+ * @property callback - 礼物事件回调
+ */
+type OnGiftChangeSafeReq = {
+    callback: OnGiftChangeSafeCallback;
+};
+
 /**
  * 下载中心
  */
@@ -4695,9 +5027,11 @@ type NetworkTypeRsp = {
 
 /**
  * @property isFront - 当前小游戏在APP最前端且APP也在系统前台，返回true，否则返回false
+ * @property enabled - 当前小游戏是否可用，1为正常逻辑，0表示不可用
  */
 type GetMinigameHostInfoRsp = {
     isFront: boolean;
+    enabled: number;
 };
 
 /**
@@ -6595,6 +6929,12 @@ namespace link {
      * @returns 返回调用结果
      */
     function offAudioChange(): Promise<void>;
+    /**
+     * 更新音频播放
+     * @param params - 更新音频播放参数
+     * @returns 返回调用结果
+     */
+    function updateAudioPlaySafe(params: UpdateAudioPlaySafeReq): Promise<void>;
 }
 
 /**
@@ -6711,6 +7051,28 @@ type OnAudioChangeParams = {
     interval?: number;
 };
 
+/**
+ * 更新音频播放
+ * @property [unionId] - 用户的unionId
+ * @property [uid] - 在UDB-SDK相关接口没提供之前暂用
+ * @property [streamName] - 流名称
+ * @property volume - 音量，取值范围是0-100
+ */
+type UpdateAudioPlaySafeItem = {
+    unionId?: string;
+    uid?: number;
+    streamName?: string;
+    volume: number;
+};
+
+/**
+ * 更新音频播放参数
+ * @property list - 参数列表
+ */
+type UpdateAudioPlaySafeReq = {
+    list: UpdateAudioPlaySafeItem[];
+};
+
 /**
  * 直播间事件
  */

package/package.json

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