@realsee/live 0.3.0-alpha.4 → 0.4.0-alpha.3

package/{lib/createLiveReact.d.ts → dist/typings/react/LiveReact.d.ts}

@@ -1,160 +1,162 @@
-import * as React from 'react';
-import { RTCActionReactCallback, RTCProtocol } from './typings/RTCProtocol';
-import { KeyframeTypes, LiveEventType, WebSocketEventType } from './typings/EventType';
-import { Live, LiveActionReactCallback } from './typings/Live';
-import { LiveOptions } from './typings/LiveOptions';
-import { RTCEventType } from './typings/RTCEventType';
-import { UserInfo } from './typings/UserInfo';
-import { WebSocketState } from './typings/WebSocket';
-export declare type LiveProviderPropTypes<Snapshot> = {
-    children?: React.ReactNode;
-    live?: Live<Snapshot>;
-};
-/**
- * 创建 {@link LiveReact} 实例，并提供 `React` 技术栈相关工具链。
- */
-export declare function createLiveReact<Snapshot>(options: LiveOptions): LiveReact<Snapshot>;
-/**
- * @example
- *
- * 新建文件`LiveReact.ts` 创建一个 {@link LiveReact} 实例对象:
- *
- * ```js
- * import { createLiveReact } from '@realsee/live'
- * const LiveReact = createLiveReact({ getTicket: async () => '' })
- * export default LiveReact
- * ```
- *
- *
- */
-export interface LiveReact</* 帧数据 */ Snapshot> {
-    live: Live<Snapshot>;
-    /**
-     * @description **LiveProvider** 基于 [React Context](https://reactjs.org/docs/context.html) 对 {@link Live }进行封装，你可以以 [React Hooks](https://reactjs.org/docs/hooks-intro.html) 的方式对 {@link Live } 实例进行操作、数据监听等。
-     *
-     * 在 `React` 环境中使用 {@link LiveReact.LiveProvider} 组件:
-     *
-     * ```ts
-     * import { LiveProvider } from './LiveReact'
-     * ReactDOM.render(<LiveProvider><App></LiveProvider>, containter)
-     * ```
-     */
-    LiveProvider: (props: LiveProviderPropTypes<Snapshot>) => JSX.Element;
-    /**
-     * @deprecated 获取 `live` 实例，**不鼓励使用**
-     */
-    unsafe__useLiveInstance: () => Live<Snapshot>;
-    /**
-     * @deprecated 获取 `RTC` 实例，**不鼓励使用**
-     */
-    unsafe__useRTCInstance: () => RTCProtocol;
-    /**
-     *
-     * @description 获取当前 WebSocket 连接的 URL，如果尚未创建 WebSocket 实例，则值为 `undefined`。
-     * 如果有重连等事件发生 URL 值会发生更新。
-     *
-     * ```ts
-     * import { useCurrentWebSocketUrl } from './LiveReact'
-     * function ReactComponent() {
-     *   const url = useCurrentWebSocketUrl()
-     *   return <div>当前URL: {url}.</div>
-     * }
-     * ```
-     */
-    useCurrentWebSocketUrl: () => string | undefined;
-    /**
-     * @description 连接 WebSocket 服务。如果 WebSocket 已经连接则什么都不做，若提供 `{force: true}` 则会强制重连。
-     *
-     *
-     * ```jsx
-     * import { useConnect } from './LiveReact'
-     * function ReactComponent() {
-     *   const connect = useConnect()
-     *   return <button onClick={() => connect()}>点击连接</button>
-     * }
-     * ```
-     *
-     */
-    useConnect: () => (options?: {
-        force?: boolean;
-        url?: string;
-        getTicket?: () => Promise<string>;
-    }) => Promise<boolean | Error>;
-    /**
-     *
-     * @description 帧数据状态值。如果执行 `setKeyframe()` 则会传递 WebSocket 帧同步指令；若通过 WebSocket 收到新帧数据则会更新当前状态值。
-     *
-     * ```typescript
-     * function LocalFiveState() {
-     *   const [keyframe, setKeyframe] = LiveReact.useKeyframe('five')
-     *   return (<div>{JSON.stringify(keyframe)}</div>)
-     * }
-     * ```
-     */
-    useKeyframe: <K extends keyof Snapshot>(frameName: K) => [frame: Snapshot[K] | undefined, setFrame: (frame: Snapshot[K]) => boolean | Error];
-    /**
-     *
-     */
-    useKeyframeUpdateCallback: <K extends keyof KeyframeTypes<Snapshot>>(name: K, callback: (...args: Parameters<KeyframeTypes<Snapshot>[K]>) => ReturnType<KeyframeTypes<Snapshot>[K]>, deps?: React.DependencyList) => () => void;
-    /**
-     *
-     * @function broadcast 广播消息，详见 {@link Live.broadcast}。
-     * @function exit 退出带看，详见 {@link Live.exit}。
-     * @function kick 踢出带看，详见 {@link Live.kick}。
-     * @function toggleMicro 打开/关闭自己的麦克风，详见 {@link Live.toggleMicro}。
-     * @function forbidMicro 禁止麦克风，详见 {@link Live.forbidMicro}。
-     * @function sendKeyframe 发送帧数据，详见 {@link Live.sendKeyframe}。
-     * @function getFramesByKey 根据`key`从帧快照中获取某条帧数据，详见 {@link Live.getFramesByKey}。
-     * @function setSelfInfo 设置当前用户信息，详见 {@link Live.setSelfInfo}。
-     * @function updateStatus 更新用户或房间状态，详见 {@link Live.updateStatus}。
-     *
-     * @description 提供一些函数直接调用。
-     *
-     * ```ts
-     * function ReactComponent() {
-     *   const { exit } = useLiveAction()
-     *   return (<button onClick={() => exit()}>退出带看</button>)
-     * }
-     * ```
-     */
-    useLiveAction: () => LiveActionReactCallback<Snapshot>;
-    /**
-     * 监听带看相关的异步 Hooks 事件。详情见 {@link LiveEventType}。
-     */
-    useLiveEventCallback: <K extends keyof LiveEventType<Snapshot>>(name: K, callback: (...args: Parameters<LiveEventType<Snapshot>[K]>) => ReturnType<LiveEventType<Snapshot>[K]>, deps?: React.DependencyList) => () => void;
-    /**
-     * 获取当前 WebSocket 状态 {@link WebSocketState}。
-     */
-    useReadyState: () => WebSocketState;
-    /**
-     * RTC 函数。
-     */
-    useRTCAction: () => RTCActionReactCallback;
-    /**
-     * RTC 事件回调监听。
-     */
-    useRTCEventCallback: <K extends keyof RTCEventType>(name: K, callback: (...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>, deps?: React.DependencyList) => () => void;
-    /**
-     * 获取\更改 当前用户信息。
-     * ```
-     * const [userInfo, setUserInfo] = useSelfInfo()
-     * ```
-     */
-    useSelfInfo: () => [Partial<UserInfo>, (userInfo: Partial<UserInfo>) => Promise<boolean | Error>];
-    /**
-     * 当前帧数据快照。
-     */
-    useSnapshot: () => Partial<Snapshot> | undefined;
-    /**
-     * 获取房间用户列表。
-     *
-     * ```
-     * const userList = useUserList()
-     * ```
-     */
-    useUserList: () => UserInfo[] | undefined;
-    /**
-     * WebSocket 异步事件回调监听。
-     */
-    useWebSocketEventCallback: <K extends keyof WebSocketEventType>(name: K, callback: (...args: Parameters<WebSocketEventType[K]>) => ReturnType<WebSocketEventType[K]>, deps?: React.DependencyList) => () => void;
-}
+import React from 'react';
+import { KeyframeTypes, LiveEventType, WebSocketEventType } from '../live/EventType';
+import { Live, LiveActionReactCallback } from '../live/Live';
+import { UserInfo } from '../live/UserInfo';
+import { WebSocketState } from '../live/WebSocket';
+import { RTCEventType } from '../rtc/eventType';
+import { RTCProtocol } from '../rtc/protocol';
+import { RTCActionReactCallback } from './RTCActionReactCallback';
+export declare type LiveProviderPropTypes<Snapshot> = {
+    children?: React.ReactNode;
+    live?: Live<Snapshot>;
+};
+/**
+ * @example
+ *
+ * 新建文件`LiveReact.ts` 创建一个 {@link LiveReact} 实例对象:
+ *
+ * ```js
+ * import { createLiveReact } from '@realsee/live'
+ * const LiveReact = createLiveReact({ getTicket: async () => '' })
+ * export default LiveReact
+ * ```
+ *
+ *
+ */
+export interface LiveReact</* 帧数据 */ Snapshot> {
+    live: Live<Snapshot>;
+    /**
+     * @description **LiveProvider** 基于 [React Context](https://reactjs.org/docs/context.html) 对 {@link Live }进行封装，你可以以 [React Hooks](https://reactjs.org/docs/hooks-intro.html) 的方式对 {@link Live } 实例进行操作、数据监听等。
+     *
+     * 在 `React` 环境中使用 {@link LiveReact.LiveProvider} 组件:
+     *
+     * ```ts
+     * import { LiveProvider } from './LiveReact'
+     * ReactDOM.render(<LiveProvider><App></LiveProvider>, containter)
+     * ```
+     */
+    LiveProvider: (props: LiveProviderPropTypes<Snapshot>) => JSX.Element;
+    /**
+     * @deprecated 获取 `live` 实例，**不鼓励使用**
+     */
+    unsafe__useLiveInstance: () => Live<Snapshot>;
+    /**
+     * @deprecated 获取 `RTC` 实例，**不鼓励使用**
+     */
+    unsafe__useRTCInstance: () => RTCProtocol;
+    /**
+     *
+     * @description 获取当前 WebSocket 连接的 URL，如果尚未创建 WebSocket 实例，则值为 `undefined`。
+     * 如果有重连等事件发生 URL 值会发生更新。
+     *
+     * ```ts
+     * import { useCurrentWebSocketUrl } from './LiveReact'
+     * function ReactComponent() {
+     *   const url = useCurrentWebSocketUrl()
+     *   return <div>当前URL: {url}.</div>
+     * }
+     * ```
+     */
+    useCurrentWebSocketUrl: () => string | undefined;
+    /**
+     * @description 连接 WebSocket 服务。如果 WebSocket 已经连接则什么都不做，若提供 `{force: true}` 则会强制重连。
+     *
+     *
+     * ```jsx
+     * import { useConnect } from './LiveReact'
+     * function ReactComponent() {
+     *   const connect = useConnect()
+     *   return <button onClick={() => connect()}>点击连接</button>
+     * }
+     * ```
+     *
+     */
+    useConnect: () => (options?: {
+        force?: boolean;
+        url?: string;
+        getTicket?: () => Promise<string>;
+    }) => Promise<boolean | Error>;
+    /**
+     *
+     * @description 帧数据状态值。如果执行 `setKeyframe()` 则会传递 WebSocket 帧同步指令；若通过 WebSocket 收到新帧数据则会更新当前状态值。
+     *
+     * ```typescript
+     * function LocalFiveState() {
+     *   const [keyframe, setKeyframe] = LiveReact.useKeyframe('five')
+     *   return (<div>{JSON.stringify(keyframe)}</div>)
+     * }
+     * ```
+     */
+    useKeyframe: <K extends keyof Snapshot>(frameName: K) => [
+        frame: Snapshot[K] | undefined,
+        setFrame: (frame: Snapshot[K]) => boolean | Error
+    ];
+    /**
+     *
+     */
+    useKeyframeUpdateCallback: <K extends keyof KeyframeTypes<Snapshot>>(name: K, callback: (...args: Parameters<KeyframeTypes<Snapshot>[K]>) => ReturnType<KeyframeTypes<Snapshot>[K]>, deps?: React.DependencyList) => () => void;
+    /**
+     *
+     * @function broadcast 广播消息，详见 {@link Live.broadcast}。
+     * @function exit 退出带看，详见 {@link Live.exit}。
+     * @function kick 踢出带看，详见 {@link Live.kick}。
+     * @function toggleMicro 打开/关闭自己的麦克风，详见 {@link Live.toggleMicro}。
+     * @function forbidMicro 禁止麦克风，详见 {@link Live.forbidMicro}。
+     * @function sendKeyframe 发送帧数据，详见 {@link Live.sendKeyframe}。
+     * @function getFramesByKey 根据`key`从帧快照中获取某条帧数据，详见 {@link Live.getFramesByKey}。
+     * @function setSelfInfo 设置当前用户信息，详见 {@link Live.setSelfInfo}。
+     * @function updateStatus 更新用户或房间状态，详见 {@link Live.updateStatus}。
+     *
+     * @description 提供一些函数直接调用。
+     *
+     * ```ts
+     * function ReactComponent() {
+     *   const { exit } = useLiveAction()
+     *   return (<button onClick={() => exit()}>退出带看</button>)
+     * }
+     * ```
+     */
+    useLiveAction: () => LiveActionReactCallback<Snapshot>;
+    /**
+     * 监听带看相关的异步 Hooks 事件。详情见 {@link LiveEventType}。
+     */
+    useLiveEventCallback: <K extends keyof LiveEventType<Snapshot>>(name: K, callback: (...args: Parameters<LiveEventType<Snapshot>[K]>) => ReturnType<LiveEventType<Snapshot>[K]>, deps?: React.DependencyList) => () => void;
+    /**
+     * 获取当前 WebSocket 状态 {@link WebSocketState}。
+     */
+    useReadyState: () => WebSocketState;
+    /**
+     * RTC 函数。
+     */
+    useRTCAction: () => RTCActionReactCallback;
+    /**
+     * RTC 事件回调监听。
+     */
+    useRTCEventCallback: <K extends keyof RTCEventType>(name: K, callback: (...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>, deps?: React.DependencyList) => () => void;
+    /**
+     * 获取\更改 当前用户信息。
+     * ```
+     * const [userInfo, setUserInfo] = useSelfInfo()
+     * ```
+     */
+    useSelfInfo: () => [
+        Partial<UserInfo>,
+        (userInfo: Partial<UserInfo>) => Promise<boolean | Error>
+    ];
+    /**
+     * 当前帧数据快照。
+     */
+    useSnapshot: () => Partial<Snapshot> | undefined;
+    /**
+     * 获取房间用户列表。
+     *
+     * ```
+     * const userList = useUserList()
+     * ```
+     */
+    useUserList: () => UserInfo[] | undefined;
+    /**
+     * WebSocket 异步事件回调监听。
+     */
+    useWebSocketEventCallback: <K extends keyof WebSocketEventType>(name: K, callback: (...args: Parameters<WebSocketEventType[K]>) => ReturnType<WebSocketEventType[K]>, deps?: React.DependencyList) => () => void;
+}

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

@@ -0,0 +1,2 @@
+import { RTCProtocol } from '../rtc/protocol';
+export declare type RTCActionReactCallback = Pick<RTCProtocol, 'join' | 'quit' | 'shock' | 'toggleMicro' | 'detectMicro'>;

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

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

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

@@ -0,0 +1,6 @@
+import { JSBridgeProtocol } from '@realsee/jsbridge-x';
+import { GetVoiceSign } from '../live/GetVoiceSign';
+export interface VRWebViewRTCOptions {
+    jsBridge: JSBridgeProtocol;
+    getVoiceSign: GetVoiceSign;
+}

package/{lib/typings/RTCEventType.d.ts → dist/typings/rtc/eventType.d.ts}

@@ -1,35 +1,29 @@
-import { RTCJoinedInfo } from "./RTCJoinedInfo";
-/**
- * 用户的音量信息。
- */
-export declare type UserVolume = {
-    userId: string;
-    audioVolume: number;
-};
-/**
- * RTC 异步事件类型。
- */
-export declare type RTCEventType = {
-    /**
-     * 错误\异常
-     * @param error
-     */
-    'error'(error: Error | RTCJoinedInfo): void;
-    /**
-     * 即将加入房间。
-     */
-    'joinWillStart'(): void;
-    /**
-     * 成功加入语音房间。
-     */
-    'joined'(): void;
-    /**
-     * 弱网提醒事件。
-     */
-    'weakNetwork'(): void;
-    /**
-     * 每个用户的音量。
-     * @param userVolumes
-     */
-    'userVolumes'(userVolumes: UserVolume[]): void;
-};
+import { UserVolume } from '../live/UserVolume';
+import { RTCJoinedInfo } from './joinedInfo';
+/**
+ * RTC 异步事件类型。
+ */
+export declare type RTCEventType = {
+    /**
+     * 错误\异常
+     * @param error
+     */
+    'error'(error: Error | RTCJoinedInfo): void;
+    /**
+     * 即将加入房间。
+     */
+    'joinWillStart'(): void;
+    /**
+     * 成功加入语音房间。
+     */
+    'joined'(): void;
+    /**
+     * 弱网提醒事件。
+     */
+    'weakNetwork'(): void;
+    /**
+     * 每个用户的音量。
+     * @param userVolumes
+     */
+    'userVolumes'(userVolumes: UserVolume[]): void;
+};

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

@@ -0,0 +1,5 @@
+export * from './VRWebViewRTCOptions';
+export * from './eventType';
+export * from './joinedInfo';
+export * from './protocol';
+export * from './type';

package/{lib/typings/RTCJoinedInfo.d.ts → dist/typings/rtc/joinedInfo.d.ts}

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

package/{lib/typings/RTCProtocol.d.ts → dist/typings/rtc/protocol.d.ts}

@@ -1,42 +1,53 @@
-import { Subscribe } from '../shared-utils/Subscribe';
-import { RTCEventType } from './RTCEventType';
-export declare enum RTCType {
-    realsee = "realsee",
-    custom = "custom"
-}
-export interface RTCProtocol extends Subscribe<RTCEventType> {
-    joined: boolean;
-    micro: boolean;
-    voiceId: string;
-    type: RTCType;
-    /**
-     * 加入房间。
-     * @param voiceId (又称呼`roomId`)，当前语音房间Id。
-     * @returns
-     */
-    join(options: {
-        voiceId: string;
-        userId: string;
-        roomId: string | number | undefined;
-        type: RTCType;
-    }): Promise<boolean>;
-    /**
-     * 离开房间。
-     * @returns
-     */
-    quit(): Promise<boolean>;
-    /**
-     * 监测麦克风授权。
-     * @returns
-     */
-    detectMicro(): Promise<boolean>;
-    /**
-     * 关闭\开启 本地麦克风。
-     */
-    toggleMicro(flag?: boolean): Promise<boolean>;
-    /**
-     * 震动。
-     */
-    shock(): void;
-}
-export declare type RTCActionReactCallback = Pick<RTCProtocol, 'join' | 'quit' | 'shock' | 'toggleMicro' | 'detectMicro'>;
+import { Subscribe } from '../../utils/subscribe';
+import { RTCEventType } from './eventType';
+import { RTCType } from './type';
+/**
+ * rtc 协议接口
+ */
+export interface RTCProtocol extends Subscribe<RTCEventType> {
+    /**
+     * 是否已经加入房间
+     */
+    joined: boolean;
+    /**
+     * 麦克风状态
+     */
+    micro: boolean;
+    /**
+     * 语音房间ID
+     */
+    voiceId: string;
+    /**
+     * rtc 实现类型
+     */
+    type: RTCType;
+    /**
+     * 加入房间。
+     * @param voiceId (又称呼`roomId`)，当前语音房间Id。
+     * @returns
+     */
+    join(options: {
+        voiceId: string;
+        userId: string;
+        roomId: string | number | undefined;
+        type: RTCType;
+    }): Promise<boolean>;
+    /**
+     * 离开房间。
+     * @returns
+     */
+    quit(): Promise<boolean>;
+    /**
+     * 监测麦克风授权。
+     * @returns
+     */
+    detectMicro(): Promise<boolean>;
+    /**
+     * 关闭\开启 本地麦克风。
+     */
+    toggleMicro(flag?: boolean): Promise<boolean>;
+    /**
+     * 震动。
+     */
+    shock?(): void;
+}

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

@@ -0,0 +1,8 @@
+/**
+ * rtc 类型
+ */
+export declare enum RTCType {
+    RealseeBrowserRTC = "RealseeBrowserRTC",
+    RealseeVRWebViewRTC = "RealseeVRWebViewRTC",
+    RealseeBrowserChimeRTC = "RealseeBrowserChimeRTC"
+}

package/{lib/shared-utils → dist/utils}/appendUri.d.ts

@@ -1 +1 @@
-export declare function appendUri(uri: string, query?: Record<string, string | number>): string;
+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/{lib/shared-utils → dist/utils}/equal.d.ts

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