larksr_websdk 3.2.330 → 3.2.332

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

@@ -13,7 +13,7 @@ export declare enum APP_STATE {
     LOGIN_SUCCESS = 3,
     RTC_CONNECTED = 4,
     MEDIA_LOADED = 5,
-    MEDIA_PLAED = 6,
+    MEDIA_PLAYED = 6,
     RTC_RETRY = 7,
     APP_RETRY = 8,
     BEFORE_DESTORY = 9,
@@ -56,13 +56,19 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     private websocketProxy;
     private testPixelStreaming;
     private peerConnection;
+    private sharePeerConnection;
+    get peerConnectionCreated(): boolean;
     get state(): APP_STATE;
     set state(state: APP_STATE);
     private _state;
     get audioDeviceId(): string | undefined;
-    get audioTrack(): MediaStreamTrack | undefined;
+    get audioTrack(): MediaStreamTrack | {
+        enabled: boolean;
+    } | undefined;
     get videoDeviceId(): string | undefined;
-    get videoTrack(): MediaStreamTrack | undefined;
+    get videoTrack(): MediaStreamTrack | {
+        enabled: boolean;
+    } | undefined;
     private retryTime;
     private larksr;
     get voiceId(): number;
@@ -70,8 +76,10 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     private recoder;
     constructor(larksr: LarkSR);
     init(): void;
+    initSharePc(): void;
     initPc(): void;
     releasePc(): void;
+    releaseSharePc(): void;
     clear(): void;
     changeOperater(uid: number): void;
     inputText(text: string): void;
@@ -123,18 +131,21 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     setAudioEnable(enable: boolean): void | undefined;
     setVideoEnable(enable: boolean): void | undefined;
     setShareEnable(enable: boolean): void | undefined;
-    closeAudio(): boolean | undefined;
-    closeVideo(): boolean | undefined;
-    closeShare(): boolean | undefined;
+    closeAudio(): RTCMediaTrackBinding[] | undefined;
+    closeVideo(): RTCMediaTrackBinding[] | undefined;
+    closeShare(): RTCMediaTrackBinding[] | undefined;
     openAudio(deviceId?: string): Promise<{
         streams: MediaStream;
         rtcRtpSenders: RTCMediaTrackBinding[];
     } | undefined>;
-    openVideo(audio?: boolean, cameraId?: string): Promise<{
+    openVideo(audio?: boolean, cameraId?: string, width?: number, height?: number): Promise<{
+        streams: MediaStream;
+        rtcRtpSenders: RTCMediaTrackBinding[];
+    } | undefined>;
+    openDefaultMedia(video?: boolean, audio?: boolean): Promise<{
         streams: MediaStream;
         rtcRtpSenders: RTCMediaTrackBinding[];
     } | undefined>;
-    openDefaultMedia(video?: boolean, audio?: boolean): Promise<void | undefined>;
     openShareMediaDevice(): Promise<void | undefined>;
     getConnectedAudioinputDevices(): Promise<MediaDeviceInfo[] | undefined>;
     getConnectedAudioOutputDevices(): Promise<MediaDeviceInfo[] | undefined>;
@@ -148,7 +159,7 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
         streams: MediaStream;
         rtcRtpSenders: RTCMediaTrackBinding[];
     } | undefined>;
-    openUserMeida(constraints?: MediaStreamConstraints): Promise<{
+    openUserMeida(constraints?: MediaStreamConstraints, reset?: boolean): Promise<{
         streams: MediaStream;
         rtcRtpSenders: RTCMediaTrackBinding[];
     } | undefined>;

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

@@ -10,6 +10,8 @@ export default class Message {
     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;
+    static mediaShareRtcOfferMsg(type: string, sdp: string): Msg.CloudLark.ToServerMessage;
+    static mediaShareIceMsg(sdpmid: string, sdpMlineindex: number, candidate: string): Msg.CloudLark.ToServerMessage;
     static restartApp(): Msg.CloudLark.ToServerMessage;
     static getTaskResponseMsg(ressponse: Msg.CloudLark.TaskResponse.Response): string;
     static getStartStreamResponseMsg(ressponse: Msg.CloudLark.StartStreamResponse.Response): string;

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

@@ -0,0 +1,89 @@
+import { EventBase, LocalEvent } from '../event/event_base';
+import { LarkSR } from '../larksr';
+import { RTCMediaTrackBinding } from './peer_connection';
+export declare enum WEBRTC_MEDIA_SHARE_EVENT_TYPE {
+    RTC_SDP = 0,
+    RTC_ICECANDIDATE = 1,
+    ICE_STATE_CHANGE = 2,
+    ERROR = 3,
+    INFO = 4
+}
+export interface WebRTCMediaShareEvent extends LocalEvent<WEBRTC_MEDIA_SHARE_EVENT_TYPE> {
+    data?: any;
+}
+export interface WebRTCConfig {
+    serverIP: string;
+    preferPubOutIp: string;
+}
+export default class PeerConnectionMediaShare extends EventBase<WEBRTC_MEDIA_SHARE_EVENT_TYPE, WebRTCMediaShareEvent> {
+    get audioDeviceId(): string;
+    get audioTrack(): MediaStreamTrack | {
+        enabled: boolean;
+    };
+    get videoDeviceId(): string;
+    get videoTrack(): MediaStreamTrack | {
+        enabled: boolean;
+    };
+    private larksr;
+    private offerOptions;
+    private pcConfig;
+    private pc;
+    private sdpCreateSuccess;
+    private rtcRtpSenders;
+    constructor(larksr: LarkSR);
+    create(): Promise<void>;
+    createOffer(): void;
+    close(): void;
+    setAudioEnable(enable: boolean): void;
+    setVideoEnable(enable: boolean): void;
+    setShareEnable(enable: boolean): void;
+    closeAudio(): RTCMediaTrackBinding[];
+    closeVideo(): RTCMediaTrackBinding[];
+    closeShare(): RTCMediaTrackBinding[];
+    private stopLocalTrackBing;
+    openAudio(deviceId?: string): Promise<{
+        streams: MediaStream;
+        rtcRtpSenders: RTCMediaTrackBinding[];
+    }>;
+    openVideo(audio?: boolean, cameraId?: string, width?: number, height?: number): Promise<{
+        streams: MediaStream;
+        rtcRtpSenders: RTCMediaTrackBinding[];
+    }>;
+    openDefaultMedia(video?: boolean, audio?: boolean): Promise<{
+        streams: MediaStream;
+        rtcRtpSenders: RTCMediaTrackBinding[];
+    }>;
+    openShareMediaDevice(): Promise<void>;
+    getConnectedAudioinputDevices(): Promise<MediaDeviceInfo[]>;
+    getConnectedAudioOutputDevices(): Promise<MediaDeviceInfo[]>;
+    getConnectedVideoinputDevices(): Promise<MediaDeviceInfo[]>;
+    getConnectedDevices(type: MediaDeviceKind): Promise<MediaDeviceInfo[]>;
+    openAudioDevice(deviceId: string, kind?: "audioinput" | "audiooutput"): Promise<{
+        streams: MediaStream;
+        rtcRtpSenders: RTCMediaTrackBinding[];
+    }>;
+    openCamera(cameraId: string, width?: number, height?: number, audio?: boolean): Promise<{
+        streams: MediaStream;
+        rtcRtpSenders: RTCMediaTrackBinding[];
+    }>;
+    openUserMeida(constraints?: MediaStreamConstraints, reset?: boolean): Promise<{
+        streams: MediaStream;
+        rtcRtpSenders: RTCMediaTrackBinding[];
+    }>;
+    addMediaTrack(track: MediaStreamTrack, ...streams: MediaStream[]): boolean;
+    removeMediaTrack(track: RTCRtpSender): boolean;
+    requestUserMediaPermission(constraints?: MediaStreamConstraints): Promise<MediaStream>;
+    /**
+     * 接收到sdp
+     * @param des sdp
+     */
+    onRemoteDescription(des: RTCSessionDescriptionInit): void;
+    onReceiveCandidate(candateInit: RTCIceCandidateInit): void;
+    private addIceCandidate;
+    private onCreateOfferSuccess;
+    private onIceCandidate;
+    private onIceStateChange;
+    private iceStateChange;
+    private $emit;
+    private createEvent;
+}

package/dist/types/larksr.d.ts

@@ -106,9 +106,10 @@ declare enum LarkSRClientEvent {
      */
     GOT_REMOTE_AUDIO_STREAM = "gotremoteaudiostream",
     /**
-     * 视频加载成功，等待播放 .
+     * 视频加载成功
      */
     MEDIA_LOADED = "meidaloaded",
+    MEDIA_LOADED2 = "medialoaded",
     /**
      * 视频自动播放成功 .
      */
@@ -180,6 +181,30 @@ declare enum LarkSRClientEvent {
     LarkEvent = "larkevent",
     /**
      * 发生错误时抛出
+     * type:     error
+     * message: 错误消息
+     * code:    可能的错误码如下, 错误码的具体定义 @see [./event_codes]
+     *          // 连接服务器的websocket代理关闭
+     *          LK_RENDER_SERVER_CLOSE                    : 102
+     *          // 连接代理服务器的websocket关闭
+     *          LK_PROXY_SERVER_CLOSE                     : 202
+     *          // 检测版本失败，服务器和客户端的版本匹配。目前只有3.1和3.2大版本不匹配情况
+     *          LK_VERSION_CHECK_FAILED                   : 301
+     *          // 服务器返回创建Task失败
+     *          TASK_NOTFOUND-TASK_NO_GPU_RESOURCE        : 401-404
+     *          // 服务端启动流媒体失败
+     *          LK_START_STREAM_PROCESS_START-FAILED-LK_START_STREAM_ENCODER_ERROR : 501-504
+     *          // RTC 连接关闭
+     *          LK_RTC_EVENT_PEERCONNECTION_CLOSED        : 601
+     *          // RTC 连接出错
+     *          LK_RTC_EVENT_PEERCONNECTION_ERROR         : 602
+     *          // RTC 创建出错，一般为 浏览器不支持 webrtc
+     *          LK_RTC_EVENT_PEERCONNECTION_CREATE_FAILED : 603
+     *          // 服务器主动要求客户端退出
+     *          LK_NOTIFY_CLIENT_LOGOUT_PLAYER_LOGOUT     : 800
+     *          // 一人操作多人看房主退出
+     *          LK_NOTIFY_CLIENT_LOGOUT_TASKOWNER_LOGOUT  : 801
+     *
      */
     ERROR = "error",
     /**
@@ -436,6 +461,11 @@ interface ILarkSRConfig {
      * zh-CN 中文 en 英文
      */
     language?: string;
+    /**
+     * 点对点连接成功，但未接收到视频流或未播放成功超时时间。自动播放模式下超时会弹出提示按钮。
+     * 默认 20S
+     */
+    playTimeout?: number;
 }
 declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**
@@ -585,7 +615,9 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**
      * 当前打开音频的track对象，未打开状态为空
      */
-    get audioTrack(): MediaStreamTrack | undefined;
+    get audioTrack(): MediaStreamTrack | {
+        enabled: boolean;
+    } | undefined;
     /**
      * 当前打开视频设备 ID，如果打开时没指定特设备id为空
      */
@@ -593,7 +625,9 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**
      * 当前打开视频track对象，未打开状态为空
      */
-    get videoTrack(): MediaStreamTrack | undefined;
+    get videoTrack(): MediaStreamTrack | {
+        enabled: boolean;
+    } | undefined;
     /**
      * LarkSR 客户端。所有操作和事件通过该类传递
      * @param config 本地配置，优先级最高
@@ -974,9 +1008,9 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 关闭当前的音频设备
      * @returns
      */
-    closeAudio(): boolean | undefined;
-    closeVideo(): boolean | undefined;
-    closeShare(): boolean | undefined;
+    closeAudio(): import("./lark/peer_connection").RTCMediaTrackBinding[] | undefined;
+    closeVideo(): import("./lark/peer_connection").RTCMediaTrackBinding[] | undefined;
+    closeShare(): import("./lark/peer_connection").RTCMediaTrackBinding[] | undefined;
     /**
      * 打开一个音频设备，要注意浏览器限制在 https 或者 localhost 下才能打开音频
      * @param deviceId 音频设备id，如果不传将打开默认设备。@see getConnectedAudioinputDevices
@@ -992,7 +1026,7 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * @param cameraId 视频设备id，如果不传将打开默认设备。@see getConnectedVideoinputDevices
      * @returns Promise
      */
-    openVideo(audio?: boolean, cameraId?: string): Promise<{
+    openVideo(audio?: boolean, cameraId?: string, width?: number, height?: number): Promise<{
         streams: MediaStream;
         rtcRtpSenders: import("./lark/peer_connection").RTCMediaTrackBinding[];
     } | undefined>;
@@ -1003,7 +1037,10 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * @param audio 是否包含音频
      * @returns Promise
      */
-    openDefaultMedia(video?: boolean, audio?: boolean): Promise<void | undefined>;
+    openDefaultMedia(video?: boolean, audio?: boolean): Promise<{
+        streams: MediaStream;
+        rtcRtpSenders: import("./lark/peer_connection").RTCMediaTrackBinding[];
+    } | undefined>;
     openShareMediaDevice(): Promise<void | undefined>;
     /**
      * 返回已连接的音频设备列表，设备列表中的设备的 deviceId 可用来打开某个音频设备
@@ -1025,7 +1062,7 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
         streams: MediaStream;
         rtcRtpSenders: import("./lark/peer_connection").RTCMediaTrackBinding[];
     } | undefined>;
-    openUserMeida(constraints?: MediaStreamConstraints): Promise<{
+    openUserMeida(constraints?: MediaStreamConstraints, reset?: boolean): Promise<{
         streams: MediaStream;
         rtcRtpSenders: import("./lark/peer_connection").RTCMediaTrackBinding[];
     } | undefined>;

package/dist/types/localization/ui.d.ts

@@ -56,4 +56,5 @@ export default class UI extends LocalizationBase {
     get APP_RETRY(): string;
     get APP_RETRY_CONFIRM(): string;
     get START(): string;
+    get PLAY_FAILED(): string;
 }