@ray-js/adapter 1.7.79 → 1.7.81

package/cjs/hostComponents/IpcPlayer/index.d.ts

@@ -1,215 +1,340 @@
-import type * as React from 'react';
-import type { BaseProps, DiffLayer } from '../../types/component.js';
+import * as React from 'react';
+import type { BaseEvent, BaseProps, DiffLayer } from '../../types/component';
+/** 连接或预览状态详情 */
+export interface IpcPlayerStateDetail {
+    /** 连接状态：0 表示连接成功，<0 表示连接异常；预览状态：1 开始预览，0 结束预览 */
+    state: number;
+}
+export interface IpcPlayerConnectChangeEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'connectchange';
+    /** 事件详情数据 */
+    detail: IpcPlayerStateDetail;
+}
+export interface IpcPlayerPreviewChangeEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'previewchange';
+    /** 事件详情数据 */
+    detail: IpcPlayerStateDetail;
+}
+/** 在线状态详情 */
+export interface IpcPlayerOnlineChangeDetail {
+    /** 是否在线 */
+    online: boolean;
+}
+export interface IpcPlayerOnlineChangeEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'onlinechange';
+    /** 事件详情数据 */
+    detail: IpcPlayerOnlineChangeDetail;
+}
+/** 缩放变化详情（普通预览/多目） */
+export interface IpcPlayerZoomChangeNormalDetail {
+    /** 当前缩放倍数 */
+    zoomLevel: number;
+    /** 自由缩放状态标识 */
+    scaleMode: number;
+}
+/** 缩放变化详情（云存储/视频消息） */
+export interface IpcPlayerZoomChangeCloudDetail {
+    /** 自由缩放状态标识 */
+    zoom_level: number;
+    /** 当前缩放倍数 */
+    scale: number;
+}
+/** 缩放变化详情，分视图类型字段不一致 */
+export type IpcPlayerZoomChangeDetail = IpcPlayerZoomChangeNormalDetail | IpcPlayerZoomChangeCloudDetail;
+export interface IpcPlayerZoomChangeEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'zoomchange';
+    /** 事件详情数据 */
+    detail: IpcPlayerZoomChangeDetail;
+}
+/** 初始化完成详情 */
+export interface IpcPlayerInitDoneDetail {
+    /** 最大缩放倍数（可能为空） */
+    maxScaleMultiple?: number;
+    /** 设备相机配置（解析后的 JSON 对象） */
+    obtainCameraConfig: object;
+}
+export interface IpcPlayerInitDoneEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'initdone';
+    /** 事件详情数据 */
+    detail: IpcPlayerInitDoneDetail;
+}
+export interface IpcPlayerVideotapEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'videotap';
+    /** 事件详情数据 */
+    detail?: Record<string, never>;
+}
+/** 错误事件详情 */
+export interface IpcPlayerErrorDetail {
+    /** 错误码 */
+    errCode?: number;
+    /** 错误描述 */
+    errMsg: string;
+}
+export interface IpcPlayerErrorEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'error';
+    /** 事件详情数据 */
+    detail: IpcPlayerErrorDetail;
+}
+export interface IpcPlayerSessionDidDisconnectedEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'sessionDidDisconnected';
+}
+/** 预览失败详情 */
+export interface IpcPlayerCameraPreviewFailureDetail {
+    /** 错误码 */
+    errCode: number;
+    /** 设备 id */
+    deviceId: string;
+}
+export interface IpcPlayerCameraPreviewFailureEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'cameraPreviewFailure';
+    /** 事件详情数据 */
+    detail: IpcPlayerCameraPreviewFailureDetail;
+}
+/** 弱网通知详情 */
+export interface IpcPlayerWeakNetworkDetail {
+    /** 网络状况值（原生为 Long 类型，可能超 32 位） */
+    netValue: number;
+    /** 设备 id */
+    devId: string;
+}
+export interface IpcPlayerCameraNotifyWeakNetworkEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'cameraNotifyWeakNetwork';
+    /** 事件详情数据 */
+    detail: IpcPlayerWeakNetworkDetail;
+}
+export interface IpcPlayerCreateViewSuccessEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'createViewSuccess';
+}
+/** 选中镜头详情（多目） */
+export interface IpcPlayerSelectVideoIndexDetail {
+    /** 镜头索引 */
+    index: number;
+    /** 镜头名称 */
+    name: string;
+    /** 是否支持云台控制 */
+    supportPTZ: boolean;
+    /** 是否支持定位器 */
+    supportLocalizer: boolean;
+    /** 是否支持缩放 */
+    supportZoom: boolean;
+}
+export interface IpcPlayerSelectVideoIndexEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'selectVideoIndex';
+    /** 事件详情数据 */
+    detail: IpcPlayerSelectVideoIndexDetail;
+}
+/** 布局状态详情（多目） */
+export interface IpcPlayerLayoutStatusChangedDetail {
+    /** 屏幕模式（枚举 ordinal）：0 短屏，1 全屏，2 横屏 */
+    screenMode: number;
+    /** 布局样式（枚举 ordinal）：-1 无效，0 画中画，1 平铺，2 宫格，3 缩略图 */
+    layoutStyle: number;
+}
+export interface IpcPlayerLayoutStatusChangedEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'layoutStatusChanged';
+    /** 事件详情数据 */
+    detail: IpcPlayerLayoutStatusChangedDetail;
+}
+/** 定位器定位详情（多目） */
+export interface IpcPlayerLocalizerViewLocatedDetail {
+    /** 联动的球机 index（注意：此处为 string 类型，与 selectVideoIndex 的 number 不同） */
+    index: string;
+    /** x、y 坐标位置 */
+    coor: string;
+}
+export interface IpcPlayerLocalizerViewLocatedEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'localizerViewLocated';
+    /** 事件详情数据 */
+    detail: IpcPlayerLocalizerViewLocatedDetail;
+}
+/** 滑动手势详情（多目，需要转动云台时触发） */
+export interface IpcPlayerSwipeAtVideoIndexDetail {
+    /** 滑动的镜头索引 */
+    index: number;
+    /** 滑动方向：上下左右，枚举 0、1、2、3 */
+    direction: number;
+    /** 手势状态：1 开始，0 结束 */
+    isStop: number;
+}
+export interface IpcPlayerSwipeAtVideoIndexEvent extends BaseEvent {
+    /** 事件类型 */
+    type: 'swipeAtVideoIndex';
+    /** 事件详情数据 */
+    detail: IpcPlayerSwipeAtVideoIndexDetail;
+}
+/**
+ * 实时视频播放组件。基于异层渲染的原生组件，请注意原生组件使用限制。
+ *
+ * @public
+ * @alias IpcPlayer
+ * @since @ray-js/ray 0.6.9
+ * @example 基础用法 ./demos/basic/index.tsx sandbox ide
+ * @example IPC 播放控制 ./demos/playback-control/index.tsx sandbox ide
+ */
 export interface IpcPlayerProps extends BaseProps, DiffLayer {
+    /**
+     * 直播类型，透传原生
+     *
+     * @internal
+     */
     type?: number;
+    /** 设备 id，组件的唯一标识符，必须设置 */
     deviceId: string;
+    /** 自动播放 */
     autoplay?: boolean;
+    /** 是否静音 */
     muted?: boolean;
     /**
-     * 清晰度,
-     * 'SS', // 省流量   -------  ss
-     * 'SD', // 标清  ---- normal
-     * 'HD', // 高清 --- hd
-     * 'UD', // 超清 --- ud
-     * 'SSP', // 超超清 --- ssp
-     * 'AUTO', // 自动 --- auto
-     * 'AUDIO', // 音频模式 - audio
+     * 清晰度：ss 省流量、normal 标清、hd 高清、ud 超清、ssp 超超清、auto 自动、audio 音频模式
      */
     clarity?: 'ss' | 'normal' | 'hd' | 'ud' | 'ssp' | 'auto' | 'audio';
+    /** 声音输出方式：speaker 扬声器、ear 听筒 */
     soundMode?: 'speaker' | 'ear';
+    /** 画面方向：vertical 竖直、horizontal 水平 */
     orientation?: 'vertical' | 'horizontal';
+    /** 填充模式：contain 长边填满，fillCrop 铺满裁剪 */
     objectFit?: 'contain' | 'fillCrop';
+    /** 跳转本小程序其他页面时是否自动暂停实时音视频 */
     autoPauseIfNavigate?: boolean;
+    /** 跳转 App 其他原生页面时是否自动暂停实时音视频 */
     autoPauseIfOpenNative?: boolean;
+    /** 摄像头旋转角度，0~360 */
     rotateZ?: number;
+    /** 当前是否可缩放 */
     scalable?: boolean;
+    /** 缩放比例，仅在 scalable 为 true 时生效 */
     scaleMultiple?: number;
+    /** 是否开启视频区域云平台控制 */
     ptzControllable?: boolean;
+    /** 边框宽度，单位 px */
     borderWidth?: number | string;
+    /** 边框样式：solid、dashed */
     borderStyle?: 'solid' | 'dashed';
+    /** 边框颜色，十六进制 */
     borderColor?: string;
+    /** 边框圆角，单位 px */
     borderRadius?: number | string;
+    /** 背景颜色，十六进制 */
     backgroundColor?: string;
-    config?: string;
-    extProps?: string | Record<string, any>;
-    /**
-     * 当连接状态发生变化时触发，detail = { state }, state: 0 表示连接成功
-     * @param event
-     * @param event.state 连接状态
-     * @deprecated 请使用 onConnectChange
-     */
-    onConnectchange?: (event: {
-        state: number;
-    }) => void;
-    /**
-     * 当预览状态发生变化时触发，detail = { state }, state: 1 表示开始预览成功, state: 0 表示结束预览成功
-     * @param event
-     * @param event.state 预览状态
-     * @deprecated 请使用 onPreviewChange
-     */
-    onPreviewchange?: (event: {
-        state: number;
-    }) => void;
-    /**
-     * 当 ipc 设备在线状态变化时触发，detail = { online }, online: true 表示在线, online: false 表示离线或断电
-     * @param event
-     * @param event.online 在线状态
-     * @deprecated 请使用 onOnlineChange
-     */
-    onOnlinechange?: (event: {
-        online: boolean;
-    }) => void;
     /**
-     * 初始化完成时触发
-     * @deprecated 请使用 onInitDone
+     * 直播信息配置，透传原生
+     *
+     * @internal
      */
-    onInitdone?: () => void;
-    /**
-     * 视频缩放比例及当前倍数变化，detail = { zoomLevel }, zoomLevel 为缩放比例
-     * @param event
-     * @param event.zoomLevel 缩放比例
-     * @deprecated 请使用 onZoomChange
-     */
-    onZoomchange?: (event: {
-        zoomLevel: number;
-    }) => void;
-    /**
-     * 点击视频时触发
-     * @deprecated 请使用 onVideoTap
-     */
-    onVideotap?: () => void;
-    /**
-     *  当连接状态发生变化时触发，detail = { state }, state: 0 表示连接成功
-     * @param event
-     * @param event.state 连接状态
-     */
-    onConnectChange?: (event: {
-        state: number;
-    }) => void;
-    /**
-     *  当预览状态发生变化时触发，detail = { state }, state: 1 表示开始预览成功, state: 0 表示结束预览成功
-     * @param event
-     * @param event.state 预览状态
-     */
-    onPreviewChange?: (event: {
-        state: number;
-    }) => void;
-    /**
-     *  当 ipc 设备在线状态变化时触发，detail = { online }, online: true 表示在线, online: false 表示离线或断电
-     * @param event
-     * @param event.online 在线状态
-     */
-    onOnlineChange?: (event: {
-        online: boolean;
-    }) => void;
-    /**
-     * 初始化完成时触发
-     */
-    onInitDone?: () => void;
-    /**
-     *  视频缩放比例及当前倍数变化，detail = { zoomLevel }, zoomLevel 为缩放比例
-     * @param event
-     * @param event.zoomLevel 缩放比例
-     */
-    onZoomChange?: (event: {
-        zoomLevel: number;
-    }) => void;
-    /**
-     * 点击视频时触发
-     */
-    onVideoTap?: () => void;
-    /**
-     * 当状态异层时触发 error 事件，detail = { "errCode": 错误码 , "errMsg": 错误描述 }
-     * @param event
-     * @param event.errCode 错误码
-     * @param event.errMsg 错误描述
-     */
-    onError?: (event: {
-        errCode: number | string;
-        errMsg: string;
-    }) => void;
+    config?: string;
     /**
-     * 断开连接
-     * @param event
-     * @param event.errCode 错误码
-     * @param event.devId 设备id
+     * 额外属性配置
+     * @since @ray-js/ray 1.7.79
      */
-    onSessionDidDisconnected?: (event: {
-        errCode: number;
-        devId: string;
-    }) => void;
+    extProps?: string | Record<string, any>;
+    /** 当连接状态发生变化时触发，请使用 onConnectChange */
+    onConnectchange?: (event: IpcPlayerConnectChangeEvent) => void;
+    /** 当预览状态发生变化时触发，请使用 onPreviewChange */
+    onPreviewchange?: (event: IpcPlayerPreviewChangeEvent) => void;
+    /** 当设备在线状态变化时触发，请使用 onOnlineChange */
+    onOnlinechange?: (event: IpcPlayerOnlineChangeEvent) => void;
+    /** 初始化完成时触发，请使用 onInitDone */
+    onInitdone?: (event: IpcPlayerInitDoneEvent) => void;
+    /** 视频缩放比例变化时触发，请使用 onZoomChange */
+    onZoomchange?: (event: IpcPlayerZoomChangeEvent) => void;
+    /** 点击视频时触发，请使用 onVideoTap */
+    onVideotap?: (event: IpcPlayerVideotapEvent) => void;
+    /** 当连接状态发生变化时触发，state 为 0 表示连接成功 */
+    onConnectChange?: (event: IpcPlayerConnectChangeEvent) => void;
+    /** 当预览状态发生变化时触发，state 为 1 表示开始预览成功，0 表示结束预览成功 */
+    onPreviewChange?: (event: IpcPlayerPreviewChangeEvent) => void;
+    /** 当 IPC 设备在线状态变化时触发 */
+    onOnlineChange?: (event: IpcPlayerOnlineChangeEvent) => void;
+    /** 初始化完成时触发 */
+    onInitDone?: (event: IpcPlayerInitDoneEvent) => void;
+    /** 视频缩放比例及当前倍数变化时触发 */
+    onZoomChange?: (event: IpcPlayerZoomChangeEvent) => void;
+    /** 点击视频时触发 */
+    onVideoTap?: (event: IpcPlayerVideotapEvent) => void;
+    /** 状态异常时触发 */
+    onError?: (event: IpcPlayerErrorEvent) => void;
+    /** 断开连接（⚠️ Android 端未下发，断开连接通过 onConnectChange state < 0 体现） */
+    onSessionDidDisconnected?: (event: IpcPlayerSessionDidDisconnectedEvent) => void;
     /**
-     * 预览失败
-     * @param event
-     * @param event.errCode 错误码
-     * @param event.devId 设备id
+     * 预览失败（P2P sessionStatus < 0 时触发，普通预览与多目共用）
+     *
+     * @since IPCKit 6.1.4
      */
-    onCameraPreviewFailure?: (event: {
-        errCode: number;
-        devId: string;
-    }) => void;
+    onCameraPreviewFailure?: (event: IpcPlayerCameraPreviewFailureEvent) => void;
     /**
      * 弱网通知
-     * @param event
-     * @param event.netValue 网络值
-     * @param event.devId 设备id
+     *
+     * @since IPCKit 6.1.4
      */
-    onCameraNotifyWeakNetwork?: (event: {
-        netValue: number;
-        devId: string;
-    }) => void;
+    onCameraNotifyWeakNetwork?: (event: IpcPlayerCameraNotifyWeakNetworkEvent) => void;
     /**
-     * 异层组件创建成功回调
+     * 异层组件创建成功时触发
+     *
+     * @since IPCKit 6.2.3
      */
-    onCreateViewSuccess?: () => void;
+    onCreateViewSuccess?: (event: IpcPlayerCreateViewSuccessEvent) => void;
     /**
-     * 选中视频索引事件，点击选中镜头后触发
-     * @param event
-     * @param event.index 镜头索引
-     * @param event.name 镜头名称
-     * @param event.supportPTZ 是否支持PTZ
-     * @param event.supportLocalizer 是否支持定位器
-     * @param event.supportZoom 是否支持缩放
+     * 选中视频索引时触发
+     *
+     * @since IPCKit 7.3.3
      */
-    onSelectVideoIndex?: (event: {
-        index: number;
-        name: string;
-        supportPTZ: boolean;
-        supportLocalizer: boolean;
-        supportZoom: boolean;
-        [key: string]: any;
-    }) => void;
+    onSelectVideoIndex?: (event: IpcPlayerSelectVideoIndexEvent) => void;
     /**
-     * 布局状态改变事件
-     * @param event
-     * @param event.screenMode 屏幕模式 0: 短屏, 1: 全屏, 2: 横屏
-     * @param event.layoutStyle 布局样式 -1: 无效, 0: 画中画, 1: 平铺, 2: 宫格, 3: 缩略图
+     * 布局状态改变时触发
+     *
+     * @since IPCKit 7.3.3
      */
-    onLayoutStatusChanged?: (event: {
-        screenMode: number;
-        layoutStyle: number;
-    }) => void;
+    onLayoutStatusChanged?: (event: IpcPlayerLayoutStatusChangedEvent) => void;
     /**
-     * 定位器定位事件
-     * @param event
-     * @param event.index 联动的球机index
-     * @param event.coor x、y 位置
+     * 定位器定位时触发
+     *
+     * @since IPCKit 7.3.3
      */
-    onLocalizerViewLocated?: (event: {
-        index: string;
-        coor: string;
-    }) => void;
+    onLocalizerViewLocated?: (event: IpcPlayerLocalizerViewLocatedEvent) => void;
     /**
-     * 滑动播放器手势上报, 需要转动云台
-     * @param event
-     * @param event.index 滑动的镜头
-     * @param event.direction 方向, 上下左右, 枚举值0、1、2、3
-     * @param event.status 1 开始, 0 结束
+     * 滑动播放器手势上报、需要转动云台时触发
+     *
+     * @since IPCKit 7.3.3
      */
-    onSwipeAtVideoIndex?: (event: {
-        index: number;
-        direction: number;
-        status: number;
-    }) => void;
+    onSwipeAtVideoIndex?: (event: IpcPlayerSwipeAtVideoIndexEvent) => void;
 }
 export declare const IpcPlayer: React.ComponentType<IpcPlayerProps>;
+/**
+ * IpcPlayer 组件文档默认值
+ *
+ * @belong IpcPlayer
+ * @defaults
+ */
+export declare const ipcPlayerDefaultProps: {
+    deviceId: string;
+    autoplay: boolean;
+    clarity: string;
+    soundMode: string;
+    orientation: string;
+    objectFit: string;
+    autoPauseIfNavigate: boolean;
+    autoPauseIfOpenNative: boolean;
+    rotateZ: number;
+    scalable: boolean;
+    scaleMultiple: number;
+    ptzControllable: boolean;
+    borderWidth: number;
+    borderStyle: string;
+    borderColor: string;
+    borderRadius: number;
+    backgroundColor: string;
+};

package/cjs/hostComponents/IpcPlayer/index.js

@@ -3,9 +3,34 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IpcPlayer = void 0;
+exports.ipcPlayerDefaultProps = exports.IpcPlayer = void 0;
 const createHostComponent_js_1 = __importDefault(require("../createHostComponent.js"));
 exports.IpcPlayer = (0, createHostComponent_js_1.default)('ipc-player');
+/**
+ * IpcPlayer 组件文档默认值
+ *
+ * @belong IpcPlayer
+ * @defaults
+ */
+exports.ipcPlayerDefaultProps = {
+    deviceId: '',
+    autoplay: false,
+    clarity: 'normal',
+    soundMode: 'speaker',
+    orientation: 'vertical',
+    objectFit: 'contain',
+    autoPauseIfNavigate: true,
+    autoPauseIfOpenNative: true,
+    rotateZ: 0,
+    scalable: true,
+    scaleMultiple: 0,
+    ptzControllable: true,
+    borderWidth: 0,
+    borderStyle: 'solid',
+    borderColor: '#ffffff',
+    borderRadius: 0,
+    backgroundColor: '#ffffff',
+};
 exports.IpcPlayer.defaultProps = {
     deviceId: '',
     autoplay: false,