larksr_websdk 3.2.4 → 3.2.8

package/types/appli_params.d.ts

@@ -0,0 +1,263 @@
+import ScaleMode from './utils/scale_mode';
+import { StartAppInfo } from './api';
+import { ILarkSRConfig } from './larksr';
+export interface IAppliParams {
+    /**
+     * appserver 的ip地址
+     */
+    appServer: string;
+    /**
+     * appserver 的端口号
+     */
+    appPort: string;
+    /**
+     * appli type
+     */
+    appliType: number;
+    /**
+     * 是否使用 websocket 代理
+     */
+    wsProxy: boolean;
+    /**
+     * 优先使用的外网ip. 用在webrtc ice处替换为高优先级的ip
+     */
+    preferPubOutIp: string;
+    /**
+     * taskid
+     */
+    taskid: string;
+    /**
+     * 当前应用名称
+     */
+    appliName: string;
+    /**
+     * @deprecated
+     * 应用的宽高。现在云端自动获取宽高
+     */
+    width: number;
+    /**
+     * @deprecated
+     * 应用的宽高。现在云端自动获取宽高
+     */
+    height: number;
+    /**
+     * 缩放模式
+     */
+    scaleMode: ScaleMode;
+    /**
+     * 日志级别
+     * @default 'warn'
+     */
+    logLevel: 'info' | 'warn' | 'error';
+    /**
+     * 无操作时间。超时断开连接.
+     */
+    noOperationTimeout: number;
+    /**
+     * 是否显示右下角的水印。
+     */
+    waterMark: boolean;
+    /**
+     * 检测的rtt值，rtt超过该值将提示用户网络环境差
+     */
+    rttLimit: number;
+    /**
+     * 检测的丢包率。丢包率超过该值提示用户网络环境差
+     */
+    packetLostLimit: number;
+    /**
+     * 丢包率和rtt提示的时间间隔。
+     */
+    rttLimitInterval: number;
+    /**
+     * 码率. 用在在创建 webrtc sdp时替换为此码率。
+     */
+    codeRate: number;
+    /**
+     * audio code rate
+     * https://stackoverflow.com/questions/33649283/how-to-set-up-sdp-for-high-quality-opus-audio
+     * a=fmtp:111 minptime=10;useinbandfec=1; stereo=1; maxaveragebitrate=510000
+     */
+    audioCodeRate: number;
+    /**
+     * 帧率，在登录task时传给后端。
+     */
+    frameRate: number;
+    /**
+     * 网络状态，影响 webrtc offer 创建时最低码率。
+     */
+    network: 'local' | 'public';
+    /**
+     * 使用的语言，目前只支持英语和中文。
+     */
+    language: string;
+    /**
+     * 初始的鼠标锁定模式
+     * false：非锁定模式
+     * true：锁定模式
+     */
+    initCursorMode: boolean;
+    /**
+     * 背景颜色
+     */
+    bgColor: string;
+    /**
+     * 全屏模式
+     *  0 -》 用户手动触发
+     *  1 -》 首次点击进入触发
+     *  2 -》 每次点击触发
+     */
+    fullScreenMode: number;
+    /**
+     * 手机端全屏模式
+     *  0 -》 用户手动触发
+     *  1 -》 首次点击进入触发
+     *  2 -》 每次点击触发
+     */
+    mobileFullScreenMode: number;
+    /**
+     * 一人操作多人看 0 普通模式 1 交互模式（可以一人操作多人看）
+     * 2 多人互动模式，鼠标键盘都放开
+     */
+    playerMode: number;
+    /**
+     * 用户类型 number
+     * 所有者:1  观察者:0;
+     */
+    userType: number;
+    /**
+     * 用户昵称
+     */
+    nickname: string;
+    /**
+     * 口令:8位唯一码,写入TaskInfo. 房间code，备用。
+     */
+    roomCode: number;
+    /**
+     * debug task. 跳过task检测
+     */
+    debugTask: boolean;
+    /**
+     * debug webserver
+     */
+    debugWebServer: string;
+    /**
+     * laoding timeout
+     * 5 * 60
+     */
+    loadingTimeout: number;
+    /**
+     * share url
+     */
+    shareUrl: boolean;
+    /**
+     * 是否强制横屏
+     */
+    mobileForceLandscape: boolean;
+    /**
+     * 移动端初始化初始化是否显示手柄
+     */
+    mobileVirtualJoystick: boolean;
+    /**
+     * mouseZoomDirection
+     * 用于移动端捏合缩放操作与应用鼠标缩放的对应关系
+     * 1:鼠标滚轮向上为放大，
+     * 0:鼠标滚轮向下为放大(default)
+     */
+    mouseZoomDirection: number;
+    /**
+     * 初始是否显示玩家列表
+     */
+    showPlayerList: boolean;
+    /**
+     * 优先使用的解码器
+     */
+    perferDecoder: 'auto' | 'vp8' | 'vp9' | 'h264' | 'av1x';
+    /**
+     * 触摸操作对应的操作方式，触摸屏还是鼠标
+     */
+    touchOperateMode: 'touchScreen' | 'mouse';
+    /**
+     * appid
+     */
+    appliId: string;
+    /**
+     *
+     */
+    syncLocalToCloudClipboard: boolean;
+    enableRttIcon: boolean;
+    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;
+    appliName: string;
+    width: number;
+    height: number;
+    scaleMode: ScaleMode;
+    logLevel: 'info' | 'warn' | 'error';
+    noOperationTimeout: number;
+    waterMark: boolean;
+    rttLimit: number;
+    packetLostLimit: number;
+    rttLimitInterval: number;
+    codeRate: number;
+    audioCodeRate: number;
+    frameRate: number;
+    network: 'local' | 'public';
+    language: string;
+    initCursorMode: boolean;
+    bgColor: string;
+    fullScreenMode: number;
+    mobileFullScreenMode: number;
+    playerMode: number;
+    userType: number;
+    nickname: string;
+    roomCode: number;
+    debugTask: boolean;
+    debugWebServer: string;
+    loadingTimeout: number;
+    shareUrl: boolean;
+    mobileForceLandscape: boolean;
+    mobileVirtualJoystick: boolean;
+    mouseZoomDirection: number;
+    showPlayerList: boolean;
+    perferDecoder: 'auto' | 'vp8' | 'vp9' | 'h264' | 'av1x';
+    touchOperateMode: 'touchScreen' | 'mouse';
+    appliId: string;
+    syncLocalToCloudClipboard: boolean;
+    enableRttIcon: boolean;
+    enableSoundRequire: boolean;
+    toastLevel: number;
+    static copyAndCreate(params?: IAppliParams): AppliParams;
+    static setUpWithSDKConfig(params: IAppliParams, config: ILarkSRConfig): AppliParams;
+}
+export declare function CreateAppliParams(): IAppliParams;
+export declare class AppliParamsUtils {
+    static getScaleMode(init: number | null | undefined): string;
+    static getNetwork(init: number | null | undefined): 'local' | 'public';
+    static getLogLevel(level: string | null | undefined): 'info' | 'warn';
+    static getBoolOption(option: string | null | undefined | boolean, emptyValue?: boolean): boolean;
+    static getNumberBoolOption(option: string | null | undefined | number, emptyValue?: boolean): boolean;
+    static getStringOption(option: string | null | undefined, emptyValue?: string): string;
+    static getIntOption(option: string | null | undefined, emptyValue?: number): number;
+    static getBgColor(option: string | null | undefined): string;
+}
+export declare function LoadAppliParamsFromUrl(): IAppliParams;
+export declare function LoadAppliParamsStartAppInfo(startAppInfo: StartAppInfo): IAppliParams;

package/types/config.d.ts

@@ -0,0 +1,59 @@
+import ScaleModel from './utils/scale_mode';
+export default class Config {
+    static BuildType: 'local' | 'public';
+    static LocalHomepagePath: string;
+    /**
+     */
+    static VersionMarjor: number;
+    static VersionMinorr: number;
+    static VersionRevise: number;
+    static VersionBuild: number;
+    /**
+     * webrtc 断开连接重试次数
+     */
+    static RetryTime: number;
+    /**
+     * design width/height
+     * TODO reset with 0. check with render server.
+     */
+    static OriginW: number;
+    static OriginH: number;
+    /**
+     * 默认码率从应用服务器接收码率
+     */
+    static CodeRate: number;
+    static AudioCodeRate: number;
+    static FrameRate: number;
+    /**
+     * default scale mode. 以应用原始尺寸的缩放
+     */
+    static ScaleMode: ScaleModel;
+    /**
+     * default net work.
+     */
+    static Network: 'local' | 'public';
+    /**
+     * 鼠标模式
+     * 0 == 相对
+     * 1 == 绝对
+     */
+    static MouseMode: number;
+    /**
+     * replace server ip for aws
+     */
+    static ForceIceAddr: boolean;
+    /**
+     * 禁用 VPX
+     */
+    static DisableVPX: boolean;
+    /**
+     * 是否启用相对鼠标移动虚拟摇杆
+     */
+    static RelativeMouseMove: boolean;
+    /**
+     * 虚拟摇杆精度
+     */
+    static VirtualRackerScale: number;
+    static ErrChromeAndroidVersion: string[];
+    static DownloadChromium: string;
+}

package/types/index.d.ts

@@ -0,0 +1,25 @@
+import 'core-js/stable/symbol';
+import { LarkSR, CreateLarkSRClientFromePXYHost, 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;
+    CreateLarkSRClientFromePXYHost: typeof CreateLarkSRClientFromePXYHost;
+    CreateLarkSRClientFromeAPI: typeof CreateLarkSRClientFromeAPI;
+    CreateLarkSRClientFromeUrl: typeof CreateLarkSRClientFromeUrl;
+    API: typeof API;
+    AppliParams: typeof AppliParams;
+    LoadAppliParamsFromUrl: typeof LoadAppliParamsFromUrl;
+    AppliParamsUtils: typeof AppliParamsUtils;
+    LoadAppliParamsStartAppInfo: typeof LoadAppliParamsStartAppInfo;
+    EventBase: typeof EventBase;
+    ScaleMode: typeof ScaleMode;
+    Capabilities: typeof Capabilities;
+    CloudLark: typeof CloudLark;
+    FullScreen: typeof FullScreen;
+    LockPointer: typeof LockPointer;
+    Operation: typeof Operation;
+    LarkSRClientEvent: typeof LarkSRClientEvent;
+    LarkEventType: typeof LarkEventType;
+    KEYMAP: import("./operation/keymap").VritualKeyMapOptions;
+};
+export default _default;
+export { ILarkSRConfig, PlayerModeType, UserType, LarkSREvent, };

package/{dist/types → 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,11 @@ 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 sendToWebsocektChannelBuffer;
+    private sendToWebsocektChannelMsg;
     private onChannelOpen;
     private onClose;
     private onChannelMsg;
@@ -93,6 +98,9 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     retryPeerconnection(): void;
     private onPeerConnectionDisconnect;
     private onBadNetwork;
+    private onPixelStreamingPlayerList;
+    private onPixelStreamingDataChannelState;
+    private onPixelStreamingDataChannelData;
     private onCursorStyle;
     private onAppResize;
     private onAppMouseMode;

package/{dist/types → 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/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;
+}