larksr_websdk 3.2.320 → 3.2.323

package/dist/doc/update.md

@@ -1,162 +0,0 @@
-# 更新
-
-## V3.2.30
-
-> V3.2.30 仅支持服务端 [V3.2.3.1](https://www.pingxingyun.com/devCenter.html) 以上版本。
-> [老版本 SDK Demo 下载](https://github.com/pingxingyun/lark_sr_websdk_demos/releases/tag/V3.2.10)
-
-1. [添加像素流送支持](https://docs.unrealengine.com/4.27/zh-CN/SharingAndReleasing/PixelStreaming/PixelStreamingIntro/)。
-2. 完善安全性, 添加 SDK ID 加密配置。
-3. 移除 CreateLarkSRClientFromePXYHost，CreateLarkSRClientFromeAPI, CreateLarkSRClientFromeUrl 函数。直接使用 `new LarkSR(config: ILarkSRConfig)` 方式创建对象。
-
-## V3.2.33
-
-1. 添加智能语音相关接口支持
-
-LarkSR 对象添加:
-
-```typescript
-/**
- * 开始智能语音对话文本输入
- * 应在只能语音为开始状态下开始输入
- * @param text 输入的文本
- * @returns 返回对话 ID
- */
-public aiDmTextInput(text: string) {
-/**
- * 开始智能语音对话语音输入，自动请求录音权限
- * 应在只能语音为开始状态下开始输入
- * @returns 成功返回对话id，失败返回异常
- */
-public startAiDmVoiceInput() {
-
-/**
- * 停止智能语音输入，通知语音引擎当前用户输入对话结束
- * @returns 返回当前对话的id
- */
-public stopAiDmVoiceInput() {
-```
-
-LarkSR 添加如下事件:
-
-```typescript
-larksr.on('aivoicestatus', (e) => {
-    // 智能语音服务状态
-});
-
-larksr.on('aivoiceasrresult', (e) => {
-    // 智能语音转文字识别结果
-});
-
-larksr.on('aivoicedmresult', (e) => {
-    // 智能语音对话结果
-});
-```
-
-## V3.2.37
-
-```typescript
-/**
- * 设置是否强制横屏显示内容.
- * handelRootElementSize 必须设置为 true 才有作用。
- * 要注意强制横屏模式下网页的坐标系xy和视觉上相反，如果通过外部输入 input 事件。要注意调整
- * @param force 是否强制横屏
- */
-setMobileForceLandScape(force: boolean): void;
-```
-
-## V3.2.311
-
-新增麦克风输入接口。客户端打开后云端应用可直接通过读取声卡上的麦克风接收到音频。
-
-> 该功能匹配的服务端版本最低为 V3.2.51
-> 使用该功能要注意在后台应用管理中开启音频输入功能
-> 注意要在连接成功之后打开媒体设备。即 `mediaPlayed` 之后调用才有效
-
-```typescript
-/**
- * 打开一个音频设备，要注意浏览器限制在 https 或者 localhost 下才能打开音频
- * @param deviceId 音频设备id，如果不传将打开默认设备。@see getConnectedAudioinputDevices
- * @returns
- */
-openAudio(deviceId?: string);
-/**
- * 关闭当前的音频设备
- * @returns
- */
-closeAudio(): boolean | undefined;
-/**
- * 返回已连接的音频设备列表，设备列表中的设备的 deviceId 可用来打开某个音频设备
- * @returns
- */
-getConnectedAudioinputDevices(): Promise<MediaDeviceInfo[] | undefined>;
-/**
- * 设置当前已开启的音频track是否启用状态
- * @param enable 是否启用
- * @returns
- */
-setAudioEnable(enable: boolean): void | undefined;
-```
-
-larksr 配置项新增自动打开麦克风配置,在`new LarkSR({ ... 此处省略其他配置 ... audioInputAutoStart: true})` 时传入，
-
-> 手动传入的 `audioInputAutoStart` 优先级高于后台配置
-
-```javascript
-/**
-* 当启用音频输入功能，是否自动连入音频设备。
-* 默认关闭。
-* 需要注意默认打开的是系统中默认的音频设备。
-*/
-audioInputAutoStart?: boolean;
-```
-
-## V3.2.319
-
-新增视频输入接口。客户端打开后云端应用可直接通过读取服务端的摄像头读取视频数据。
-
-> 该功能匹配的服务端版本最低为 V3.2.61
-> 使用该功能要注意在后台应用管理中开启视频输入功能
-> 注意要在连接成功之后打开媒体设备。即 `mediaPlayed` 之后调用才有效
-
-```typescript
-/**
- * 打开一个视频设备，要注意浏览器限制在 https 或者 localhost 下才能打开视频
- * @param audio boolean 是否同时开启音频
- * @param cameraId 视频设备id，如果不传将打开默认设备。@see getConnectedVideoinputDevices
- * @returns Promise
- */
-openVideo(audio?: boolean, cameraId?: string);
-/**
- * 打开默认媒体设备，要注意浏览器限制在 https 或者 localhost 下
- * 如果需要指定特殊的媒体设备请单独使用 @see openAudio @see openVideo
- * @param video 是否包含视频
- * @param audio 是否包含音频
- * @returns Promise
- */
-openDefaultMedia(video?: boolean, audio?: boolean)>;
-/**
- * 返回已连接的视频设备
- * @returns Promise<MediaDeviceInfo[]>
- */
-getConnectedVideoinputDevices();
-/**
- * 设置当前已开启的视频track是否启用状态
- * @param enable 是否启用
- * @returns void
- */
-setVideoEnable(enable: boolean);
-```
-
-larksr 配置项新增自动打开视频输入配置,在`new LarkSR({ ... 此处省略其他配置 ... videoInputAutoStart: true})` 时传入
-
-> 手动传入的 `videoInputAutoStart` 优先级高于后台配置
-
-```javascript
-/**
- * 当启用视频输入功能，是否自动连入视频设备。
- * 默认关闭。
- * 需要注意默认打开的是系统中默认的视频设备。
- */
-videoInputAutoStart?: boolean;
-```

package/dist/types/api.d.ts

@@ -1,124 +0,0 @@
-import { ILarkSRConfig } from './larksr';
-import { AppliParams } from './appli_params';
-export interface UTLockInfo {
-    checkUtLockMessage: string;
-    checkUtLockResult: boolean;
-    remainMinutes: number;
-}
-export interface GetTaskResult {
-    adminViewer: number;
-    appKey: string;
-    appliId: string;
-    appliType: number;
-    city: string;
-    clientIp: string;
-    country: string;
-    createDate: string;
-    dcs: number;
-    limitMaxFps: number;
-    offScreen: number;
-    playerListToggle: number;
-    playerMode: number;
-    province: string;
-    publicIp: string;
-    reserveFlag: number;
-    serverId: string;
-    serverIp: string;
-    shareUrl: string;
-    startAt: string;
-    startParam: string;
-    startProcType: number;
-    status: number;
-    taskId: string;
-    updateDate: string;
-    useGamepad: number;
-    wm: number;
-    textInputEventPrompt: number;
-    audioInput: number;
-    audioInputAutoStart: number;
-    videoInput: number;
-    videoInputAutoStart: number;
-}
-export interface StartAppInfo {
-    appliId: string;
-    appliType: number;
-    appliName: string;
-    taskId: string;
-    renderServerIp: string;
-    wsProxy: string;
-    preferPublicIp: string;
-    renderServerPort: number;
-    initCursorMode: number;
-    rttLimit: string;
-    touchOperateMode: string;
-    fullScreenMode: number;
-    mobileForceLandscape: number;
-    mobileFullScreenMode: number;
-    language: string;
-    noOperationTimeout: string;
-    serverId: string;
-    network: string;
-    playerListToggle: number;
-    bgColor: string;
-    logLevel: string;
-    mobileVirtualJoystick: number;
-    initWinSize: number;
-    taskStatus: number;
-    mouseZoomDirection: number;
-    useGamepad: number;
-    rttLimitInterval: string;
-    playerMode?: number;
-    userType?: number;
-    roomCode?: string;
-    nickName?: string;
-    nickname?: string;
-    appKey?: string;
-    groupId?: string;
-}
-export default class API {
-    static CheckUTLockInfoPath: string;
-    static GetTaskPATH: string;
-    static ClientLogErrorPath: string;
-    static GetStartInfoPath: string;
-    private static PocHostApplGetUrl;
-    private static TaskInfoClientStartedPath;
-    private static PortMappingListPath;
-    static HostAppliGetUrl(params: {
-        appliId: string;
-        playerMode?: number;
-        userType?: number;
-        roomCode?: string;
-        taskId?: string;
-    }): Promise<{
-        host: string;
-        origin: string;
-        params: {
-            appliId: string;
-            appKey: string;
-            timestamp: string;
-            signature: string;
-        };
-    }>;
-    static GetStartInfo(serverAddress: string, params: {
-        sdkId: string;
-        appliId: string;
-        playerMode?: number;
-        userType?: number;
-        roomCode?: string;
-        taskId?: string;
-        clientMac?: string;
-        groupId?: string;
-        regionId?: string;
-        targetServerIp?: string;
-        appKey?: string;
-        timestamp?: string;
-        signature?: string;
-    } | any): Promise<StartAppInfo>;
-    static CheckUTLockInfo(config: ILarkSRConfig): Promise<UTLockInfo>;
-    static GetTask(config: ILarkSRConfig, taskid: string): Promise<GetTaskResult>;
-    static LogError(errorCode: number, errorMsg: string, params: string, config: ILarkSRConfig): void;
-    static ClientInfo(config: ILarkSRConfig, params: AppliParams): void;
-    static TaskInfoClientStarted(config: ILarkSRConfig, params: AppliParams): void;
-    static PortMappingList(config: ILarkSRConfig): Promise<unknown>;
-    static joinParam(params: any): string;
-}

package/dist/types/appli_params.d.ts

@@ -1,289 +0,0 @@
-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: string;
-    /**
-     * 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;
-    /**
-     * 优先使用的解码器
-     */
-    preferDecoder: 'auto' | 'vp8' | 'vp9' | 'h264' | 'h265' | 'hevc' | 'av1x';
-    /**
-     * 触摸操作对应的操作方式，触摸屏还是鼠标
-     */
-    touchOperateMode: 'touchScreen' | 'mouse';
-    /**
-     * appid
-     */
-    appliId: string;
-    /**
-     *
-     */
-    syncLocalToCloudClipboard: boolean;
-    enableRttIcon: boolean;
-    enableSoundRequire: boolean;
-    toastLevel: number;
-    appKey: string;
-    groupId: string;
-    textInputEventPrompt: boolean;
-    audioInput: boolean;
-    audioInputAutoStart: boolean;
-    videoInput: boolean;
-    videoInputAutoStart: boolean;
-}
-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: string;
-    debugTask: boolean;
-    debugWebServer: string;
-    loadingTimeout: number;
-    shareUrl: boolean;
-    mobileForceLandscape: boolean;
-    mobileVirtualJoystick: boolean;
-    mouseZoomDirection: number;
-    showPlayerList: boolean;
-    preferDecoder: 'auto' | 'vp8' | 'vp9' | 'h264' | 'h265' | 'hevc' | 'av1x';
-    touchOperateMode: 'touchScreen' | 'mouse';
-    appliId: string;
-    syncLocalToCloudClipboard: boolean;
-    enableRttIcon: boolean;
-    enableSoundRequire: boolean;
-    toastLevel: number;
-    appKey: string;
-    groupId: string;
-    textInputEventPrompt: boolean;
-    audioInput: boolean;
-    audioInputAutoStart: boolean;
-    videoInput: boolean;
-    videoInputAutoStart: boolean;
-    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;
-}
-/**
- * WARNING 服务器端返回数据随机性较大，统一在该函数里做兼容处理
- * 服务器端可能随意修改字段名称或值，需要注意测试
- * @param startAppInfo
- * @returns
- */
-export declare function LoadAppliParamsFromUrl(): IAppliParams;
-/**
- * WARNING 服务器端返回数据随机性较大，统一在该函数里做兼容处理
- * 服务器端可能随意修改字段名称或值，需要注意测试
- * @param startAppInfo
- * @returns
- */
-export declare function LoadAppliParamsStartAppInfo(startAppInfo: StartAppInfo): IAppliParams;

package/dist/types/common/cmd.d.ts

@@ -1,28 +0,0 @@
-declare const enum CMD {
-    SESSIONKEY = 1,
-    APPSTART = 2,
-    VIDEO = 3,
-    MOUSE_DOWN = 4,
-    MOUSE_UP = 5,
-    MOUSE_MOVE = 6,
-    KEY_DOWN = 7,
-    KEY_UP = 8,
-    KEY_PRESS = 9,
-    CONNECT_APP_SERVER = 10,
-    APP_SERVER_CONNECTED = 11,
-    APP_SERVER_CONNECT_FAILED = 12,
-    CONNECT_ALREADY_EXIST = 13,
-    MOUSE_RIGHT = 14,
-    MOUSE_WHEELE = 15,
-    WEBRTC_GETICESERVER = 16,
-    WEBRTC_GET_REMOTE_ICECANDIDATE = 17,
-    WEBRTC_CALL = 18,
-    WEBRTC_ADD_ICECANDIDATE = 19,
-    WEBRTC_HANGUP = 20,
-    WEBRTC_GETDEVICELIST = 21,
-    REMOTE_APP_CLOSE = 22,
-    MOUSE_BUTTON = 23,
-    KEEP_ALIVE = 24,
-    REMOTE_APP_COUSOR_CHANGE = 25
-}
-export default CMD;

package/dist/types/common/constant.d.ts

@@ -1,4 +0,0 @@
-export declare const VIDEO_ID = "video";
-export declare const IMAGE_CURSOR_ID = "cursorid";
-export declare const EMPTY_PNG = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAZdEVYdFNvZnR3YXJlAFBhaW50Lk5FVCB2My41LjbQg61aAAAADUlEQVQYV2P4//8/IwAI/QL/+TZZdwAAAABJRU5ErkJggg==";
-export declare const TOKEN_EXPIRED = "TOKEN_EXPIRED";

package/dist/types/common/interface.d.ts

@@ -1,30 +0,0 @@
-export interface Point {
-    x: number;
-    y: number;
-}
-export interface Vector {
-    x: number;
-    y: number;
-    startPoint: Point;
-    endPoint: Point;
-}
-export interface Stage {
-    width: number;
-    height: number;
-    Position: Point;
-}
-export interface CSSPosition {
-    top: number;
-    left: number;
-}
-export interface ViewPort {
-    width: number;
-    height: number;
-}
-export interface Toggle {
-    show: boolean;
-}
-export interface OffsetView {
-    offsetX: number;
-    offsetY: number;
-}

package/dist/types/config.d.ts

@@ -1,59 +0,0 @@
-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/dist/types/event/event_base.d.ts

@@ -1,11 +0,0 @@
-export interface LocalEvent<E> {
-    type: E;
-    target?: any;
-}
-export declare type Callback<E> = (e: E, ...params: any[]) => void;
-export declare abstract class EventBase<T, E extends LocalEvent<T>> {
-    private listeners;
-    on(type: T, callback: Callback<E>, self?: any): void;
-    off(type: T, callback: Callback<E>, self?: any): void;
-    emit(event: E, ...params: any[]): void;
-}