larksr_websdk 3.2.16 → 3.2.33

package/dist/types/api.d.ts

@@ -93,6 +93,7 @@ export default class API {
         };
     }>;
     static GetStartInfo(serverAddress: string, params: {
+        sdkId: string;
         appliId: string;
         playerMode?: number;
         userType?: number;

package/dist/types/appli_params.d.ts

@@ -132,7 +132,7 @@ export interface IAppliParams {
     /**
      * 口令:8位唯一码,写入TaskInfo. 房间code，备用。
      */
-    roomCode: number;
+    roomCode: string;
     /**
      * debug task. 跳过task检测
      */
@@ -231,7 +231,7 @@ export declare class AppliParams implements IAppliParams {
     playerMode: number;
     userType: number;
     nickname: string;
-    roomCode: number;
+    roomCode: string;
     debugTask: boolean;
     debugWebServer: string;
     loadingTimeout: number;

package/dist/types/index.d.ts

@@ -1,10 +1,7 @@
 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";
+import { LarkSR, 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;

package/dist/types/larksr.d.ts

@@ -46,6 +46,14 @@ declare enum UserType {
  * LarkSR 实例会发出的事件
  */
 declare enum LarkSRClientEvent {
+    /**
+     * TASK 创建成功，返回 Task 相关信息
+     */
+    TASK_CREATE_SUCCESS = "taskcreatesuccess",
+    /**
+     * TASK 创建失败
+     */
+    TASK_CREATE_FAILED = "taskcreatefailed",
     /**
      * 连接渲染服务器成功 .
      */
@@ -153,7 +161,19 @@ declare enum LarkSRClientEvent {
     /**
      * 一般信息提示
      */
-    INFO = "info"
+    INFO = "info",
+    /**
+     * 语音对话的状态
+     */
+    AI_VOICE_STATUS = "aivoicestatus",
+    /**
+     * 语音识别转文字的结果
+     */
+    AI_VOICE_ASR_RESULT = "aivoiceasrresult",
+    /**
+     * 对话返回的结果
+     */
+    AI_VOICE_DM_RESULT = "aivoicedmresult"
 }
 /**
  * LarkSR 发出的事件
@@ -192,6 +212,7 @@ interface ILarkSRConfig {
     authCode?: string;
     /**
      * 可选项，授权是否成功
+     * @deprecated 目前不会回调该参数。如果SDK验证失败将在 connect 返回失败
      */
     authCodeCallback?: (isSuccess: boolean, e: any) => void;
     /**
@@ -288,46 +309,6 @@ interface ILarkSRConfig {
      */
     publicPortMapping?: PublicPortMapping;
 }
-/**
- * 通过平行云托管平台创建客户端并启动应用
- * @param config 传入 config @see ILarkSRConfig
- * @param params 进入应用接口参数。appliId 为必填项
- * @returns Promise 创建 larksr client 是否成功
- */
-export declare function CreateLarkSRClientFromePXYHost(config: ILarkSRConfig, params: {
-    appliId: string;
-    playerMode?: number;
-    userType?: number;
-    roomCode?: string;
-    taskId?: string;
-    nickname?: string;
-}): Promise<LarkSR>;
-/**
- * 通过调用后台接口获取云端应用参数
- * @param config 传入 config @see ILarkSRConfig
- * @param params 进入应用接口参数。appliId 为必填项
- * @returns Promise 创建 larksr client 是否成功
- */
-export declare function CreateLarkSRClientFromeAPI(config: ILarkSRConfig, params: {
-    appliId: string;
-    playerMode?: number;
-    userType?: number;
-    roomCode?: string;
-    taskId?: string;
-    clientMac?: string;
-    groupId?: string;
-    regionId?: string;
-    targetServerIp?: string;
-    appKey?: string;
-    timestamp?: string;
-    signature?: string;
-}): Promise<LarkSR>;
-/**
- * 通过从url参数中获取云端应用相关参数
- * @param config 传入 config @see ILarkSRConfig
- * @returns Promise 创建 larksr client 是否成功
- */
-export declare function CreateLarkSRClientFromeUrl(config: ILarkSRConfig): Promise<LarkSR>;
 declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**
      * 应用参数，构建时传入
@@ -434,7 +415,6 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     get config(): ILarkSRConfig;
     private _config;
     private loadingTimeout;
-    private sdkAuth;
     /**
      * 后台分配的用户id
      */
@@ -452,13 +432,11 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     get initCursorMode(): boolean;
     /**
      * LarkSR 客户端。所有操作和事件通过该类传递
-     * @see CreateLarkSRClientFromeAPI, @see CreateLarkSRClientFromeUrl @see CreateLarkSRClientFromePXYHost
-     * @param config 本地配置，如果有 IAppliParams 相同的配置项，优先级最高
-     * @param params [可选参数] 云端应用参数等，通过后台接口或者url参数获取。
+     * @param config 本地配置，优先级最高
      */
-    constructor(config: ILarkSRConfig, params?: IAppliParams);
+    constructor(config: ILarkSRConfig);
     /**
-     *
+     * 单独设置sdk授权码，目前总会返回成功 promise，具体验证失败将在 connectWithPxyHost 或 connect 返回
      * @param id sdk id 初始化sdkid
      * @returns
      */
@@ -503,7 +481,7 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 启动时应用参数不能为空，包括 taskID，appServer，appPort
      * @returns 是否成功。主要校验授权码是否成功
      */
-    start(): Promise<void>;
+    private start;
     /**
      * 重新开始云渲染流程
      */
@@ -526,6 +504,24 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * @param text 文字
      */
     inputText(text: string): void;
+    /**
+     * 开始智能语音对话文本输入
+     * 应在只能语音为开始状态下开始输入
+     * @param text 输入的文本
+     * @returns 返回对话 ID
+     */
+    aiDmTextInput(text: string): number;
+    /**
+     * 开始智能语音对话语音输入，自动请求录音权限
+     * 应在只能语音为开始状态下开始输入
+     * @returns 成功返回对话id，失败返回异常
+     */
+    startAiDmVoiceInput(): Promise<number>;
+    /**
+     * 停止智能语音输入，通知语音引擎当前用户输入对话结束
+     * @returns 返回当前对话的id
+     */
+    stopAiDmVoiceInput(): number;
     /**
      * 发送文字消息给数据通道
      * 注意 云端应用要继承数据通道功能

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "larksr_websdk",
-  "version": "3.2.16",
+  "version": "3.2.33",
   "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/api.d.ts

@@ -93,6 +93,7 @@ export default class API {
         };
     }>;
     static GetStartInfo(serverAddress: string, params: {
+        sdkId: string;
         appliId: string;
         playerMode?: number;
         userType?: number;

package/types/appli_params.d.ts

@@ -132,7 +132,7 @@ export interface IAppliParams {
     /**
      * 口令:8位唯一码,写入TaskInfo. 房间code，备用。
      */
-    roomCode: number;
+    roomCode: string;
     /**
      * debug task. 跳过task检测
      */
@@ -231,7 +231,7 @@ export declare class AppliParams implements IAppliParams {
     playerMode: number;
     userType: number;
     nickname: string;
-    roomCode: number;
+    roomCode: string;
     debugTask: boolean;
     debugWebServer: string;
     loadingTimeout: number;

package/types/index.d.ts

@@ -1,10 +1,7 @@
 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";
+import { LarkSR, 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;

package/types/lark/application.d.ts

@@ -4,6 +4,7 @@ import WebSocektChannel from './websocket_channel';
 import WebsocketProxy from './websocket_proxy';
 import { LarkSR } from '../larksr';
 import PixelStreamingWebsocketChannel from './test_pixel_streaming';
+import { RECORDER_STATE } from './recoder';
 export declare enum APP_STATE {
     BEFORE_CREATE = 0,
     INITED = 1,
@@ -37,7 +38,10 @@ export declare enum APP_EVENT_TYPE {
     LK_DATA_CHANNEL_RENDERSERVER_TEXT_MESSAGE = 14,
     LK_DATA_CHANNEL_RENDERSERVER_BINARY_MESSAGE = 15,
     LK_DATA_CHANNEL_RENDERSERVER_OPEN = 16,
-    LK_DATA_CHANNEL_RENDERSERVER_CLOSE = 17
+    LK_DATA_CHANNEL_RENDERSERVER_CLOSE = 17,
+    AI_VOICE_STATUS = 18,
+    AI_VOICE_ASR_RESULT = 19,
+    AI_VOICE_DM_RESULT = 20
 }
 export interface AppEvent extends LocalEvent<APP_EVENT_TYPE> {
     data?: any;
@@ -53,6 +57,9 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     private _state;
     private retryTime;
     private larksr;
+    get voiceId(): number;
+    get recodeState(): RECORDER_STATE;
+    private recoder;
     constructor(larksr: LarkSR);
     init(): void;
     initPc(): void;
@@ -62,6 +69,10 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     inputText(text: string): void;
     sendTextToDataChannel(text: string): void;
     sendBinaryToDataChannel(binary: Uint8Array): void;
+    aiDmTextInput(text: string): number;
+    startAiDmVoiceInput(): Promise<number>;
+    stopAiDmVoiceInput(): number;
+    private onRecoderData;
     start(): Promise<void>;
     connect(): Promise<PixelStreamingWebsocketChannel> | Promise<WebsocketProxy> | Promise<WebSocektChannel> | undefined;
     disConnect(): void;
@@ -113,6 +124,9 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     private onDataChannelOpen;
     private onDataChannelClose;
     private onPeerConnectionState;
+    private onAiVoiceStatus;
+    private onAiVoiceAsrResult;
+    private onAiVoiceDMResult;
     appStateChange(state: APP_STATE): void;
     private infoMsg;
     private errorMsg;

package/types/lark/lark_event_type.d.ts

@@ -1,7 +1,7 @@
 export declare enum LarkEventType {
     LK_WEB_CLIENT_LOAD_SUCCESS = 1,
-    LK_API_ENTERAPPLI_SUCCESS = 10,
-    LK_API_ENTERAPPLI_FAILED = 11,
+    LK_TASK_CREATE_SUCCESS = 10,
+    LK_TASK_CREATE_FAILED = 11,
     LK_TASK_SYNC_APP = 20,
     LK_TASK_SYNC_APP_FAILED = 21,
     LK_RENDER_SERVER_CONNECTED = 100,
@@ -33,6 +33,7 @@ export declare enum LarkEventType {
     LK_VIDEO_LOADED = 700,
     LK_VIDEO_PLAY_FAILED = 701,
     LK_GOT_REMOTE_STREAM = 710,
+    LK_VIDEO_PLAY_SUCCSS = 711,
     LK_NOTIFY_CLIENT_LOGOUT_PLAYER_LOGOUT = 800,
     LK_NOTIFY_CLIENT_LOGOUT_TASKOWNER_LOGOUT = 801,
     LK_APP_PROCESS_NOTIFI_APP_QUIT = 900,

package/types/lark/peer_connection.d.ts

@@ -25,7 +25,10 @@ export declare enum WEBRTC_EVENT_TYPE {
     BAD_NETWORK = 14,
     ERROR = 15,
     RTC_SDP = 16,
-    RTC_ICECANDIDATE = 17
+    RTC_ICECANDIDATE = 17,
+    AI_VOICE_STATUS = 18,
+    AI_VOICE_ASR_RESULT = 19,
+    AI_VOICE_DM_RESULT = 20
 }
 export interface GoogleBitRate {
     start: number;

package/types/lark/recoder.d.ts

@@ -0,0 +1,55 @@
+import { EventBase, LocalEvent } from '../event/event_base';
+export declare enum RECORDER_STATE {
+    READY = 0,
+    RECORDING = 1
+}
+export declare const RECODER_DEFAULT_CONFIG: {
+    sampleRate: number;
+    sampleBits: number;
+    bufferSize: number;
+};
+/**
+ * LarkSR 实例会发出的事件
+ */
+export declare enum RecodeEventType {
+    DATA = 0
+}
+/**
+ * LarkSR 发出的事件
+ */
+export interface RecodeEvent extends LocalEvent<RecodeEventType> {
+    voiceId: number;
+    sliceId: number;
+    data: Uint8Array;
+}
+export default class Recorder extends EventBase<RecodeEventType, RecodeEvent> {
+    get state(): RECORDER_STATE;
+    private _state;
+    private ctx;
+    private sampleRate;
+    private sampleBits;
+    private recorder;
+    private source;
+    private stream;
+    private buffer;
+    private bufferSize;
+    get voiceId(): number;
+    updateVoiceId(): number;
+    private _voiceId;
+    constructor({ bufferSize, sampleRate, sampleBits, }?: {
+        sampleRate: number;
+        sampleBits: number;
+        bufferSize: number;
+    });
+    start(): Promise<number>;
+    pause(): void;
+    clear(): void;
+    /**
+     * @deprecated
+     * @returns
+     */
+    private getRecord;
+    private merge;
+    private compress;
+    private encodeToPCM;
+}

package/types/larksr.d.ts

@@ -46,6 +46,14 @@ declare enum UserType {
  * LarkSR 实例会发出的事件
  */
 declare enum LarkSRClientEvent {
+    /**
+     * TASK 创建成功，返回 Task 相关信息
+     */
+    TASK_CREATE_SUCCESS = "taskcreatesuccess",
+    /**
+     * TASK 创建失败
+     */
+    TASK_CREATE_FAILED = "taskcreatefailed",
     /**
      * 连接渲染服务器成功 .
      */
@@ -153,7 +161,19 @@ declare enum LarkSRClientEvent {
     /**
      * 一般信息提示
      */
-    INFO = "info"
+    INFO = "info",
+    /**
+     * 语音对话的状态
+     */
+    AI_VOICE_STATUS = "aivoicestatus",
+    /**
+     * 语音识别转文字的结果
+     */
+    AI_VOICE_ASR_RESULT = "aivoiceasrresult",
+    /**
+     * 对话返回的结果
+     */
+    AI_VOICE_DM_RESULT = "aivoicedmresult"
 }
 /**
  * LarkSR 发出的事件
@@ -192,6 +212,7 @@ interface ILarkSRConfig {
     authCode?: string;
     /**
      * 可选项，授权是否成功
+     * @deprecated 目前不会回调该参数。如果SDK验证失败将在 connect 返回失败
      */
     authCodeCallback?: (isSuccess: boolean, e: any) => void;
     /**
@@ -288,46 +309,6 @@ interface ILarkSRConfig {
      */
     publicPortMapping?: PublicPortMapping;
 }
-/**
- * 通过平行云托管平台创建客户端并启动应用
- * @param config 传入 config @see ILarkSRConfig
- * @param params 进入应用接口参数。appliId 为必填项
- * @returns Promise 创建 larksr client 是否成功
- */
-export declare function CreateLarkSRClientFromePXYHost(config: ILarkSRConfig, params: {
-    appliId: string;
-    playerMode?: number;
-    userType?: number;
-    roomCode?: string;
-    taskId?: string;
-    nickname?: string;
-}): Promise<LarkSR>;
-/**
- * 通过调用后台接口获取云端应用参数
- * @param config 传入 config @see ILarkSRConfig
- * @param params 进入应用接口参数。appliId 为必填项
- * @returns Promise 创建 larksr client 是否成功
- */
-export declare function CreateLarkSRClientFromeAPI(config: ILarkSRConfig, params: {
-    appliId: string;
-    playerMode?: number;
-    userType?: number;
-    roomCode?: string;
-    taskId?: string;
-    clientMac?: string;
-    groupId?: string;
-    regionId?: string;
-    targetServerIp?: string;
-    appKey?: string;
-    timestamp?: string;
-    signature?: string;
-}): Promise<LarkSR>;
-/**
- * 通过从url参数中获取云端应用相关参数
- * @param config 传入 config @see ILarkSRConfig
- * @returns Promise 创建 larksr client 是否成功
- */
-export declare function CreateLarkSRClientFromeUrl(config: ILarkSRConfig): Promise<LarkSR>;
 declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**
      * 应用参数，构建时传入
@@ -434,7 +415,6 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     get config(): ILarkSRConfig;
     private _config;
     private loadingTimeout;
-    private sdkAuth;
     /**
      * 后台分配的用户id
      */
@@ -452,13 +432,11 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     get initCursorMode(): boolean;
     /**
      * LarkSR 客户端。所有操作和事件通过该类传递
-     * @see CreateLarkSRClientFromeAPI, @see CreateLarkSRClientFromeUrl @see CreateLarkSRClientFromePXYHost
-     * @param config 本地配置，如果有 IAppliParams 相同的配置项，优先级最高
-     * @param params [可选参数] 云端应用参数等，通过后台接口或者url参数获取。
+     * @param config 本地配置，优先级最高
      */
-    constructor(config: ILarkSRConfig, params?: IAppliParams);
+    constructor(config: ILarkSRConfig);
     /**
-     *
+     * 单独设置sdk授权码，目前总会返回成功 promise，具体验证失败将在 connectWithPxyHost 或 connect 返回
      * @param id sdk id 初始化sdkid
      * @returns
      */
@@ -503,7 +481,7 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 启动时应用参数不能为空，包括 taskID，appServer，appPort
      * @returns 是否成功。主要校验授权码是否成功
      */
-    start(): Promise<void>;
+    private start;
     /**
      * 重新开始云渲染流程
      */
@@ -526,6 +504,24 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * @param text 文字
      */
     inputText(text: string): void;
+    /**
+     * 开始智能语音对话文本输入
+     * 应在只能语音为开始状态下开始输入
+     * @param text 输入的文本
+     * @returns 返回对话 ID
+     */
+    aiDmTextInput(text: string): number;
+    /**
+     * 开始智能语音对话语音输入，自动请求录音权限
+     * 应在只能语音为开始状态下开始输入
+     * @returns 成功返回对话id，失败返回异常
+     */
+    startAiDmVoiceInput(): Promise<number>;
+    /**
+     * 停止智能语音输入，通知语音引擎当前用户输入对话结束
+     * @returns 返回当前对话的id
+     */
+    stopAiDmVoiceInput(): number;
     /**
      * 发送文字消息给数据通道
      * 注意 云端应用要继承数据通道功能

package/types/operation/keyboard_handler.d.ts

@@ -3,13 +3,16 @@ import HandlerBase from './handler_base';
 export default class KeyboardHandler extends HandlerBase {
     private needSyncKeyState;
     private fistSyncKeyState;
+    private pressedKeys;
     constructor(op: Operation);
     startListening(): void;
     stopListening(): void;
+    private onLockPointChange;
     private keyboardListenerSetup;
     private onKeyDown;
     private onKeyUp;
     private onWindowBlur;
     private onWindowFocus;
     private onWindowVisibilityChange;
+    private releaseKeys;
 }

package/types/operation/mouse_handler.d.ts

@@ -8,6 +8,7 @@ export default class MouseHandler extends HandlerBase {
     private isFocus;
     private rootElement;
     private subscribeUpdatePlayerListFromProtoAction;
+    private pressedMouseButtons;
     constructor(rootElement: HTMLElement, op: Operation);
     resetLocalRendreMousePosition(p: Point): void;
     setRootElement(rootElement: HTMLElement): void;
@@ -36,5 +37,6 @@ export default class MouseHandler extends HandlerBase {
     private onWindowBlur;
     private onWindowFocus;
     private onWindowVisibilityChange;
+    private releaseMouseButtons;
     private toastMsg;
 }

package/types/operation/operation.d.ts

@@ -18,7 +18,6 @@ export default class Operation extends EventBase<OPREATION_EVENT_TYPE, Operation
     private keyboardHandler;
     private mouseHandler;
     private gamepadHandler;
-    private useTouch;
     private touchHandler;
     private _startListen;
     set enableParse(enable: boolean);