@realsee/live 0.4.0-beta.6 → 0.5.0-alpha.1

package/dist/live/controller.d.ts

@@ -1,43 +1,80 @@
-import { Live } from '../typings/live/Live';
-import { LiveMsg } from '../typings/live/LiveMsg';
-import { LiveOptions } from '../typings/live/LiveOptions';
-import { RoomInfo } from '../typings/live/RoomInfo';
-import { UserInfo } from '../typings/live/UserInfo';
-import { WebSocketState } from '../typings/live/WebSocket';
-export declare class LiveController<Snapshot extends Record<string, any>> {
-    readyState: WebSocketState;
-    options: LiveOptions;
-    healthCheckId?: number;
-    canSync: boolean;
-    webSocket?: WebSocket;
-    connecting: boolean;
-    selfUserInfo?: UserInfo;
-    userList?: UserInfo[];
-    roomInfo?: RoomInfo;
-    keyframes: Partial<Snapshot>;
-    constructor(options: LiveOptions);
-    /**
-     * 检测 WebSocket.readyState 状态
-     */
-    checkReadyState: (live: Live<Snapshot>) => WebSocketState;
-    onEvtOpnListener?: (evt: Event) => void;
-    onEvtMsgListener?: (evt: MessageEvent) => void;
-    onEvtErrListener?: (evt: Event) => void;
-    onEvtCLEListener?: (evt: CloseEvent) => void;
-    dispose: () => boolean;
-    /**
-     * 销毁WebSocket相关依赖。
-     */
-    disposeWebSocket: () => true | undefined;
-    /**
-     * 解析数据
-     * @param liveMsg
-     * @param live
-     */
-    handleMessage(liveMsg: LiveMsg, live: Live<Snapshot>): void;
+import { LiveMsg } from '../typings';
+import { LiveState } from '../typings/live/LiveState';
+import { Subscribe } from '../utils/subscribe';
+export declare type LiveControllerEventMap = {
+    stateChange: (state: LiveState, prevState: LiveState) => void;
+    message: (message: LiveMsg) => void;
+};
+export declare class LiveController extends Subscribe<LiveControllerEventMap> {
+    /**
+     * ws代理器
+     */
+    private _ws;
+    /**
+     * 带看连接状态
+     */
+    private _state;
+    set state(state: LiveState);
+    get state(): LiveState;
+    constructor();
+    /**
+     * 添加事件监听
+     */
+    private _addWebSocketEventListeners;
+    /**
+     * 移除事件监听
+     */
+    private _removeWebSocketEventListeners;
+    /**
+     * 处理房间关闭事件
+     * @param event
+     */
+    private _handleCloseEvent;
+    /**
+     * 连接中
+     * @param event
+     */
+    private _handleConnectingEvent;
+    /**
+     * 连接发送异常
+     * @param event
+     */
+    private _handleErrorEvent;
+    /**
+     * 接收到消息
+     * @param event
+     */
+    private _handleMessageEvent;
+    /**
+     * 连接建立成功
+     * @param event
+     */
+    private _handleOpenEvent;
+    /**
+     * 处理超时
+     * @param event
+     */
+    private _handleTimeoutEvent;
+    /**
+     * 释放资源，释放之后需要重新实例化
+     * @returns
+     */
+    dispose: () => Promise<boolean>;
+    /**
+     * 开启房间链接
+     * @param url  房间链接
+     * @returns
+     */
+    open: (url: string) => void;
+    /**
+     * 关闭房间
+     * @param code
+     * @param reason
+     */
+    close: (code?: string | number | undefined, reason?: string | undefined) => Promise<boolean>;
     /**
      * 发送数据
      * @param data
      */
-    sendMessage(data: Record<string, any>): void;
+    sendMessage(data?: any): void | undefined;
 }

package/dist/live/createLive.d.ts

@@ -1,6 +1,8 @@
-import { Live } from '../typings/live/Live';
 import { LiveOptions } from '../typings/live/LiveOptions';
+import { Live } from './live';
 /**
- * 创建 `live` 实例。
+ * 创建`Live`实例
+ * @param opts
+ * @returns
  */
-export declare function createLive<Snapshot>(options: LiveOptions): Live<Snapshot>;
+export declare const createLive: <KeyframesSnapshot>(opts: LiveOptions) => Live<KeyframesSnapshot>;

package/dist/live/createLiveReact.d.ts

@@ -1,6 +1,52 @@
-import { LiveOptions } from '../typings/live/LiveOptions';
-import { LiveReact } from '../typings/react';
+import React from 'react';
+import { BuiltinActionType, BuiltinEventType, KeyframeTypes, LiveConnectOptions, LiveEventType, LiveOptions, MicroStatus, RTCEventType, RTCType, UserInfo } from '../typings';
+import { LiveState } from '../typings/live/LiveState';
+import { Live } from './live';
+export declare type LiveProviderPropTypes<KeyframesSnapshot> = {
+    children?: React.ReactNode;
+    live?: Live<KeyframesSnapshot>;
+};
 /**
  * 创建 {@link LiveReact} 实例，并提供 `React` 技术栈相关工具链。
  */
-export declare function createLiveReact<Snapshot>(options: LiveOptions): LiveReact<Snapshot>;
+export declare function createLiveReact<KeyframesSnapshot>(options: LiveOptions): {
+    live: Live<KeyframesSnapshot>;
+    jsBridge: import("@realsee/jsbridge-x").JSBridgeProtocol;
+    LiveProvider: (props: LiveProviderPropTypes<KeyframesSnapshot>) => JSX.Element;
+    unsafe__useLiveInstance: () => Live<KeyframesSnapshot>;
+    unsafe__useRTCInstance: () => import("../typings").RTCProtocol;
+    useConnect: (options: LiveConnectOptions) => Promise<boolean | Error>;
+    useKeyframe: <K extends keyof KeyframesSnapshot>(key: K) => [frame: KeyframesSnapshot[K] | undefined, setFrame: (frame: KeyframesSnapshot[K]) => boolean | Error];
+    useKeyframeUpdateCallback: <KeyOfKeyframe extends keyof KeyframeTypes<KeyframesSnapshot>>(key: KeyOfKeyframe, callback: (...args: Parameters<KeyframeTypes<KeyframesSnapshot>[KeyOfKeyframe]>) => ReturnType<KeyframeTypes<KeyframesSnapshot>[KeyOfKeyframe]>, deps?: React.DependencyList) => () => void;
+    useLiveAction: () => {
+        connect: (options: LiveConnectOptions) => Promise<boolean | Error>;
+        broadcast: (data: Record<string, any>, toUserIds: string | string[], timeout?: any) => Promise<unknown>;
+        exit: () => Promise<boolean>;
+        kick: (toUserIds: string | string[]) => Promise<boolean>;
+        toggleMicro: (microStatus: boolean) => Promise<boolean>;
+        forbidMicro: (micro: MicroStatus, toUserIds?: string | string[]) => Promise<boolean>;
+        forbidSync: (sync: boolean, toUserIds?: string | string[]) => Promise<boolean>;
+        sendKeyframe: (key: keyof KeyframesSnapshot, frame: KeyframesSnapshot[keyof KeyframesSnapshot]) => boolean | Error;
+        getFramesByKey: (key: keyof KeyframesSnapshot) => Partial<KeyframesSnapshot>[keyof KeyframesSnapshot] | undefined;
+        setSelfInfo: (userInfo: Partial<UserInfo>) => Promise<boolean>;
+        updateStatus: (evtType: BuiltinEventType, atnType: BuiltinActionType, status: Record<string, any>, toUserIds?: string | string[]) => Promise<boolean>;
+    };
+    useLiveEventCallback: <K_1 extends keyof LiveEventType<KeyframesSnapshot>>(name: K_1, callback: (...args: Parameters<LiveEventType<KeyframesSnapshot>[K_1]>) => ReturnType<LiveEventType<KeyframesSnapshot>[K_1]>, deps?: React.DependencyList) => () => void;
+    useLiveState: () => LiveState;
+    useRTCAction: () => {
+        join: (options: {
+            voiceId: string;
+            userId: string;
+            roomId: string;
+            type: RTCType;
+        }) => Promise<boolean>;
+        quit: () => Promise<boolean>;
+        shock: () => void | undefined;
+        toggleMicro: (flag?: boolean | undefined) => Promise<boolean>;
+        detectMicro: () => Promise<boolean>;
+    };
+    useRTCEventCallback: <K_2 extends keyof RTCEventType>(name: K_2, callback: (...args: Parameters<RTCEventType[K_2]>) => ReturnType<RTCEventType[K_2]>, deps?: React.DependencyList) => () => void;
+    useSelfInfo: () => [Partial<UserInfo>, (userInfo: Partial<UserInfo>) => Promise<boolean | Error>];
+    useKeyframesSnapshot: () => Partial<KeyframesSnapshot>;
+    useUserList: () => UserInfo[];
+};

package/dist/live/live.d.ts

@@ -0,0 +1,162 @@
+import { JSBridgeProtocol } from '@realsee/jsbridge-x';
+import { RTCProtocol } from '../rtc';
+import { EventType, KeyframeTypes, LiveOptions, RoomInfo, UserInfo, BuiltinEventType, BuiltinActionType, MicroStatus, LiveConnectOptions } from '../typings';
+import { LiveState } from '../typings/live/LiveState';
+import { Subscribe } from '../utils/subscribe';
+export declare type LiveBuiltInData<KeyframesSnapshot> = {
+    selfInfo?: UserInfo;
+    userList?: UserInfo[];
+    roomInfo?: RoomInfo;
+    keyframes: Partial<KeyframesSnapshot>;
+};
+export declare const _clearLiveInstanceIfNeed: () => void;
+export declare class Live<KeyframesSnapshot extends Record<string, any>> extends Subscribe<EventType<KeyframesSnapshot>> {
+    /**
+     * 带看的配置
+     */
+    private _options;
+    get options(): LiveOptions;
+    /**
+     * 带看状态
+     */
+    get state(): LiveState;
+    /**
+     * 兼容老逻辑
+     * @deprecated 请直接读取 state 属性字段，未来将移除该属性
+     */
+    get readyState(): LiveState;
+    /**
+     * 获取当前WebSocket连接的URL。(注意：这个是WebSocket连接的完整连接，附带一些query参数)。
+     * @deprecated 带看不需要关注底层ws的相关信息，未来将移除
+     */
+    get url(): string | undefined;
+    /**
+     * 获取当前live使用的RTC实例
+     */
+    get $RTC(): RTCProtocol;
+    /**
+     * 获取当前live使用的jsBridge实例
+     */
+    get jsBridge(): JSBridgeProtocol;
+    /**
+     * 帧数据监听
+     */
+    keyframes: Subscribe<KeyframeTypes<KeyframesSnapshot>>;
+    /**
+     * 内置的一些数据
+     */
+    private _buildInData;
+    /**
+     * 当前帧数据快照
+     */
+    get snapshot(): Partial<KeyframesSnapshot>;
+    /**
+     * 根据键值取帧数据
+     * @param key 帧数据的键值
+     * @returns
+     */
+    getFramesByKey: <Key extends keyof KeyframesSnapshot>(key: Key) => Partial<KeyframesSnapshot>[Key] | undefined;
+    /**
+     * 发送帧数据（需要能够被序列化）
+     * @param key 帧数据键值
+     * @param frame 帧数据本体
+     * @returns
+     */
+    sendKeyframe: <Key extends keyof KeyframesSnapshot>(key: Key, frame: KeyframesSnapshot[Key]) => boolean | Error;
+    /**
+     * 当前用户信息
+     */
+    get selfInfo(): UserInfo | undefined;
+    /**
+     * 当前用户列表
+     */
+    get userList(): UserInfo[];
+    /**
+     * 当前带看房间信息
+     */
+    get roomInfo(): RoomInfo | undefined;
+    /**
+     * 带看控制器
+     */
+    private _controller;
+    constructor(opts: LiveOptions);
+    /**
+     * 添加带看控制的事件监听
+     */
+    private _addLiveControllerEventListeners;
+    /**
+     * 移除带看控制的事件监听
+     */
+    private _removeLiveControllerEventListeners;
+    /**
+     * 带看状态变化
+     * @param state
+     * @returns
+     */
+    private _handleStateChange;
+    private _handleMessage;
+    /**
+     * 清理带看缓存的数据
+     */
+    private _clearLiveData;
+    /**
+     * 连接带看
+     * @param options
+     * @returns
+     */
+    connect: (options?: LiveConnectOptions) => Promise<boolean | Error>;
+    /**
+     * 退出带看
+     * @returns
+     */
+    exit: () => Promise<boolean>;
+    /**
+     * 销毁带看
+     * @returns
+     */
+    dispose: () => Promise<boolean>;
+    /**
+     * 修改状态
+     * @param evtType
+     * @param atnType
+     * @param status
+     * @param toUserIds
+     * @returns
+     */
+    updateStatus(evtType: BuiltinEventType, atnType: BuiltinActionType, status: Record<string, any>, toUserIds?: string | string[]): Promise<boolean>;
+    /**
+     * 设置自己的用户信息
+     * @param userInfo
+     * @returns
+     */
+    setSelfInfo: (userInfo: Partial<UserInfo>) => Promise<boolean>;
+    /**
+     * 自定义广播
+     * @param request 广播请求的数据
+     * @param toUserIds
+     * @param timeout
+     * @returns
+     */
+    broadcast<Request, Response>(request: Request, toUserIds: string | string[], timeout: number): Promise<Response> | Error | false;
+    toggleMicro: (microStatus: boolean) => Promise<boolean>;
+    /**
+     * 控制别人的麦
+     * @param microStatus
+     * @param toUserIds
+     * @returns
+     */
+    forbidMicro: (microStatus: MicroStatus, toUserIds: string | string[]) => Promise<boolean>;
+    /**
+     * 控制别人的同步全量帧数据权限
+     * @param sync
+     * @param toUserIds
+     * @returns
+     */
+    forbidSync: (sync: boolean, toUserIds: string | string[]) => Promise<boolean>;
+    /**
+     * 把用户踢出带看
+     * @param toUserIds
+     * @returns
+     */
+    kick: (toUserIds: string | string[]) => Promise<boolean>;
+}