@realsee/live 0.7.1 → 0.7.3-alpha.0

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

@@ -0,0 +1,38 @@
+/**
+ * rtc加入返回值code枚举
+ */
+export declare enum RTCJoinedInfoCodeEnum {
+    /**
+     * 成功
+     */
+    Success = 0,
+    /**
+     * 失败
+     */
+    Failure = 1,
+    /**
+     * 重复加入
+     */
+    ReJoin = 2,
+    /**
+     * 无麦克风权限
+     */
+    NoMicroPermission = 3,
+    /**
+     * 未知异常
+     */
+    Unknown = 500
+}
+/**
+ * 进入rtc房间的回调信息
+ */
+export interface RTCJoinedInfo {
+    code: RTCJoinedInfoCodeEnum;
+    message: string;
+    userId?: string;
+    roomId?: number;
+    errInfo?: {
+        errCode: number;
+        errMsg: string;
+    };
+}

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

@@ -0,0 +1,77 @@
+import { CheckResult } from 'trtc-js-sdk';
+import { Subscribe } from '../../utils/subscribe';
+import { RTCEventType } from './eventType';
+import { RTCType } from './type';
+/**
+ * rtc 协议接口
+ * @interface
+ * @extends Subscribe<RTCEventType>
+ */
+export interface RTCProtocol extends Subscribe<RTCEventType> {
+    /**
+     * 是否已经加入房间
+     * @type {boolean}
+     */
+    joined: boolean;
+    /**
+     * 麦克风状态
+     * @type {boolean}
+     */
+    micro: boolean;
+    /**
+     * 语音房间ID
+     * @type {string}
+     */
+    voiceId: string;
+    /**
+     * rtc 实现类型
+     * @type {RTCType}
+     */
+    type: RTCType;
+    /**
+     * 检查rtc的系统依赖是否满足
+     * @returns {Promise<CheckResult>} 返回一个Promise，表示检查结果
+     */
+    checkRequirement?(): Promise<CheckResult>;
+    /**
+     * 加入房间。
+     * @param {Object} options - 加入房间的选项
+     * @param {string} options.voiceId - 语音房间ID
+     * @param {string} options.userId - 用户ID
+     * @param {string|number|undefined} options.roomId - 房间ID
+     * @param {RTCType} options.type - RTC类型
+     * @returns {Promise<boolean>} 返回一个Promise，表示是否成功加入房间
+     */
+    join(options: {
+        voiceId: string;
+        userId: string;
+        roomId: string | number | undefined;
+        type: RTCType;
+    }): Promise<boolean>;
+    /**
+     * 重新加入房间。
+     * @returns {Promise<boolean>} 返回一个Promise，表示是否成功重新加入房间
+     */
+    reJoin?(): Promise<boolean>;
+    /**
+     * 离开房间。
+     * @returns {Promise<boolean>} 返回一个Promise，表示是否成功离开房间
+     */
+    quit(): Promise<boolean>;
+    /**
+     * 监测麦克风授权。
+     * @returns {Promise<boolean>} 返回一个Promise，表示麦克风是否被授权
+     */
+    detectMicro(): Promise<boolean>;
+    /**
+     * 关闭\开启 本地麦克风。
+     * @param {boolean} [flag] - 是否开启麦克风，默认为切换当前状态
+     * @returns {Promise<boolean>} 返回一个Promise，表示操作是否成功
+     */
+    toggleMicro(flag?: boolean): Promise<boolean>;
+    /**
+     * 震动。
+     * @returns {void}
+     */
+    shock?(): void;
+}

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

@@ -0,0 +1,12 @@
+/**
+ * rtc 类型
+ */
+export declare enum RTCType {
+    RealseeBrowserRTC = "RealseeBrowserRTC",
+    RealseeVRWebViewRTC = "RealseeVRWebViewRTC",
+    RealseeBrowserChimeRTC = "RealseeBrowserChimeRTC"
+}
+export declare enum BuiltInRTCType {
+    RealseeXTRTC = "trtc",
+    RealseeXChimeRTC = "chime"
+}

package/dist/utils/RobustWebSocket.d.ts

@@ -0,0 +1,160 @@
+import { Subscribe } from './subscribe';
+/**
+ * 鲁棒ws的配置参数
+ */
+export type RobustWebSocketConstructorOptions = {
+    url: string | ((ws: RobustWebSocket) => string);
+    protocols?: string[];
+    robustOptions?: RobustOptions;
+};
+/**
+ * ws 鲁棒性的配置
+ */
+export type RobustOptions = {
+    timeout?: number;
+    shouldReconnect?: (event: CloseEvent, ws: RobustWebSocket) => undefined | number;
+    should1000Reconnect?: boolean;
+    ignoreConnectivityEvents?: boolean;
+    automaticOpen?: boolean;
+};
+/**
+ * 重连的事件详情
+ */
+export type RobustWebSocketEventDetail = {
+    reconnects: number;
+    attempts: number;
+};
+export type RobustWebSocketEvent<T> = Event & {
+    detail: T;
+};
+export type RobustWebSocketEventMap = {
+    connecting: (event: RobustWebSocketEvent<RobustWebSocketEventDetail>) => void;
+    timeout: (event: RobustWebSocketEvent<RobustWebSocketEventDetail>) => void;
+    open: (event: RobustWebSocketEvent<RobustWebSocketEventDetail>) => void;
+    closing: () => 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 _readyState;
+    private _options;
+    private _connectTimeout;
+    private _attempts;
+    private _reconnects;
+    private _reconnectWhenOnlineAgain;
+    _explicitlyClosed: boolean;
+    private _pendingReconnect;
+    private _connectivityEventsAttached;
+    private _heathCheckTimer;
+    get attempts(): number;
+    constructor(options?: RobustWebSocketConstructorOptions);
+    setOptions(options: RobustWebSocketConstructorOptions): void;
+    /**
+     * 做一个健康检查
+     */
+    private _healthCheck;
+    /**
+     * 清理超时计时器
+     */
+    private _clearConnectTimeoutIfNeed;
+    /**
+     * 清理健康检查
+     */
+    private _clearHeathCheckIfNeed;
+    /**
+     * 开启健康检查
+     */
+    private _startHealthCheck;
+    /**
+     * 停止健康检查
+     */
+    private _stopHealthCheck;
+    /**
+     * 清理连接中的请求
+     */
+    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 _removeWebSocketEvent;
+    /**
+     * 分发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/appendUri.d.ts

@@ -0,0 +1 @@
+export declare function appendUri(uri: string, query?: Record<string, string | number>): string;

package/dist/utils/clientDetector.d.ts

@@ -0,0 +1,4 @@
+export declare const isAndroid: boolean;
+export declare const isIOS: boolean;
+export declare const isWxMiniProgram: boolean;
+export declare const isRealseeVRWebview: boolean;

package/dist/utils/equal.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 对象比较。
+ * @param value 第一个比较的值。
+ * @param other 第二个比较的值。
+ * @param options 可选参数，可选项：`deep` 是否深比较。
+ * @returns {boolean} 是否相等。
+ */
+export declare function equal(value: any, other: any, opt?: {
+    deep: boolean;
+}): boolean;

package/dist/utils/isServer.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 判断是否是服务器环境
+ * @returns
+ */
+export declare const isServer: boolean;

package/dist/utils/logger.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 输出格式化日志
+ * 该模块提供了一个简单的日志记录器，支持不同的日志级别。
+ */
+export declare enum LOG_LEVEL {
+    info = "INFO",
+    log = "LOG",
+    error = "ERROR",
+    warn = "WARN",
+    debug = "DEBUG"
+}
+declare const logger: {
+    log: (...args: any[]) => void;
+    info: (...args: any[]) => void;
+    error: (...args: any[]) => void;
+    warn: (...args: any[]) => void;
+    debug: (...args: any[]) => void;
+};
+export default logger;

package/dist/utils/subscribe.d.ts

@@ -0,0 +1,75 @@
+export type EventMap = {
+    [name: string]: (...args: any[]) => void | boolean;
+};
+/**
+ * 监听者模式
+ * @template T 预设的监听回调类型
+ * @example
+ * ```
+ * new Subscribe<{
+ * "foo": [arg1: number, arg2: string],
+ * "bar": [arg: boolean],
+ * }>()
+ * ```
+ */
+export declare class Subscribe<T extends EventMap> {
+    /**
+     * 判断是否注册了事件
+     * @param name  事件类型
+     */
+    hasListener(name: keyof T): boolean;
+    /**
+     * 注册事件
+     * @param  name    事件类型
+     * @param  callback 事件回调函数
+     * @param  once     是否只执行一次
+     * @returns 解除事件
+     * @template K 预设的监听事件名称
+     * @template C 回调函数函数上下文
+     */
+    on<K extends keyof T>(name: K, callback: (...args: Parameters<T[K]>) => ReturnType<T[K]>, once?: boolean): () => void;
+    /**
+     * 注册事件(是否只执行一次)
+     * @param  name     事件类型
+     * @param  callback 事件回调函数
+     * @returns 解除事件
+     * @template K 预设的监听事件名称
+     * @template C 回调函数函数上下文
+     */
+    once<K extends keyof T>(name: K, callback: (...args: Parameters<T[K]>) => ReturnType<T[K]>): () => void;
+    /**
+     * 解除事件
+     *
+     * 如果 name 不传的话解除对应所有事件
+     * 如果 name, callback 不传的话解除所有name的所有事件
+     * @param  name     事件类型
+     * @param  callback 事件回调函数
+     * @template K 预设的监听事件名称
+     */
+    off<K extends keyof T>(name?: K, callback?: (...args: Parameters<T[K]>) => ReturnType<T[K]>): void;
+    /**
+     * 触发事件
+     * @param  name  事件类型
+     * @param  data  触发事件的数据
+     * @returns canceled 是否被触发取消
+     * @template K 预设的监听事件名称
+     */
+    emit<K extends keyof T>(name: K, ...data: Parameters<T[K]>): boolean;
+}
+export declare namespace SubscribeMixinType {
+    interface hasListener<T extends EventMap> {
+        (name: keyof T): boolean;
+    }
+    interface on<T extends EventMap> {
+        <K extends keyof T>(name: K, callback: (...args: Parameters<T[K]>) => ReturnType<T[K]>, once?: boolean): () => void;
+    }
+    interface once<T extends EventMap> {
+        <K extends keyof T>(name: K, callback: (...args: Parameters<T[K]>) => ReturnType<T[K]>): () => void;
+    }
+    interface off<T extends EventMap> {
+        <K extends keyof T>(names?: K | K[], callback?: (...args: any[]) => any): void;
+    }
+    interface emit<T extends EventMap> {
+        <K extends keyof T>(name: K, ...data: Parameters<T[K]>): boolean;
+    }
+}

package/dist/utils/uuid.d.ts

@@ -0,0 +1,4 @@
+/**
+ * 基于伪随机数生成 **uuid**。
+ */
+export declare function uuid(): string;

package/docs/README.md

@@ -57,7 +57,7 @@ const live = createLive({
 在创建 `live` 实例时配置了两个参数：
 
 - `url`：连接 WebSocket 服务的 URL，如果在创建 `live` 实例阶段并不知道 URL ，您可以在合适的时机通过 `live.connect({ url })` 方法进行 WebScoket 连接。
-- `getTicket()`：是一个异步回调函数，其返回值是连接 WebScoket 服务的 **"门票"**，关于如何获取 `ticket` 请查阅 [VR 带看 API]()。
+- `getTicket()`：是一个异步回调函数，其返回值是连接 WebScoket 服务的 **"门票"**，关于如何获取 `ticket` 请查阅 [VR 带看 API](https://developers.realsee.com/docs/#/docs/live/server/README)。
 
 > 关于 `createLive()` 函数的更多参数配置请参考 [LiveOptions](https://unpkg.com/@realsee/live/docs/interfaces/live.LiveOptions.html) 。
 
@@ -200,7 +200,7 @@ live.on('ws.readyStateUpdate', (readyState: WebSocketState) => {
 
 - `weakNetwork(): void` 弱网提醒事件。
 
-`live.$RTC` 实例需满足 [RTC 协议]()，其事件通过 `live.$RTC.on('/*事件名*/', /*事件回调*/)` 方式来监听，比如监听语音房间内正在说话的用户及其音量：
+`live.$RTC` 实例需满足 [RTC 协议](https://unpkg.com/@realsee/live/docs/interfaces/rtc.RTCProtocol.html)，其事件通过 `live.$RTC.on('/*事件名*/', /*事件回调*/)` 方式来监听，比如监听语音房间内正在说话的用户及其音量：
 
 ```ts
 live.$RTC.on('userVolumes', (userVolumes: UserVolume[]) => {
@@ -305,8 +305,10 @@ yarn add trtc-js-sdk
 ```tsx
 import { createLive, BrowserRTC } from '@realsee/live'
 
-const rtcInstance = new VRWebViewRTC({
+const rtcInstance = new BrowserRTC({
   getVoiceSign: () => {},
+  // 可选：处理自动播放策略
+  // autoPlayConfirm: ({ onConfirm }) => showDialogThen(onConfirm)
 })
 
 const live = createLive({

package/docs/classes/BrowserRTC.md

@@ -174,7 +174,7 @@ canceled 是否被触发取消
 
 #### Defined in
 
-utils/subscribe.ts:113
+utils/subscribe.ts:115
 
 ***
 
@@ -405,7 +405,7 @@ rtc/BrowserRTC.ts:121
 
 #### Defined in
 
-rtc/BrowserRTC.ts:165
+rtc/BrowserRTC.ts:174
 
 ***
 

package/docs/classes/BrowserRTC4Chime.md

@@ -284,7 +284,7 @@ canceled 是否被触发取消
 
 #### Defined in
 
-utils/subscribe.ts:113
+utils/subscribe.ts:115
 
 ***
 

package/docs/classes/CoreRTC.md

@@ -10,7 +10,7 @@ rtc 基础抽象类
 
 ## Extends
 
-- [`Subscribe`](Subscribe.md)\<[`RTCEventType`](../type-aliases/RTCEventType.md)\>
+- `Subscribe`\<[`RTCEventType`](../type-aliases/RTCEventType.md)\>
 
 ## Extended by
 
@@ -34,7 +34,7 @@ rtc 基础抽象类
 
 #### Inherited from
 
-[`Subscribe`](Subscribe.md).[`constructor`](Subscribe.md#constructors)
+`Subscribe<RTCEventType>.constructor`
 
 ## Properties
 
@@ -158,11 +158,11 @@ canceled 是否被触发取消
 
 #### Inherited from
 
-[`Subscribe`](Subscribe.md).[`emit`](Subscribe.md#emit)
+`Subscribe.emit`
 
 #### Defined in
 
-utils/subscribe.ts:113
+utils/subscribe.ts:115
 
 ***
 
@@ -188,7 +188,7 @@ utils/subscribe.ts:113
 
 #### Inherited from
 
-[`Subscribe`](Subscribe.md).[`hasListener`](Subscribe.md#haslistener)
+`Subscribe.hasListener`
 
 #### Defined in
 
@@ -275,7 +275,7 @@ rtc/CoreRTC.ts:21
 
 #### Inherited from
 
-[`Subscribe`](Subscribe.md).[`off`](Subscribe.md#off)
+`Subscribe.off`
 
 #### Defined in
 
@@ -325,7 +325,7 @@ utils/subscribe.ts:87
 
 #### Inherited from
 
-[`Subscribe`](Subscribe.md).[`on`](Subscribe.md#on)
+`Subscribe.on`
 
 #### Defined in
 
@@ -371,7 +371,7 @@ utils/subscribe.ts:55
 
 #### Inherited from
 
-[`Subscribe`](Subscribe.md).[`once`](Subscribe.md#once)
+`Subscribe.once`
 
 #### Defined in