larksr_websdk 3.2.1 → 3.2.6

package/dist/types/api.d.ts

@@ -36,6 +36,8 @@ export interface GetTaskResult {
 }
 export interface StartAppInfo {
     appliId: string;
+    appliType: number;
+    appliName: string;
     taskId: string;
     renderServerIp: string;
     wsProxy: string;

package/dist/types/appli_params.d.ts

@@ -9,6 +9,10 @@ export interface IAppliParams {
      * appserver 的端口号
      */
     appPort: string;
+    /**
+     * appli type
+     */
+    appliType: number;
     /**
      * 是否使用 websocket 代理
      */
@@ -24,7 +28,7 @@ export interface IAppliParams {
     /**
      * 当前应用名称
      */
-    courseName: string;
+    appliName: string;
     /**
      * @deprecated
      * 应用的宽高。现在云端自动获取宽高
@@ -41,7 +45,7 @@ export interface IAppliParams {
     scaleMode: ScaleMode;
     /**
      * 日志级别
-     * @default 'info'
+     * @default 'warn'
      */
     logLevel: 'info' | 'warn' | 'error';
     /**
@@ -184,13 +188,25 @@ export interface IAppliParams {
     enableSoundRequire: boolean;
     toastLevel: number;
 }
+export declare enum AppliType {
+    DESKTOP = 1,
+    SHARED = 2,
+    PIXEL_STREAMING = 13,
+    VR = 3,
+    VR_STEAM = 5,
+    NV_VR = 6,
+    XR = 7,
+    PXY_AR = 9,
+    NV_AR = 11
+}
 export declare class AppliParams implements IAppliParams {
     appServer: string;
     appPort: string;
+    appliType: AppliType;
     wsProxy: boolean;
     preferPubOutIp: string;
     taskid: string;
-    courseName: string;
+    appliName: string;
     width: number;
     height: number;
     scaleMode: ScaleMode;

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
 import 'core-js/stable/symbol';
-import { LarkSR, CreateLarkSRClientFromeAPI, CreateLarkSRClientFromeUrl, LarkEventType, LarkSRClientEvent, AppliParams, LoadAppliParamsFromUrl, AppliParamsUtils, LoadAppliParamsStartAppInfo, EventBase, API, Operation, Capabilities, ScaleMode, CloudLark, FullScreen, LockPointer, KEYMAP, ILarkSRConfig, PlayerModeType, UserType, LarkSREvent } from "./larksr";
+import { LarkSR, CreateLarkSRClientFromeAPI, CreateLarkSRClientFromeUrl, LarkEventType, LarkSRClientEvent, AppliParams, LoadAppliParamsFromUrl, AppliParamsUtils, LoadAppliParamsStartAppInfo, EventBase, API, Operation, Capabilities, ScaleMode, CloudLark, FullScreen, LockPointer, ILarkSRConfig, PlayerModeType, UserType, LarkSREvent } from "./larksr";
 declare const _default: {
     LarkSR: typeof LarkSR;
     CreateLarkSRClientFromeAPI: typeof CreateLarkSRClientFromeAPI;
@@ -16,6 +16,9 @@ declare const _default: {
     FullScreen: typeof FullScreen;
     LockPointer: typeof LockPointer;
     Operation: typeof Operation;
+    LarkSRClientEvent: typeof LarkSRClientEvent;
+    LarkEventType: typeof LarkEventType;
+    KEYMAP: import("./operation/keymap").VritualKeyMapOptions;
 };
 export default _default;
-export { LarkEventType, LarkSRClientEvent, KEYMAP, ILarkSRConfig, PlayerModeType, UserType, LarkSREvent, };
+export { ILarkSRConfig, PlayerModeType, UserType, LarkSREvent, };

package/dist/types/lark/application.d.ts

@@ -3,6 +3,7 @@ import * as Msg from '../protobuf/cloudlark';
 import WebSocektChannel from './websocket_channel';
 import WebsocketProxy from './websocket_proxy';
 import { LarkSR } from '../larksr';
+import PixelStreamingWebsocketChannel from './test_pixel_streaming';
 export declare enum APP_STATE {
     BEFORE_CREATE = 0,
     INITED = 1,
@@ -44,6 +45,7 @@ export interface AppEvent extends LocalEvent<APP_EVENT_TYPE> {
 export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     private websocketChannel;
     private websocketProxy;
+    private testPixelStreaming;
     private peerConnection;
     get state(): APP_STATE;
     set state(state: APP_STATE);
@@ -60,7 +62,7 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     sendTextToDataChannel(text: string): void;
     sendBinaryToDataChannel(binary: Uint8Array): void;
     start(): Promise<void>;
-    connect(): Promise<WebsocketProxy> | Promise<WebSocektChannel> | undefined;
+    connect(): Promise<PixelStreamingWebsocketChannel> | Promise<WebsocketProxy> | Promise<WebSocektChannel> | undefined;
     disConnect(): void;
     closeRtc(): void;
     versionCheck(): void;
@@ -71,8 +73,9 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     restartApp(): void;
     rtcOffer(): void;
     setAnswer(sdp: string): void;
-    setIce(candidate: string): void;
+    setIce(sdpMlineindex: number, sdpmid: string, candidate: string): void;
     sendInput(input: Msg.CloudLark.ClientInput): void;
+    sendInputBuffer(buffer: ArrayBuffer): void;
     private onChannelOpen;
     private onClose;
     private onChannelMsg;

package/dist/types/lark/lark_event_type.d.ts

@@ -1,4 +1,4 @@
-export declare const enum LarkEventType {
+export declare enum LarkEventType {
     LK_WEB_CLIENT_LOAD_SUCCESS = 1,
     LK_API_ENTERAPPLI_SUCCESS = 10,
     LK_API_ENTERAPPLI_FAILED = 11,

package/dist/types/lark/message.d.ts

@@ -1,11 +1,12 @@
 import * as Msg from '../protobuf/cloudlark';
 import { LarkEventType } from './lark_event_type';
 export declare const MESSAGE_MAGIC = 538317090;
+export declare const PIXEL_STREAMING_MESSAGE_MAGIC = 539037986;
 export default class Message {
-    static emptyMsg(): Msg.CloudLark.ToServerMessage;
-    static versionCheckRequest(): Msg.CloudLark.ToServerMessage;
-    static taskRequest(taskid: string, isInteractiveMode: boolean, isObMode: boolean, nickName: string): Msg.CloudLark.ToServerMessage;
-    static startStreamReqeuest(request: Msg.CloudLark.IStartStreamRequest): Msg.CloudLark.ToServerMessage;
+    static emptyMsg(isPixelStreaming?: boolean): Msg.CloudLark.ToServerMessage;
+    static versionCheckRequest(isPixelStreaming: boolean): Msg.CloudLark.ToServerMessage;
+    static taskRequest(taskid: string, isInteractiveMode: boolean, isObMode: boolean, nickName: string, isPixelStreaming: boolean): Msg.CloudLark.ToServerMessage;
+    static startStreamReqeuest(request: Msg.CloudLark.IStartStreamRequest, isPixelStreaming: boolean): Msg.CloudLark.ToServerMessage;
     static startMonitorStreamReqeuest(request: Msg.CloudLark.IVrMonitorRequest): Msg.CloudLark.ToServerMessage;
     static rtcOfferMsg(type: string, sdp: string): Msg.CloudLark.ToServerMessage;
     static iceMsg(sdpmid: string, sdpMlineindex: number, candidate: string): Msg.CloudLark.ToServerMessage;

package/dist/types/lark/test_pixel_streaming.d.ts

@@ -0,0 +1,54 @@
+import { EventBase, LocalEvent } from '../event/event_base';
+import { LarkSR } from '../larksr';
+export declare enum CHANNEL_EVENT_TYPE {
+    OPEN = 0,
+    CLOSE = 1,
+    ERROR = 2,
+    CLIENT_MSG = 3
+}
+export interface ChannelEvent extends LocalEvent<CHANNEL_EVENT_TYPE> {
+    data?: any;
+}
+export interface PixelStreamingWebscocketConfig {
+    serverAddress: string;
+    ip: string;
+    port: string;
+    path?: string;
+}
+export default class PixelStreamingWebsocketChannel extends EventBase<CHANNEL_EVENT_TYPE, ChannelEvent> {
+    private get wsServer();
+    private config;
+    private connection;
+    private keepAliveTimeout;
+    private larksr;
+    constructor(config: PixelStreamingWebscocketConfig, larksr: LarkSR);
+    /**
+     *
+     */
+    connect(): Promise<this>;
+    /**
+     *
+     */
+    close(): Promise<void>;
+    sendMsg(msg: any): void;
+    isOpen(): boolean;
+    private startKeepAlive;
+    private stopKeepAlive;
+    /**
+     *
+     */
+    private onMessage;
+    private onOpen;
+    /**
+     *
+     * @param e
+     */
+    private onWSError;
+    /**
+     *
+     * @param e
+     */
+    private onWSClose;
+    private $emit;
+    private createEvent;
+}

package/dist/types/larksr.d.ts

@@ -1,3 +1,7 @@
+/**
+ * fcx@pingxingyun.com
+ * www.pingxingyun.com
+ */
 import { EventBase, LocalEvent } from './event/event_base';
 import Application, { APP_STATE } from './lark/application';
 import { AppliParams, AppliParamsUtils, IAppliParams, LoadAppliParamsFromUrl, LoadAppliParamsStartAppInfo } from './appli_params';
@@ -6,7 +10,7 @@ import API from './api';
 import ScreenState from './screen_state';
 import Operation from './operation/operation';
 import { CloudLark } from './protobuf/cloudlark';
-import { KEYMAP } from './operation/keymap';
+import { KEYMAP, VirtualKey } from './operation/keymap';
 import FullScreen from './utils/full_screen';
 import LockPointer from './utils/lock_pointer';
 import ScaleMode from './utils/scale_mode';
@@ -41,7 +45,7 @@ declare const enum UserType {
 /**
  * LarkSR 实例会发出的事件
  */
-declare const enum LarkSRClientEvent {
+declare enum LarkSRClientEvent {
     /**
      * 连接渲染服务器成功 .
      */
@@ -162,6 +166,8 @@ interface LarkSREvent extends LocalEvent<LarkSRClientEvent> {
 interface ILarkSRConfig {
     /**
      * 必选项 根元素。组件会挂载到跟元素下面
+     * 注意*不要*设置为 document.documentElement
+     * 默认模式下会通过旋转根元素实现强制横屏模式。
      * @see handelRootElementSize
      * @see scaleMode
      */
@@ -255,6 +261,10 @@ interface ILarkSRConfig {
      * 可选项，手机端是否强制横屏
      */
     mobileForceLandscape?: boolean;
+    /**
+     * 初始化鼠标模式, true 锁定，false 非锁定
+     */
+    initCursorMode?: boolean;
 }
 /**
  * 通过调用后台接口获取云端应用参数
@@ -274,7 +284,7 @@ export declare function CreateLarkSRClientFromeAPI(config: ILarkSRConfig, params
  * @param config 传入 config @see ILarkSRConfig
  * @returns Promise 创建 larksr client 是否成功
  */
-export declare function CreateLarkSRClientFromeUrl(config: ILarkSRConfig): Promise<unknown>;
+export declare function CreateLarkSRClientFromeUrl(config: ILarkSRConfig): Promise<LarkSR>;
 declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**
      * 应用参数，构建时传入
@@ -298,6 +308,7 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 当前是否是交互模式，交互默认即可以操作的模式
      */
     get isInteractiveMode(): boolean;
+    get isPixelStreaming(): boolean;
     /**
      * 当前 app 的状态
      */
@@ -322,20 +333,32 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      */
     get op(): Operation;
     private _op;
+    /**
+     * 像素流送输入控制
+     */
+    private pixelInput;
     private iframeHandler;
     get fullScreen(): FullScreen;
     private _fullScreen;
     get lockPointer(): LockPointer;
     private _lockPointer;
-    private view;
+    private _view;
     /**
      * 视频元素
      */
-    get videoElement(): any;
+    get videoElement(): HTMLVideoElement;
     /**
      * 视频显示组件
      */
     get videoComponent(): any;
+    /**
+     * 视频显示组件的父容器
+     */
+    get containerElement(): any;
+    /**
+     *
+     */
+    get viewportElement(): any;
     get rootElement(): HTMLElement;
     private _rootElement;
     get serverAddress(): string;
@@ -345,6 +368,16 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     private _config;
     private loadingTimeout;
     private sdkAuth;
+    /**
+     * 后台分配的用户id
+     */
+    get uid(): number;
+    private _uid;
+    /**
+     * @returns 是否是 Task的拥有者
+     */
+    isTaskOwner(): boolean;
+    _isTaskOwner: boolean;
     /**
      * LarkSR 客户端。所有操作和事件通过该类传递
      * 注意，如果手动创建该类，要清楚参数的意义，一般只有调试等特殊情况才手动创建该类
@@ -449,4 +482,4 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     private onOperationTimeout;
     private onOperationInput;
 }
-export { LarkSR, ILarkSRConfig, PlayerModeType, UserType, LarkSREvent, LarkEventType, LarkSRClientEvent, AppliParams, AppliParamsUtils, LoadAppliParamsFromUrl, LoadAppliParamsStartAppInfo, EventBase, API, Operation, Capabilities, ScaleMode, KEYMAP, CloudLark, FullScreen, LockPointer, };
+export { LarkSR, ILarkSRConfig, PlayerModeType, UserType, LarkSREvent, LarkEventType, LarkSRClientEvent, AppliParams, AppliParamsUtils, LoadAppliParamsFromUrl, LoadAppliParamsStartAppInfo, EventBase, API, Operation, Capabilities, ScaleMode, VirtualKey, KEYMAP, CloudLark, FullScreen, LockPointer, };

package/dist/types/operation/keymap.d.ts

@@ -8,13 +8,17 @@
  * TODO fix：atl + tab, f5,ctr,bug
  * REMOVE F11
  */
-interface Key {
+export interface IVirtualKey {
     scancode: number;
     vkey: number;
     unicode: number;
 }
-declare type tplotOptions = {
-    [key: string]: Key;
+export declare class VirtualKey implements IVirtualKey {
+    scancode: number;
+    vkey: number;
+    unicode: number;
+}
+export declare type VritualKeyMapOptions = {
+    [key: string]: VirtualKey;
 };
-export declare const KEYMAP: tplotOptions;
-export {};
+export declare const KEYMAP: VritualKeyMapOptions;

package/dist/types/operation/pixel_streaming_input.d.ts

@@ -0,0 +1,82 @@
+import { LarkSR } from '@/larksr';
+import { LocalEvent, EventBase } from '../event/event_base';
+export declare const MessageType: {
+    /**********************************************************************/
+    IFrameRequest: number;
+    RequestQualityControl: number;
+    MaxFpsRequest: number;
+    AverageBitrateRequest: number;
+    StartStreaming: number;
+    StopStreaming: number;
+    LatencyTest: number;
+    RequestInitialSettings: number;
+    /**********************************************************************/
+    UIInteraction: number;
+    Command: number;
+    KeyDown: number;
+    KeyUp: number;
+    KeyPress: number;
+    MouseEnter: number;
+    MouseLeave: number;
+    MouseDown: number;
+    MouseUp: number;
+    MouseMove: number;
+    MouseWheel: number;
+    TouchStart: number;
+    TouchEnd: number;
+    TouchMove: number;
+    GamepadButtonPressed: number;
+    GamepadButtonReleased: number;
+    GamepadAnalog: number;
+};
+export declare const enum PIXEL_STREAMING_EVENT_TYPE {
+    InputBuffer = 0
+}
+export interface PixelStreamingEvent extends LocalEvent<PIXEL_STREAMING_EVENT_TYPE> {
+    intpuBuffer?: ArrayBuffer;
+}
+export declare const ControlSchemeType: {
+    LockedMouse: number;
+    HoveringMouse: number;
+};
+export default class PixelStreamingInput extends EventBase<PIXEL_STREAMING_EVENT_TYPE, PixelStreamingEvent> {
+    private playerElementClientRect;
+    private normalizeAndQuantizeUnsigned;
+    private normalizeAndQuantizeSigned;
+    private unquantizeAndDenormalizeUnsigned;
+    private larksr;
+    private inputOptions;
+    get startListen(): boolean;
+    private _startListen;
+    constructor(larksr: LarkSR);
+    registerInputs(videoElement: HTMLVideoElement): void;
+    setupMouseAndFreezeFrame(playerElement: HTMLElement, videoElement: HTMLVideoElement): void;
+    emitUIInteraction(descriptor: any): ArrayBuffer;
+    emitCommand(descriptor: any): ArrayBuffer;
+    requestInitialSettings(): void;
+    requestQualityControl(): void;
+    emitMouseMove(x: number, y: number, deltaX: number, deltaY: number): void;
+    emitMouseDown(button: number, x: number, y: number): void;
+    emitMouseUp(button: number, x: number, y: number): void;
+    emitMouseWheel(delta: number, x: number, y: number): void;
+    releaseMouseButtons(buttons: number, x: number, y: number): void;
+    pressMouseButtons(buttons: number, x: number, y: number): void;
+    registerMouseEnterAndLeaveEvents(playerElement: HTMLElement): void;
+    registerLockedMouseEvents(playerElement: HTMLElement): void;
+    registerHoveringMouseEvents(playerElement: HTMLVideoElement): void;
+    registerTouchEvents(playerElement: HTMLVideoElement): void;
+    isKeyCodeBrowserKey(keyCode: number): boolean;
+    getKeyCode(e: KeyboardEvent): number;
+    registerKeyboardEvents(): void;
+    setupHtmlEvents(): void;
+    gamepadConnectHandler(e: any): void;
+    gamepadDisconnectHandler(e: any): void;
+    emitControllerAxisMove(controllerIndex: any, axisIndex: number, analogValue: number): void;
+    emitControllerButtonPressed(controllerIndex: any, buttonIndex: number, isRepeat: number): void;
+    emitControllerButtonReleased(controllerIndex: any, buttonIndex: number): void;
+    scanGamepads(): void;
+    updateStatus(): void;
+    setupNormalizeAndQuantize(playerElement: HTMLElement, videoElement: HTMLVideoElement): void;
+    emitDescriptor(messageType: number, descriptor: any): ArrayBuffer;
+    sendInputData(data: ArrayBuffer): void;
+}

package/package.json

@@ -1,8 +1,14 @@
 {
   "name": "larksr_websdk",
-  "version": "3.2.1",
+  "version": "3.2.6",
   "description": "larksr websdk. http://www.pingxingyun.com",
-  "keywords": ["pingxingyun", "larksr", "cloudrendeing", "webrtc", "cloudxr"],
+  "keywords": [
+    "pingxingyun",
+    "larksr",
+    "cloudrendeing",
+    "webrtc",
+    "cloudxr"
+  ],
   "main": "./dist/larksr-web-sdk.min.js",
   "types": "./dist/types/index.d.ts",
   "files": [
@@ -14,7 +20,7 @@
     "build": "webpack --config webpack.config.js",
     "build:typings": "tsc --build tsconfig.type.json",
     "copy-dts": "copyfiles -u 1 \"src/**/*.d.ts\" dist/types/",
-    "dist": "webpack --config webpack.config.js && copyfiles -u 1 \"src/**/*.d.ts\" dist/types/"
+    "dist": "webpack --config webpack.config.js && copyfiles -u 1 \"src/**/*.d.ts\" dist/types/ && copyfiles -u 1 \"doc/*\" dist/doc/"
   },
   "author": "fcx@pingxingyun.com",
   "license": "ISC",
@@ -24,13 +30,14 @@
     "core-js": "^3.18.1",
     "crypto-js": "^4.1.1",
     "protobufjs": "^6.11.2",
-    "webrtc-adapter": "^8.1.0"
+    "webrtc-adapter": "^8.1.0",
+    "weixin-js-sdk": "^1.6.0"
   },
   "devDependencies": {
-    "@types/crypto-js": "^4.0.2",
-    "@types/webrtc": "^0.0.30",
     "@babel/core": "^7.15.5",
     "@tsconfig/svelte": "^2.0.1",
+    "@types/crypto-js": "^4.0.2",
+    "@types/webrtc": "^0.0.30",
     "babel-loader": "^8.2.2",
     "clean-webpack-plugin": "^4.0.0",
     "css-loader": "^6.3.0",