larksr_websdk 3.2.324 → 3.2.327

package/dist/types/screen_state.d.ts

@@ -104,12 +104,14 @@ export default class ScreenState extends EventBase<SCREEN_EVENT_TYPE, ScreenEven
     private _rootElement;
     private mobileForceLandScape;
     private bgColor;
-    get handelRootElementSize(): boolean;
-    private _handelRootElementSize;
+    get handleRootElementSize(): boolean;
+    private _handleRootElementSize;
+    get onlyHandleRootElementTransform(): boolean;
+    private _onlyHandleRootElementTransform;
     private larksr;
     get baseElementScale(): number;
     private _baseElementScale;
-    constructor(rootElement: HTMLElement, params: IAppliParams, larksr: LarkSR, handelRootElementSize?: boolean);
+    constructor(rootElement: HTMLElement, params: IAppliParams, larksr: LarkSR, handleRootElementSize?: boolean, onlyHandleRootElementTransform?: boolean);
     reset(params: IAppliParams): void;
     setMobileForceLandScape(force: boolean): void;
     resize(baseElementScale?: number): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "larksr_websdk",
-  "version": "3.2.324",
+  "version": "3.2.327",
   "description": "Larksr websdk. Easy to build a cloud render client for larksr system or ue4 pixelstreaming.docs: https://pingxingyun.github.io/webclient_sdk/",
   "keywords": [
     "pingxingyun",

package/types/larksr.d.ts

@@ -218,7 +218,7 @@ interface ILarkSRConfig {
      * 必选项 根元素。组件会挂载到跟元素下面
      * 注意*不要*设置为 document.documentElement
      * 默认模式下会通过旋转根元素实现强制横屏模式。
-     * @see handelRootElementSize
+     * @see handleRootElementSize
      * @see scaleMode
      */
     rootElement: HTMLElement;
@@ -249,7 +249,18 @@ interface ILarkSRConfig {
      * 注意，当关闭时不会自动填充根元素，如果根元素高度为 0 将显示不出来。
      * 注意，当关闭时 mobileForceLandscape 将失去作用。
      */
+    handleRootElementSize?: boolean;
+    /**
+     * 同 handleRootElementSize
+     */
     handelRootElementSize?: boolean;
+    /**
+     * 是否只设置根的组件的旋转。只当 handleRootElementSize 为 true 时有效。设置根组件的旋转用于 mobileForceLandscape 模式。
+     * 默认为false，此时 SDK 会设置根组件的宽高,margin 0,padding 0
+     * 为true并且handleRootElementSize也为true时，只设置根组件的旋转属性，用于强制横屏模式以及强制横屏竖屏的切换。
+     * 要注意onlyHandleRootElementTransform开启成功时，要保证根节点的元素大小并且当根节点变化时应调用 resize 方法通知更新根节点的大小。
+     */
+    onlyHandleRootElementTransform?: boolean;
     /**
      * 是否在sdk内部监听鼠标键盘等输入事件
      * 如果关闭需要手动发送输入事件
@@ -261,7 +272,7 @@ interface ILarkSRConfig {
      * 当视频播自动放失败时是否尝试静音播放,静音播放时将抛出事件
      * 静音播放当用户操作屏幕时将尝试播放声音
      */
-    mutePlayWhenFiled?: boolean;
+    mutePlayWhenFailed?: boolean;
     /**
      * 可选项，是否是 vr 监控类型。
      */
@@ -362,6 +373,11 @@ interface ILarkSRConfig {
      * 'touchScreen' | 'mouse'
      */
     touchOperateMode?: 'touchScreen' | 'mouse';
+    /**
+     * 优先使用渲染服务器点对点连接外网ip
+     * 如果配置将覆盖后台设置的 preferPublicIp 参数
+     */
+    preferPublicIp?: string;
 }
 declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**
@@ -525,6 +541,12 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * @param config 本地配置，优先级最高
      */
     constructor(config: ILarkSRConfig);
+    /**
+     * 单独设置服务器地址，作用同 config 中的 serverAddress 字段
+     * 在进入应用之前都可以更新。
+     * @param serverAddress 服务器地址，如 http://192.168.0.55:8181/
+     */
+    updateServerAddress(serverAddress: string): void;
     /**
      * 单独设置sdk授权码，目前总会返回成功 promise，具体验证失败将在 connectWithPxyHost 或 connect 返回
      * @param id sdk id 初始化sdkid
@@ -592,7 +614,7 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     destroy(): void;
     /**
      * 设置是否强制横屏显示内容.
-     * handelRootElementSize 必须设置为 true 才有作用。
+     * handleRootElementSize 必须设置为 true 才有作用。
      * 要注意强制横屏模式下网页的坐标系xy和视觉上相反，如果通过外部输入 input 事件。要注意调整
      * @param force 是否强制横屏
      */
@@ -656,9 +678,13 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**
      * 采集一帧图像
      * @params data: any 抛出采集事件时抛出的附加data，比如采集的时间戳
+     * @params option:  { width: number, height: number } 截图的宽高，如果未设置则使用云端应用窗口的宽高
      * @return { data: any, base64: base64string } 返回传入的 data 和采集的 base64 字符串
      */
-    captrueFrame(data: any): {
+    captrueFrame(data: any, option?: {
+        width: number;
+        height: number;
+    } | null | undefined): {
         data: any;
         base64: any;
     };