@ray-js/ray-ipc-player 2.0.4-beta-1 → 2.0.6-beta-1

package/README-zh_CN.md

@@ -1,3 +1,5 @@
+[English](./README.md) | 简体中文
+
 # ray-ipc-player
 
 针对 ipc-player 基础能力进行封装，包含 loading、设备异常、离线等提示
@@ -6,30 +8,114 @@
 
 ```ts
 export type IProps = {
-  devId: string; // 设备id
-  onlineStatus: Boolean; // 设备是否在线
-  privateState?: boolean; // 设备隐私模式
-  defaultMute?: Boolean; // 默认静音
-  clarity?: string; // 默认标清 normal：标清，hd：高清
-  updateLayout?: any; // 外层父节点样式变化，播放器监听不到，需要主动触发播放器视图更新，每次需要设置不同的值
-  onChangeStreamStatus?: (statusCode: number) => void; // 视频流状态发生变化
-  onCtx?: (playerRef: object) => void; // 获取ipcPlayer实例ctx以及重试方法retry
-  onInitPreview?: (devId: string) => void; // 初始化预览成功
-  onPlayerTap?: (devId: string) => void; // 播放器区域点击事件
-  scalable?: Boolean; // 是否可缩放
-  scaleMultiple?: number; // 缩放比例
-  rotateZ?: number; // 摄像头旋转角度
-  ptzControllable?: Boolean; // 是否开启视频区云平台控制
+  /**
+   * @description.en devId
+   * @description.zh 设备id
+   * @default ""
+   */
+  devId: string;
+  /**
+   * @description.en onlineStatus
+   * @description.zh 设备是否在线
+   * @default true
+   */
+  onlineStatus: boolean;
+  /**
+   * @description.en privateState
+   * @description.zh 隐私模式
+   * @default false
+   */
+  privateState?: boolean;
+  /**
+   * @description.en defaultMute
+   * @description.zh 默认静音
+   * @default true
+   */
+  defaultMute?: boolean;
+  /**
+   * @description.en clarity
+   * @description.zh 清晰度 normal：标清，hd：高清
+   * @default "normal"
+   */
+  clarity?: 'normal' | 'hd';
+  /**
+   * @description.en updateLayout
+   * @description.zh 外层父节点样式变化，播放器监听不到，需要主动触发播放器视图更新，每次需要设置不同的字符串值
+   * @default ""
+   */
+  updateLayout?: any;
+  /**
+   * @description.en onChangeStreamStatus
+   * @description.zh 通知视频流状态发生变化
+   * @default (data) => void
+   */
+  onChangeStreamStatus?: (data) => void;
+  /**
+   * @description.en onCtx
+   * @description.zh 获取ipcPlayer实例ctx以及重试方法retry
+   * @default (playerRef) => void
+   */
+  onCtx?: (playerRef) => void;
+  /**
+   * @description.en onInitPreview
+   * @description.zh 初始化预览成功通知
+   * @default (devId) => void
+   */
+  onInitPreview?: (data) => void;
+  /**
+   * @description.en onPlayerTap
+   * @description.zh 播放器区域点击事件
+   * @default (devId) => void
+   */
+  onPlayerTap?: (data) => void;
+  /**
+   * @description.en scalable
+   * @description.zh 是否可缩放
+   * @default true
+   */
+  scalable?: boolean;
+  /**
+   * @description.en scaleMultiple
+   * @description.zh 缩放比例
+   * @default 0
+   */
+  scaleMultiple?: number;
+  /**
+   * @description.en rotateZ
+   * @description.zh 摄像头旋转角度
+   * @default 0
+   */
+  rotateZ?: number;
+  /**
+   * @description.en ptzControllable
+   * @description.zh 是否开启视频区云平台控制
+   * @default true
+   */
+  ptzControllable?: boolean;
+  /**
+   * @description.en playerStyle
+   * @description.zh 播放器样式
+   * @default {}
+   */
   playerStyle?: {
-    // 播放器样式
     bgColor?: string; // 背景底色
     borderRadius?: number | string; // 边框圆角
     borderStyle?: 'solid' | 'dashed'; // 边框样式
     borderColor?: string; // 边框颜色
     borderWidth?: string | number; // 边框宽度
   };
-  loadText?: string; // 加载过程中的文案，可结合onChangeStreamStatus事件做文案配置
-  extend?: object; // 扩展属性
+  /**
+   * @description.en loadText
+   * @description.zh 加载过程中的文案，可结合onChangeStreamStatus事件做文案配置
+   * @default "正在获取视频流..."
+   */
+  loadText?: string;
+  /**
+   * @description.en extend
+   * @description.zh 扩展属性
+   * @default {}
+   */
+  extend?: Record<string, any>;
 };
 ```
 
@@ -99,6 +185,7 @@ const PlayerDemo = () => {
     <View style={{ width: playerWidth }}>
       <Player
         devId={devId}
+        onlineStatus={true}
         onCtx={onCtx}
         updateLayout={updateLayout}
         extend={{

package/README.md

@@ -1,3 +1,5 @@
+English | [简体中文](./README-zh_CN.md)
+
 # ray-ipc-player
 
 Encapsulates basic ipc-player capabilities, including loading, device exception, and offline prompts
@@ -8,109 +10,92 @@ Encapsulates basic ipc-player capabilities, including loading, device exception,
 export type IProps = {
   /**
    * @description.en devId
-   * @description.zh 设备id
    * @default ""
    */
   devId: string;
   /**
-   * @description.en onlineStatus
-   * @description.zh 设备是否在线
+   * @description.en Whether the device is online
    * @default true
    */
   onlineStatus: boolean;
   /**
-   * @description.en privateState
-   * @description.zh 隐私模式
+   * @description.en Privacy mode
    * @default false
    */
   privateState?: boolean;
   /**
    * @description.en defaultMute
-   * @description.zh 默认静音
    * @default true
    */
   defaultMute?: boolean;
   /**
    * @description.en clarity
-   * @description.zh 清晰度 normal：标清，hd：高清
    * @default "normal"
    */
   clarity?: 'normal' | 'hd';
   /**
-   * @description.en updateLayout
-   * @description.zh 外层父节点样式变化，播放器监听不到，需要主动触发播放器视图更新，每次需要设置不同的字符串值
+   * @description.en Notifying the view of updates, each time you need to set a different value
    * @default ""
    */
   updateLayout?: any;
   /**
-   * @description.en onChangeStreamStatus
-   * @description.zh 通知视频流状态发生变化
+   * @description.en Notifies the video stream that the state has changed
    * @default (data) => void
    */
   onChangeStreamStatus?: (data) => void;
   /**
-   * @description.en onCtx
-   * @description.zh 获取ipcPlayer实例ctx以及重试方法retry
+   * @description.en Obtain ipcPlayer instance ctx and retry method Retry
    * @default (playerRef) => void
    */
   onCtx?: (playerRef) => void;
   /**
-   * @description.en onInitPreview
-   * @description.zh 初始化预览成功通知
+   * @description.en The initialization preview is successful
    * @default (devId) => void
    */
   onInitPreview?: (data) => void;
   /**
-   * @description.en onPlayerTap
-   * @description.zh 播放器区域点击事件
+   * @description.en Click events in the player area
    * @default (devId) => void
    */
   onPlayerTap?: (data) => void;
   /**
-   * @description.en scalable
-   * @description.zh 是否可缩放
+   * @description.en Scalable or not
    * @default true
    */
   scalable?: boolean;
   /**
-   * @description.en scaleMultiple
-   * @description.zh 缩放比例
+   * @description.en Scale of scale
    * @default 0
    */
   scaleMultiple?: number;
   /**
-   * @description.en rotateZ
-   * @description.zh 摄像头旋转角度
+   * @description.en Camera rotation Angle
    * @default 0
    */
   rotateZ?: number;
   /**
-   * @description.en ptzControllable
-   * @description.zh 是否开启视频区云平台控制
+   * @description.en Whether to enable the video area cradle head control
    * @default true
    */
   ptzControllable?: boolean;
   /**
    * @description.en playerStyle
-   * @description.zh 播放器样式
    * @default {}
    */
   playerStyle?: {
-    bgColor?: string; // 背景底色
-    borderRadius?: number | string; // 边框圆角
-    borderStyle?: 'solid' | 'dashed'; // 边框样式
-    borderColor?: string; // 边框颜色
-    borderWidth?: string | number; // 边框宽度
+    bgColor?: string;
+    borderRadius?: number | string;
+    borderStyle?: 'solid' | 'dashed';
+    borderColor?: string;
+    borderWidth?: string | number;
   };
   /**
-   * @description.en loadText
-   * @description.zh 加载过程中的文案，可结合onChangeStreamStatus事件做文案配置
-   * @default "正在获取视频流..."
+   * @description.en Loading copy
+   * @default "Getting a video stream..."
    */
   loadText?: string;
   /**
-   * @description.en extend
-   * @description.zh 扩展属性
+   * @description.en Extended Attributes
    * @default {}
    */
   extend?: Record<string, any>;
@@ -148,8 +133,8 @@ import { Button, View } from '@ray-js/components';
 
 const PlayerDemo = () => {
   const [updateLayout, setUpdateLayout] = useState('');
-  const [state, setState] = useState({}); // player实例
-  const [playerWidth, setPlayerWidth] = useState('200px'); // player宽度
+  const [state, setState] = useState({});
+  const [playerWidth, setPlayerWidth] = useState('200px');
   /** onCtx usage
    *  playerCtx.ctx: The instance of ipc-player,includes preview, definition, mute, video, screenshot and other methods
    *  playerCtx.retry: retry

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@ray-js/ray-ipc-player",
-  "version": "2.0.4-beta-1",
+  "version": "2.0.6-beta-1",
   "description": "ray小程序播放器",
   "keywords": [
-    "tuya-panel",
+    "tuya-miniapp",
     "ray"
   ],
   "main": "lib/index.js",