@realsee/live 0.6.13 → 0.6.15

package/dist/live/controller.d.ts

@@ -2,11 +2,39 @@ import { LiveMsg } from '../typings';
 import { LiveState } from '../typings/live/LiveState';
 import { RobustWebSocketEventDetail } from '../utils/RobustWebSocket';
 import { Subscribe } from '../utils/subscribe';
+/**
+ * 带看控制器事件映射
+ */
 export type LiveControllerEventMap = {
+    /**
+     * 带看状态变更
+     * @param state
+     * @param prevState
+     * @returns
+     */
     stateChange: (state: LiveState, prevState: LiveState) => void;
+    /**
+     * 接收到带看消息
+     * @param message
+     * @returns
+     */
     message: (message: LiveMsg) => void;
+    /**
+     * 带看重连中
+     * @param detail
+     * @returns
+     */
+    reconnecting: (detail: RobustWebSocketEventDetail) => void;
+    /**
+     * 带看重连成功
+     * @param detail
+     * @returns
+     */
     reconnected: (detail: RobustWebSocketEventDetail) => void;
 };
+/**
+ * 带看控制器
+ */
 export declare class LiveController extends Subscribe<LiveControllerEventMap> {
     /**
      * ws代理器

package/dist/live/createLiveReact.d.ts

@@ -21,7 +21,7 @@ export declare function createLiveReact<KeyframesSnapshot extends Record<string,
     useLiveAction: () => {
         connect: (options: LiveConnectOptions) => Promise<boolean | Error>;
         broadcast: (data: Record<string, any>, toUserIds: string | string[], timeout?: number) => Promise<unknown>;
-        exit: () => Promise<boolean>;
+        exit: () => Promise<void>;
         kick: (toUserIds: string | string[]) => Promise<boolean>;
         toggleMicro: (microStatus: boolean) => Promise<boolean>;
         forbidMicro: (micro: MicroStatus, toUserIds?: string | string[]) => Promise<boolean>;

package/dist/live/live.d.ts

@@ -117,7 +117,12 @@ export declare class Live<KeyframesSnapshot extends Record<string, any>> extends
      * 退出带看
      * @returns
      */
-    exit: () => Promise<boolean>;
+    _exit: () => Promise<boolean>;
+    /**
+     * 退出带看
+     * @returns
+     */
+    exit: () => Promise<void>;
     /**
      * 关闭带看房间
      * @param code

package/dist/rtc/VRWebViewRTC.d.ts

@@ -1,22 +1,97 @@
-import { RTCType } from '../typings/rtc/type';
-import { VRWebViewRTCOptions } from '../typings/rtc/VRWebViewRTCOptions';
-import { CoreRTC } from './CoreRTC';
+import { RTCType } from "../typings/rtc/type";
+import { VRWebViewRTCOptions } from "../typings/rtc/VRWebViewRTCOptions";
+import { CoreRTC } from "./CoreRTC";
 export declare class VRWebViewRTC extends CoreRTC {
     type: RTCType;
     joined: boolean;
     micro: boolean;
     voiceId: string;
+    /**
+     * 保留加入房间参数，用于重连
+     */
+    private _joinOptions;
     private options;
     get jsBridge(): import("@realsee/jsbridge-x").JSBridgeProtocol;
     constructor({ jsBridge, getVoiceSign }: VRWebViewRTCOptions);
-    join(options: {
+    /**
+     * 处理用户音量
+     * @param userVolumes
+     */
+    private handleUserVolumes;
+    /**
+     * 处理弱网络情况
+     * @param weakNetwork
+     */
+    private handleWeakNetwork;
+    /**
+     * 加入语音房间
+     * @param options
+     * @returns
+     */
+    join: (options: {
         voiceId: string;
         userId: string;
         roomId: string;
         type: RTCType;
-    }): Promise<boolean>;
-    quit(): Promise<boolean>;
-    detectMicro(): Promise<boolean>;
-    toggleMicro(flag?: boolean): Promise<boolean>;
-    shock(): void;
+    }) => Promise<boolean>;
+    /**
+     * 重连
+     * @returns
+     */
+    reJoin: () => Promise<boolean>;
+    /**
+     * 获取 rtc 签名
+     * @param params
+     * @returns
+     */
+    private getVoiceSignOrEmitError;
+    /**
+     * 处理小程序的加入房间
+     * @param options
+     * @returns
+     */
+    private handleWxMiniProgramWebViewJoin;
+    /**
+     * 处理App WebView的加入房间
+     * @param options
+     * @returns
+     */
+    private handleAppWebViewJoin;
+    /**
+     * 加入语音房间，给小程序使用
+     * @param param0
+     * @returns
+     */
+    private joinRoomOrEmitError;
+    /**
+     * 处理加入语音房间结果
+     * @param res
+     * @returns
+     */
+    private handleJoinResult;
+    /**
+     * 将错误信息发送出去，并将 joined 置为 false
+     * @param message
+     */
+    private emitErrorAndSetJoinedFalse;
+    /**
+     * 退出房间
+     * @returns
+     */
+    quit: () => Promise<boolean>;
+    /**
+     * 监测麦克风权限
+     * @returns
+     */
+    detectMicro: () => Promise<boolean>;
+    /**
+     * 修改麦克风状态
+     * @param flag
+     * @returns
+     */
+    toggleMicro: (flag?: boolean) => Promise<boolean>;
+    /**
+     * 震动
+     */
+    shock: () => void;
 }

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

@@ -1,17 +1,45 @@
 /**
  * 语音签名的返回值
  */
-export interface GetVoiceSignReturnType {
+export type GetVoiceSignReturnType = {
+    /**
+     * rtc 的 sdkAppId
+     */
     sdkAppId: number;
+    /**
+     * rtc 的 用户 id
+     */
     userId: string;
+    /**
+     * rtc 的 语音房间号
+     */
     roomId: string | number;
+    /**
+     * rtc 的 用户签名
+     */
     userSig: string;
-}
+};
 /**
- * 获取用户语音签名
+ * 获取用户语音签名的参数
  */
-export type GetVoiceSign = ({ voiceId, userId, roomId, }: {
+export type GetVoiceSignParams = {
+    /**
+     * 语音房间号
+     */
     voiceId: string;
+    /**
+     * 用户 id
+     */
     userId: string;
+    /**
+     * 房间 id
+     */
     roomId: string | number;
-}) => Promise<GetVoiceSignReturnType>;
+};
+/**
+ * 获取用户语音签名的方法
+ * @param voiceId 语音房间号
+ * @param userId 用户 id
+ * @param roomId 房间 id
+ */
+export type GetVoiceSign = (params: GetVoiceSignParams) => Promise<GetVoiceSignReturnType>;

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

@@ -1,7 +1,24 @@
 import { MicroStatus } from "./LiveMsg";
+/**
+ * 带看连接配置项
+ */
 export type LiveConnectOptions = {
+    /**
+     * 这个是带看房间的 ws 地址
+     */
     url?: string;
+    /**
+     * 是否强制加入
+     * 如果为 true，会强制加入房间，不管之前是否已经加入，会把之前的连接断开
+     * 如果为 false，会检查是否已经加入房间，如果已经加入，不会再次加入
+     */
     force?: boolean;
+    /**
+     * 获取带看房间 ticket 的方法
+     */
     getTicket?: () => Promise<string>;
+    /**
+     * 初始的麦克风状态
+     */
     rtcMicStatus?: MicroStatus;
 };

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

@@ -4,13 +4,21 @@
  * - 上行：客户端上报数据
  */
 export declare enum Command {
+    /** 当前用户信息：下行 */
     SelfUserInfo = "SELF_USER_INFO",
+    /** 房间信息：下行 */
     RoomInfo = "ROOM_INFO",
+    /** RTC信息：下行 */
     RTCInfo = "RTC_INFO",
+    /** 用户列表：下行 */
     UserList = "USER_LIST",
+    /** 内置消息：下行、上行 */
     BuiltinMsg = "BUILTIN_MSG",
+    /** 自定义广播事件消息：下行、上行 */
     CustomEvent = "CUSTOM_EVENT",
+    /** 帧数据同步：下行、上行 */
     KeyframeSync = "KEYFRAME_SYNC",
+    /** 被踢出房间：下行 */
     UserKickOut = "USER_KICK_OUT"
 }
 /**
@@ -94,7 +102,13 @@ export type BuiltinMsg = {
  * 麦克风状态。
  */
 export declare enum MicroStatus {
+    /**
+     * 打开
+     */
     OPEN = "OPEN",
+    /**
+     * 关闭
+     */
     CLOSE = "CLOSE"
 }
 /**

package/dist/typings/rtc/eventType.d.ts

@@ -1,5 +1,5 @@
-import { UserVolume } from '../live/UserVolume';
-import { RTCJoinedInfo } from './joinedInfo';
+import { UserVolume } from "../live/UserVolume";
+import { RTCJoinedInfo } from "./joinedInfo";
 /**
  * RTC 异步事件类型。
  */
@@ -8,22 +8,37 @@ export type RTCEventType = {
      * 错误\异常
      * @param error
      */
-    'error'(error: Error | RTCJoinedInfo): void;
+    "error"(error: Error | RTCJoinedInfo): void;
     /**
      * 即将加入房间。
      */
-    'joinWillStart'(): void;
+    "joinWillStart"(): void;
     /**
      * 成功加入语音房间。
      */
-    'joined'(): void;
+    "joined"(): void;
     /**
      * 弱网提醒事件。
      */
-    'weakNetwork'(): void;
+    "weakNetwork"(): void;
     /**
      * 每个用户的音量。
      * @param userVolumes
      */
-    'userVolumes'(userVolumes: UserVolume[]): void;
+    "userVolumes"(userVolumes: UserVolume[]): void;
+    /**
+     * rtc 成功
+     * @inner 内置事件，行为会随版本变更，请勿通过外部注册监听
+     */
+    "inner.rtc.success"(result: RTCJoinedInfo | boolean): void;
+    /**
+     * rtc 失败
+     * @inner 内置事件，行为会随版本变更，请勿通过外部注册监听
+     */
+    "inner.rtc.fail"(result: RTCJoinedInfo | boolean): void;
+    /**
+     * rtc 错误
+     * @inner 内置事件，行为会随版本变更，请勿通过外部注册监听
+     */
+    "inner.rtc.error"(error: Error): void;
 };

package/dist/typings/rtc/joinedInfo.d.ts

@@ -17,7 +17,11 @@ export declare enum RTCJoinedInfoCodeEnum {
     /**
      * 无麦克风权限
      */
-    NoMicroPermission = 3
+    NoMicroPermission = 3,
+    /**
+     * 未知异常
+     */
+    Unknown = 500
 }
 /**
  * 进入rtc房间的回调信息

package/dist/typings/rtc/protocol.d.ts

@@ -37,6 +37,10 @@ export interface RTCProtocol extends Subscribe<RTCEventType> {
         roomId: string | number | undefined;
         type: RTCType;
     }): Promise<boolean>;
+    /**
+     * 重新加入房间。
+     */
+    reJoin?(): Promise<boolean>;
     /**
      * 离开房间。
      * @returns

package/dist/utils/RobustWebSocket.d.ts

@@ -17,6 +17,9 @@ export type RobustOptions = {
     ignoreConnectivityEvents?: boolean;
     automaticOpen?: boolean;
 };
+/**
+ * 重连的事件详情
+ */
 export type RobustWebSocketEventDetail = {
     reconnects: number;
     attempts: number;