@hyext/types-ext-sdk-hy 3.14.1-beta.8 → 3.14.1

package/index.d.ts

@@ -839,6 +839,17 @@ namespace advance {
      * @returns 调用结果
      */
     function getDynamicConfigString(params: GetDynamicConfigReq): Promise<GetDynamicConfigRsp>;
+    /**
+     * 获取免流标记
+     * @returns 调用结果
+     */
+    function getFreeFlowFlag(): Promise<FreeFlowFlagRsp>;
+    /**
+     * 直接发送弹幕
+     * @param params - 参数
+     * @returns 调用结果
+     */
+    function sendBarrage(params: SendBarrageReq): Promise<void>;
 }
 
 /**
@@ -1435,6 +1446,22 @@ type GetDynamicConfigReq = {
     key: string;
 };
 
+/**
+ * 免流标记信息
+ * @property flag - 免流标记, 0-无效, 1-腾讯免流卡, 2-阿里免流卡
+ */
+type FreeFlowFlagRsp = {
+    flag: number;
+};
+
+/**
+ * 发送弹幕信息
+ * @property content - 弹幕内容
+ */
+type SendBarrageReq = {
+    content: string;
+};
+
 /**
  * app模块
  */
@@ -2977,6 +3004,15 @@ namespace device {
      * @param params - 输入参数
      */
     function vibrate(params: VibrateReq): Promise<void>;
+    /**
+     * 监听设备摇一摇事件
+     * @param params - 输入参数
+     */
+    function onDeviceShakeShake(params: OnDeviceShakeShakeReq): Promise<void>;
+    /**
+     * 取消监听设备摇一摇事件
+     */
+    function offDeviceShakeShake(): Promise<void>;
 }
 
 /**
@@ -3167,6 +3203,35 @@ type VibrateReq = {
     pattern: number[];
 };
 
+/**
+ * 在 timeRange 时间内发送了 triggerCount 次大于 acceleration m/s² 的加速数据，并且角度变化超过 angle°，则触发
+ * @property [timeRange] - 时间区间，单位秒，默认3s
+ * @property [triggerCount] - 临界次数，默认8次
+ * @property [acceleration] - 临界加速度，单位m/s²，默认15m/s²
+ * @property [angle] - 临界角度，单位°，默认35°
+ */
+type DeviceShakeOptions = {
+    timeRange?: number;
+    triggerCount?: number;
+    acceleration?: number;
+    angle?: number;
+};
+
+/**
+ * 设备摇一摇事件触发回调
+ */
+type DeviceShakeCallback = () => void;
+
+/**
+ * 监听设备摇一摇事件参数
+ * @property [options] - 触发参数
+ * @property callback - 设备摇一摇事件触发的回调函数
+ */
+type OnDeviceShakeShakeReq = {
+    options?: DeviceShakeOptions;
+    callback: DeviceShakeCallback;
+};
+
 /**
  * 逐步废弃
  */
@@ -5671,6 +5736,29 @@ namespace popup {
      * @returns 调用结果
      */
     function modeAvailable(params: ModeAvailableReq): Promise<ModeAvailableRsp>;
+    /**
+     * 进入弹窗队列
+     * @param params - 参数
+     * @returns 调用结果
+     */
+    function popupEnQueue(params: PopupEnQueueReq): Promise<QueueInfo>;
+    /**
+     * 退出弹窗队列
+     * @param params - 调用参数
+     * @returns 调用结果
+     */
+    function popupDeQueue(params: PopupDeQueueReq): Promise<void>;
+    /**
+     * 监听弹窗状态变化
+     * @param params - 调用参数
+     * @returns 调用结果
+     */
+    function onPopupStatusChange(params: OnPopupStatusChangeReq): Promise<void>;
+    /**
+     * 取消监听弹窗状态变化
+     * @returns 调用结果
+     */
+    function offPopupStatusChange(): Promise<void>;
 }
 
 /**
@@ -5773,6 +5861,61 @@ type ModeAvailableRsp = {
     isAvailable: boolean;
 };
 
+/**
+ * 队列信息
+ * @property noticeKey - 回调标记，用来匹配消息
+ * @property showTime - 实际展示时间，用于业务展示倒计时时间，单位是毫秒
+ * @property reportParams - 上报参数，用于点击上报
+ */
+type QueueInfo = {
+    noticeKey: string;
+    showTime: number;
+    reportParams: any;
+};
+
+/**
+ * 进入弹窗队列参数
+ * @property liveroomPopupKey - 直播间弹窗key
+ * @property showTime - 可选，业务想要的显示时间，单位是毫秒，默认值跟key的配置
+ * @property additionReportParams - 可选，额外上报参数
+ */
+type PopupEnQueueReq = {
+    liveroomPopupKey: string;
+    showTime: number;
+    additionReportParams: any;
+};
+
+/**
+ * 退出弹窗队列参数
+ * @property liveroomPopupKey - 直播间弹窗key
+ */
+type PopupDeQueueReq = {
+    liveroomPopupKey: string;
+};
+
+/**
+ * 弹窗状态变信息
+ * @property noticeKey - 调用hyExt.popup.popupEnQueue时返回的标记，用来匹配是哪次setMode的回调
+ * @property status - 状态, canShow-可以显示, shouldHide-需要隐藏（被顶掉）
+ */
+type PopupStatusNotice = {
+    noticeKey: string;
+    status: string;
+};
+
+/**
+ * @param notice - 弹窗状态变信息
+ */
+type PopupStatusChange = (notice: PopupStatusNotice) => void;
+
+/**
+ * 监听弹窗状态变化参数
+ * @property callback - 弹窗状态变化回调
+ */
+type OnPopupStatusChangeReq = {
+    callback: PopupStatusChange;
+};
+
 /**
  * 识别相关
  */
@@ -7721,6 +7864,47 @@ namespace ui {
      * @returns 调用结果
      */
     function showVideoPopup(params: ShowVideoPopupReq): Promise<void>;
+    /**
+     * 创建原生视频组件
+     * @param params - 调用参数
+     * @returns 调用结果
+     */
+    function createNativeVideoComponent(params: CreateNativeVideoComponentReq): Promise<NativeVideoComponentRsp>;
+    /**
+     * 更新原生视频组件
+     * @param params - 调用参数
+     * @returns 调用结果
+     */
+    function updateNativeVideoComponent(params: UpdateNativeVideoComponentReq): Promise<void>;
+    /**
+     * 销毁原生视频组件
+     * @param params - 调用参数
+     * @returns 调用结果
+     */
+    function destroyNativeVideoComponent(params: DestroyNativeVideoComponentReq): Promise<void>;
+    /**
+     * 显示/隐藏负一屏
+     * @param params - 调用参数
+     * @returns 调用结果
+     */
+    function setRecommendViewPointVisibility(params: SetRecommendViewPointVisibilityReq): Promise<void>;
+    /**
+     * 监听原生视频组件通知
+     * @param params - 调用参数
+     * @returns 调用结果
+     */
+    function onNativeVideoComponentNotice(params: OnNativeVideoComponentNoticeReq): Promise<void>;
+    /**
+     * 取消监听原生视频组件通知
+     * @returns 调用结果
+     */
+    function offNativeVideoComponentNotice(): Promise<void>;
+    /**
+     * 控制原生视频组件
+     * @param params - 调用参数
+     * @returns 调用结果
+     */
+    function doNativeVideoComponentAction(params: DoNativeVideoComponentActionReq): Promise<void>;
 }
 
 /**
@@ -7862,6 +8046,141 @@ type ShowVideoPopupReq = {
     liveroomPopupKey: string;
 };
 
+/**
+ * 原生视频组件信息
+ * @property componentId - 视频组件唯一id
+ */
+type NativeVideoComponentRsp = {
+    componentId: string;
+};
+
+/**
+ * 更新原生视频组件参数
+ * @property x - x坐标，相对于容器左上角，单位是点/像素
+ * @property y - y坐标，相对于容器左上角，单位是点/像素
+ * @property width - 宽度，单位是点/像素
+ * @property height - 高度，单位是点/像素
+ */
+type ComponentLayout = {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+};
+
+/**
+ * 实时点播模式
+ * @property url - 视频url
+ * @property cdnName - CDN域名
+ * @property isEnd - 是否是最后一个8视频，播放器播完状态会返回播放结束
+ */
+type LiveVodModeInfo = {
+    url: string;
+    cdnName: string;
+    isEnd: boolean;
+};
+
+/**
+ * 配置信息
+ * @property url - 视频url
+ * @property channel - 点播视频品类ID
+ * @property isFreeData - 是否免流
+ * @property extraParam - 额外参数，key和value都是string
+ */
+type NativeVideoComponentConfig = {
+    url: string;
+    channel: string;
+    isFreeData: boolean;
+    extraParam: any;
+};
+
+/**
+ * 创建原生视频组件参数
+ * @property [url] - 视频url
+ * @property [autoPlay] - 可选，是否自动播放，默认是否
+ * @property [mutePlay] - 可选，是否静音播放，默认是否
+ * @property [liveVodMode] - 实时点播模式
+ * @property [layout] - 视频组件布局
+ * @property [config] - 配置信息
+ */
+type CreateNativeVideoComponentReq = {
+    url?: string;
+    autoPlay?: boolean;
+    mutePlay?: boolean;
+    liveVodMode?: LiveVodModeInfo;
+    layout?: ComponentLayout;
+    config?: NativeVideoComponentConfig;
+};
+
+/**
+ * 更新原生视频组件参数
+ * @property componentId - 视频组件唯一id
+ * @property [url] - 视频url
+ * @property [autoPlay] - 可选，是否自动播放，默认是否
+ * @property [mutePlay] - 可选，是否静音播放，默认是否
+ * @property [liveVodMode] - 实时点播模式
+ * @property [layout] - 视频组件布局
+ */
+type UpdateNativeVideoComponentReq = {
+    componentId: string;
+    url?: string;
+    autoPlay?: boolean;
+    mutePlay?: boolean;
+    liveVodMode?: LiveVodModeInfo;
+    layout?: ComponentLayout;
+};
+
+/**
+ * 销毁原生视频组件参数
+ * @property componentId - 视频组件唯一id
+ */
+type DestroyNativeVideoComponentReq = {
+    componentId: string;
+};
+
+/**
+ * 显示/隐藏负一屏参数
+ * @property visible - 显示/隐藏
+ */
+type SetRecommendViewPointVisibilityReq = {
+    visible: boolean;
+};
+
+/**
+ * 原生视频组件通知信息
+ * @property componentId - 原生视频组件id
+ * @property eventName - 事件名
+ * @property message - 事件消息
+ */
+type NativeVideoComponentNotice = {
+    componentId: string;
+    eventName: string;
+    message: string;
+};
+
+/**
+ * @param notice - 原生视频组件通知信息
+ */
+type NativeVideoComponentNoticeCallback = (notice: NativeVideoComponentNotice) => void;
+
+/**
+ * 监听原生视频组件通知参数
+ * @property callback - 原生视频组件通知回调
+ */
+type OnNativeVideoComponentNoticeReq = {
+    callback: NativeVideoComponentNoticeCallback;
+};
+
+/**
+ * 控制原生视频组件参数
+ * @property action - 操作, play-开始, pause-暂停, resume-继续
+ * @property componentId - 视频组件唯一 id
+ */
+type DoNativeVideoComponentActionReq = {
+    action: string;
+    componentId: string;
+};
+
 /**
  * HY vidoe
  */

package/package.json

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