@realsee/live 0.4.0-beta.7 → 0.5.0-alpha.2

package/dist/typings/live/EventType.d.ts

@@ -1,37 +1,16 @@
 import { BuiltinMsg, LiveMsg } from './LiveMsg';
+import { LiveState } from './LiveState';
 import { UserInfo } from './UserInfo';
-import { WebSocketError, WebSocketState } from './WebSocket';
 /**
- * WebSocket 相关异步事件
- * @description
- * @deprecated 这些事件不应暴露给应用层
+ * 带看事件列表
  */
-declare type WebSocketEventType = {
+export declare type LiveEventType<KeyframesSnapshot> = {
     /**
-     * WebSocket 状态发生更新
-     * @param readyState - 当前状态枚举值。
+     * 带看状态变化
+     * @param state
+     * @param prevState
      */
-    'ws.readyStateUpdate'(readyState: WebSocketState): void;
-    /**
-     * WebSocket 连接前
-     */
-    'ws.beforeConnect'(reConnect?: number): void;
-    /**
-     * WebSocket 连接后
-     */
-    'ws.afterConnect'(reConnect?: number): void;
-    /**
-     * WebSocket 连接过程中遭遇的异常情况信息。
-     * @param error - 错误信息。
-     */
-    'ws.error'(error: WebSocketError): void;
-    /**
-     * WebSocket 收到的消息
-     * @param liveMsg - 透传 WebSocket 消息
-     */
-    'ws.message'(liveMsg: LiveMsg): void;
-};
-declare type LiveEventType<Snapshot> = {
+    'stateChange'(state: LiveState, prevState?: LiveState): void;
     /**
      * 内置消息事件
      * @param builtinMsg
@@ -56,12 +35,12 @@ declare type LiveEventType<Snapshot> = {
      * 带看已经就绪，可以发送帧数据。
      * @param lastKeyframe 带看最后一帧数据（链接切换、断网等重连恢复上次会话帧状态），你可以通过此数据拉齐当前UI状态。
      */
-    'readyKeyframeSync'(lastKeyframe: Partial<Snapshot>): void;
+    'readyKeyframeSync'(lastKeyframe: Partial<KeyframesSnapshot>): void;
     /**
      * 获取其他用户输送的帧数据：根据此帧数据更新UI状态。
      * @param keyframes
      */
-    'keyframes'(keyframes: Partial<Snapshot>, frontRequestId: string): void;
+    'keyframes'(keyframes: Partial<KeyframesSnapshot>, frontRequestId: string): void;
     /**
      * 个人信息发生更新。
      * @param userInfo
@@ -83,8 +62,13 @@ declare type LiveEventType<Snapshot> = {
      */
     'error'(liveMsg: LiveMsg): void;
 };
-declare type KeyframeTypes<Type> = {
+/**
+ * 帧数据类型
+ */
+export declare type KeyframeTypes<Type> = {
     [Property in keyof Type as Property]: (nextKeyframes: Type[Property], prevKeyframes: Type[Property], frontRequestId: string) => void;
 };
-declare type EventType<Snapshot> = LiveEventType<Snapshot> & WebSocketEventType;
-export { LiveEventType, WebSocketEventType, KeyframeTypes, EventType };
+/**
+ * 事件解析
+ */
+export declare type EventType<KeyframesSnapshot> = LiveEventType<KeyframesSnapshot>;

package/dist/typings/live/LiveConnectOptions.d.ts

@@ -0,0 +1,7 @@
+import { MicroStatus } from "./LiveMsg";
+export declare type LiveConnectOptions = {
+    url?: string;
+    force?: boolean;
+    getTicket?: () => Promise<string>;
+    rtcMicStatus?: MicroStatus;
+};

package/dist/typings/live/LiveErrorType.d.ts

@@ -0,0 +1,9 @@
+export declare enum LiveErrorType {
+    Error = "Error",
+    Close = "Close",
+    MicroAuth = "MicroAuth",
+    DuplicateConnect = "DuplicateConnect",
+    IllegalURL = "IllegalURL",
+    Unknown = "Unknown",
+    IllegalArgs = "IllegalArgs"
+}

package/dist/typings/live/LiveOptions.d.ts

@@ -2,6 +2,7 @@ import { JSBridgeProtocol } from '@realsee/jsbridge-x';
 import { RTCProtocol } from '../rtc/protocol';
 import { BuiltInRTCType, RTCType } from '../rtc/type';
 import { GetVoiceSign } from './GetVoiceSign';
+import { MicroStatus } from './LiveMsg';
 /**
  * 依赖配置。
  */
@@ -20,6 +21,10 @@ export interface LiveOptions {
      * rtc 为空时使用内置的rtc实例类型
      */
     rtcType?: RTCType;
+    /**
+     * 麦克风初始状态
+     */
+    initialMicroStatus?: MicroStatus;
     /**
      * 获取建立 WebSocket 连接的依赖Tick
      */
@@ -47,18 +52,6 @@ export interface LiveOptions {
      * 使用内置的jsBridge实例
      */
     useBuiltInJsBridge?: boolean;
-    /**
-     * 初始化自动连接，false 需手动执行 live.connect() 方法
-     */
-    /**
-     * 异常断开是否自动重连：默认 `true` 重连三次.
-     * 可以设置 `false` 关闭自动重连，以监控 `ws.readyStateUpdate` 事件自己来实现重连逻辑。
-     */
-    autoReconnect?: boolean | number;
-    /**
-     * 是否开启定时健康检查
-     */
-    healthCheck?: boolean | number;
     /**
      * 能否禁用某个/些用户的麦克风
      */

package/dist/typings/live/LiveState.d.ts

@@ -0,0 +1,15 @@
+export declare enum LiveState {
+    NOTINITIALIZED = -1,
+    /**
+     * 正在链接中
+     */
+    CONNECTING = 0,
+    /**
+     * 已经链接并且可以通讯
+     */
+    OPEN = 1,
+    /**
+     * 连接已关闭或者链接失败
+     */
+    CLOSED = 3
+}

package/dist/typings/live/index.d.ts

@@ -1,8 +1,9 @@
 export * from './EventType';
 export * from './GetVoiceSign';
-export * from './Live';
 export * from './LiveMsg';
 export * from './LiveOptions';
+export * from './LiveState';
+export * from './LiveConnectOptions';
 export * from './RoomInfo';
 export * from './UserInfo';
 export * from './UserVolume';

package/dist/typings/react/index.d.ts

@@ -1,2 +1 @@
-export * from './LiveReact';
 export * from './RTCActionReactCallback';

package/dist/utils/RobustWebSocket.d.ts

@@ -0,0 +1,130 @@
+import { Subscribe } from './subscribe';
+/**
+ * 鲁棒ws的配置参数
+ */
+export declare type RobustWebSocketConstructorOptions = {
+    url: string | ((ws: RobustWebSocket) => string);
+    protocols?: string[];
+    robustOptions?: RobustOptions;
+};
+/**
+ * ws 鲁棒性的配置
+ */
+export declare type RobustOptions = {
+    timeout?: number;
+    shouldReconnect?: (event: CloseEvent, ws: RobustWebSocket) => undefined | number;
+    should1000Reconnect?: boolean;
+    ignoreConnectivityEvents?: boolean;
+    automaticOpen?: boolean;
+};
+export declare type RobustWebSocketEventDetail = {
+    reconnects: number;
+    attempts: number;
+};
+export declare type RobustWebSocketEvent<T> = Event & {
+    detail: T;
+};
+export declare type RobustWebSocketEventMap = {
+    connecting: (event: RobustWebSocketEvent<RobustWebSocketEventDetail>) => void;
+    timeout: (event: RobustWebSocketEvent<RobustWebSocketEventDetail>) => void;
+    open: (event: RobustWebSocketEvent<RobustWebSocketEventDetail>) => void;
+    close: (event: CloseEvent) => void;
+    error: (event: Event) => void;
+    message: (event: MessageEvent<string | ArrayBuffer | Blob | ArrayBufferView>) => void;
+};
+/**
+ * 具有鲁棒性的WebSocket封装
+ * 1、自动重连
+ * 2、可根据网络情况进行重连
+ */
+export declare class RobustWebSocket extends Subscribe<RobustWebSocketEventMap> {
+    private _realWebSocket;
+    private _url?;
+    private _protocols;
+    private _options;
+    private _connectTimeout;
+    private _attempts;
+    private _reconnects;
+    private _reconnectWhenOnlineAgain;
+    private _explicitlyClosed;
+    private _pendingReconnect;
+    private _connectivityEventsAttached;
+    get attempts(): number;
+    constructor(options?: RobustWebSocketConstructorOptions);
+    setOptions(options: RobustWebSocketConstructorOptions): void;
+    /**
+     * 清理连接中的请求
+     */
+    private _clearPendingReconnectIfNeeded;
+    /**
+     * 当网页连接上网络进行重连
+     * @param event
+     */
+    private _online;
+    /**
+     * 当网页断开网络进行关闭
+     */
+    private _offline;
+    /**
+     * 解除网络监听事件
+     */
+    private _detachConnectivityEvents;
+    /**
+     * 注册网络监听事件
+     */
+    private _attachConnectivityEvents;
+    /**
+     * 发送消息
+     * @param data
+     * @returns
+     */
+    send: (data: string | ArrayBuffer | Blob | ArrayBufferView) => void | undefined;
+    /**
+     * 关闭连接
+     * @param code 代码
+     * @param reason 原因
+     * @returns
+     */
+    close: (code?: number | string, reason?: string) => void | undefined;
+    /**
+     * 进行ws连接
+     */
+    open: (url?: string) => void;
+    /**
+     * 创建ws连接
+     */
+    private _createWebSocket;
+    /**
+     * 分发ws事件
+     */
+    private _dispatchWebSocketEvent;
+    /**
+     * ws连接事件
+     * @returns
+     */
+    private _webSocketOpenHandler;
+    /**
+     * ws 关闭事件
+     * @param event
+     * @returns
+     */
+    private _webSocketCloseHandler;
+    /**
+     * ws 异常
+     * @param event
+     * @returns
+     */
+    private _webSocketErrorHandler;
+    /**
+     * ws消息
+     * @param event
+     * @returns
+     */
+    private _webSocketMessageHandler;
+    /**
+     * 进行重连
+     * @param event
+     * @returns
+     */
+    private _reconnect;
+}

package/dist/utils/logger.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 输出格式化日志
+ */
+export declare enum LOG_LEVEL {
+    info = "INFO",
+    log = "LOG",
+    error = "ERROR",
+    warn = "WARN"
+}
+declare const logger: {
+    log: (...args: any[]) => void;
+    info: (...args: any[]) => void;
+    error: (...args: any[]) => void;
+    warn: (...args: any[]) => void;
+};
+export default logger;