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

package/{lib/typings → dist/typings/live}/Live.d.ts

@@ -1,122 +1,123 @@
-import { UserInfo } from './UserInfo';
-import { LiveOptions } from './LiveOptions';
-import { EventType, KeyframeTypes } from './EventType';
-import { WebSocketState } from './WebSocket';
-import { RTCProtocol } from '../typings/RTCProtocol';
-import { Subscribe } from '../shared-utils/Subscribe';
-import { BuiltinActionType, BuiltinEventType, MicroStatus } from './LiveMsg';
-/**
- * Live 实例。
- */
-export interface Live<Snapshot extends Record<string, any>> extends Subscribe<EventType<Snapshot>> {
-    get options(): LiveOptions;
-    /**
-     * 更新本地用户信息
-     * @param userInfo
-     */
-    setSelfInfo(userInfo: Partial<UserInfo>): Promise<boolean | Error>;
-    /**
-     * 获取本地用户信息
-     */
-    get selfInfo(): UserInfo | undefined;
-    /**
-     * 获取当前WebSocket的连接状态。
-     */
-    get readyState(): WebSocketState;
-    /**
-     * 获取当前会话房间内用户列表。
-     */
-    get userList(): UserInfo[];
-    /**
-     * 获取当前帧数据快照。
-     */
-    get snapshot(): Partial<Snapshot>;
-    /**
-     * 获取当前WebSocket连接的URL。(注意：这个是WebSocket连接的完整连接，附带一些query参数)。
-     */
-    get url(): string;
-    /**
-     * 获取RTC实例。一个RTC实例的引用，等同于live.options.rtc。
-     */
-    get $RTC(): RTCProtocol;
-    /**
-     * 帧数据监听
-     */
-    keyframes: Subscribe<KeyframeTypes<Snapshot>>;
-    /**
-     * 根据某条 key 获取某条帧数据
-     * @param keys
-     * @returns 帧数据
-     */
-    getFramesByKey<Key extends keyof Snapshot>(key: Key): Partial<Snapshot>[Key] | undefined;
-    /**
-     * 发送帧数据
-     * @param key
-     * @param frame
-     * @returns
-     */
-    sendKeyframe<Key extends keyof Snapshot>(key: Key, frame: Snapshot[Key]): boolean | Error;
-    /**
-     * 自定义广播事件
-     * @param data 广播数据：这个数据需要自定义格式，此处不做任何约束。
-     * @param toUserIds 希望收到此广播事件的用户，为空时则向所有用户广播。
-     * @param timeout 等待广播结果的超时设置；默认为"0"，表示一直等结果。
-     * @returns
-     */
-    broadcast<T1, T2>(data: T1, toUserIds: string | string[], timeout: number): Promise<T2> | Error;
-    /**
-     * 更新用户或房间状态。
-     * @param evtType 事件枚举
-     * @param atnType 行为枚举
-     * @param status 状态值
-     * @param toUserIds 面向的用户。
-     */
-    updateStatus(evtType: BuiltinEventType, atnType: BuiltinActionType, status: Record<string, any>, toUserIds?: string | string[]): Promise<boolean>;
-    /**
-     * 执行WebSocket连接
-     * @param force 为true时则强制重连
-     * @returns
-     */
-    connect(options?: {
-        url?: string;
-        force?: boolean;
-    }): Promise<boolean | Error>;
-    /**
-     * 开启/关闭自己的麦克风
-     * @param microStatus true 开启麦克风；false 关闭麦克风
-     * @return
-     * */
-    toggleMicro(microStatus: boolean): Promise<boolean>;
-    /**
-     * 关闭/开启某个或某些用户的麦克风
-     * @param micro true 开启麦克风；false 关闭麦克风
-     * @param toUserIds 希望关闭/开启麦克风的用户，为空时则面向所有用户。
-     * @returns
-     */
-    forbidMicro(micro: MicroStatus, toUserIds?: string[] | string): Promise<boolean>;
-    /**
-     * 限制/开启某个或某些用户同步帧数据
-     * @param sync true 开启同步；false 限制同步
-     * @param toUserIds 希望限制/开启同步能力的用户，为空时则面向所有用户。
-     * @deprecated 暂不支持
-     * @returns
-     *
-     */
-    forbidSync(sync: boolean, toUserIds?: string[] | string): Promise<boolean>;
-    /**
-     * "踢人"：强制让某个用户离开附近。
-     * @param toUserIds 被"踢"的用户。
-     * @returns
-     */
-    kick(toUserIds: string[] | string): Promise<boolean>;
-    /**
-     * 退出带看
-     * @returns
-     */
-    exit(): Promise<boolean>;
-    /**
-     * 废弃掉当前实例依赖。
-     */
-    revoke(): Promise<boolean>;
-}
-export declare type LiveActionReactCallback<Snapshot extends Record<string, any>> = Pick<Live<Snapshot>, 'broadcast' | 'exit' | 'kick' | 'toggleMicro' | 'forbidMicro' | 'sendKeyframe' | 'getFramesByKey' | 'setSelfInfo' | 'updateStatus'>;
+import { UserInfo } from './UserInfo';
+import { LiveOptions } from './LiveOptions';
+import { EventType, KeyframeTypes } from './EventType';
+import { WebSocketState } from './WebSocket';
+import { BuiltinActionType, BuiltinEventType, MicroStatus } from './LiveMsg';
+import { Subscribe } from '../../utils/subscribe';
+import { RTCProtocol } from '../rtc/protocol';
+/**
+ * Live 实例。
+ */
+export interface Live<Snapshot extends Record<string, any>> extends Subscribe<EventType<Snapshot>> {
+    get options(): LiveOptions;
+    /**
+     * 更新本地用户信息
+     * @param userInfo
+     */
+    setSelfInfo(userInfo: Partial<UserInfo>): Promise<boolean | Error>;
+    /**
+     * 获取本地用户信息
+     */
+    get selfInfo(): UserInfo | undefined;
+    /**
+     * 获取当前WebSocket的连接状态。
+     * @deprecated 带看不需要关注底层ws的状态，未来将移除
+     */
+    get readyState(): WebSocketState;
+    /**
+     * 获取当前会话房间内用户列表。
+     */
+    get userList(): UserInfo[];
+    /**
+     * 获取当前帧数据快照。
+     */
+    get snapshot(): Partial<Snapshot>;
+    /**
+     * 获取当前WebSocket连接的URL。(注意：这个是WebSocket连接的完整连接，附带一些query参数)。
+     * @deprecated 带看不需要关注底层ws的相关信息，未来将移除
+     */
+    get url(): string;
+    /**
+     * 获取RTC实例。一个RTC实例的引用，等同于live.options.rtc。
+     */
+    get $RTC(): RTCProtocol;
+    /**
+     * 帧数据监听
+     */
+    keyframes: Subscribe<KeyframeTypes<Snapshot>>;
+    /**
+     * 根据某条 key 获取某条帧数据
+     * @param keys
+     * @returns 帧数据
+     */
+    getFramesByKey<Key extends keyof Snapshot>(key: Key): Partial<Snapshot>[Key] | undefined;
+    /**
+     * 发送帧数据
+     * @param key
+     * @param frame
+     * @returns
+     */
+    sendKeyframe<Key extends keyof Snapshot>(key: Key, frame: Snapshot[Key]): boolean | Error;
+    /**
+     * 自定义广播事件
+     * @param data 广播数据：这个数据需要自定义格式，此处不做任何约束。
+     * @param toUserIds 希望收到此广播事件的用户，为空时则向所有用户广播。
+     * @param timeout 等待广播结果的超时设置；默认为"0"，表示一直等结果。
+     * @returns
+     */
+    broadcast<D, R>(data: D, toUserIds: string | string[], timeout: number): Promise<R> | Error;
+    /**
+     * 更新用户或房间状态。
+     * @param eventType 事件枚举
+     * @param actionType 行为枚举
+     * @param status 状态值
+     * @param toUserIds 面向的用户。
+     */
+    updateStatus(eventType: BuiltinEventType, actionType: BuiltinActionType, status: Record<string, any>, toUserIds?: string | string[]): Promise<boolean>;
+    /**
+     * 执行WebSocket连接
+     * @param force 为true时则强制重连
+     * @returns
+     */
+    connect(options?: {
+        url?: string;
+        force?: boolean;
+    }): Promise<boolean | Error>;
+    /**
+     * 开启/关闭自己的麦克风
+     * @param microStatus true 开启麦克风；false 关闭麦克风
+     * @return
+     * */
+    toggleMicro(microStatus: boolean): Promise<boolean>;
+    /**
+     * 关闭/开启某个或某些用户的麦克风
+     * @param micro true 开启麦克风；false 关闭麦克风
+     * @param toUserIds 希望关闭/开启麦克风的用户，为空时则面向所有用户。
+     * @returns
+     */
+    forbidMicro(micro: MicroStatus, toUserIds?: string[] | string): Promise<boolean>;
+    /**
+     * 限制/开启某个或某些用户同步帧数据
+     * @param sync true 开启同步；false 限制同步
+     * @param toUserIds 希望限制/开启同步能力的用户，为空时则面向所有用户。
+     * @deprecated 暂不支持
+     * @returns
+     *
+     */
+    /**
+     * "踢人"：强制让某个用户离开附近。
+     * @param toUserIds 被"踢"的用户。
+     * @returns
+     */
+    kick(toUserIds: string[] | string): Promise<boolean>;
+    /**
+     * 退出带看
+     * @returns
+     */
+    exit(): Promise<boolean>;
+    /**
+     * 废弃掉当前实例依赖。
+     */
+    revoke(): Promise<boolean>;
+}
+export declare type LiveActionReactCallback<Snapshot extends Record<string, any>> = Pick<Live<Snapshot>, 'broadcast' | 'exit' | 'kick' | 'toggleMicro' | 'forbidMicro' | 'sendKeyframe' | 'getFramesByKey' | 'setSelfInfo' | 'updateStatus'>;

package/{lib/typings → dist/typings/live}/LiveMsg.d.ts

@@ -1,119 +1,119 @@
-/**
- * WebSocket 通信指令
- * - 下行：服务端推送数据
- * - 上行：客户端上报数据
- */
-export declare enum Command {
-    SelfUserInfo = "SELF_USER_INFO",
-    RoomInfo = "ROOM_INFO",
-    RTCInfo = "RTC_INFO",
-    UserList = "USER_LIST",
-    BuiltinMsg = "BUILTIN_MSG",
-    CustomEvent = "CUSTOM_EVENT",
-    KeyframeSync = "KEYFRAME_SYNC",
-    UserKickOut = "USER_KICK_OUT"
-}
-/**
- * 向服务端请求数据时的数据格式。
- */
-export declare type ReqLiveMsg = {
-    /**
-     * 请求指令。
-     */
-    command: Command;
-    /**
-     * 前端请求时生成的uuid()。
-     */
-    front_request_id: string;
-    /**
-     * 数据内容
-     */
-    data: {
-        /**
-         * 如果此数据仅发送给某些用户，请提供这些用户的ucid。
-         */
-        to_user_ids?: string[];
-        [key: string]: any;
-    };
-};
-/**
- * 内置事件类型。
- */
-export declare enum BuiltinEventType {
-    /**
-     * 变更用户状态。
-     */
-    UserChange = "user_change",
-    /**
-     * 变更房间状态。
-     */
-    RoomChange = "room_change"
-}
-/**
- * 内置事件行为类型。
- */
-export declare enum BuiltinActionType {
-    /**
-     * 修改麦克风状态。
-     */
-    UserMicroStatus = "change_micro_status",
-    /**
-     * 同步当前用户状态：客户端麦克风状态已经修改成功，通知服务端
-     */
-    UserMicroStatusSync = "sync_micro_status",
-    /**
-     * 调整某些用户的权限。
-     */
-    UserPermission = "change_permission",
-    /**
-     * 用户状态发生改变。
-     */
-    UserStatus = "change_status",
-    /**
-     * 更新用户信息。
-     */
-    UserInfo = "change_info",
-    /**
-     * 关闭房间。
-     */
-    RoomClose = "close"
-}
-/**
- * 内置事件数据结构体。
- */
-export declare type BuiltinMsg = {
-    event_type: BuiltinEventType;
-    action: BuiltinActionType;
-    to_user_ids: string[];
-    data: {
-        extension?: Record<string, any>;
-        [key: string]: any;
-    };
-};
-/**
- * 麦克风状态。
- */
-export declare enum MicroStatus {
-    OPEN = "OPEN",
-    CLOSE = "CLOSE"
-}
-/**
- * 响应的信息结构体。
- */
-export declare type LiveMsg = {
-    code: string;
-    message: string;
-    command: Command;
-    roomCode: string;
-    appId: string;
-    requestId: string;
-    frontRequestId: string;
-    triggerUserId: string;
-    data: Record<string, any> | Record<string, any>[];
-};
-/**
- * 解析下后端数据格式。
- * @param jsonTxt - JSON序列化后的文本。
- * @returns false 标识解析失败；解析成功返回 {@link LiveMsg} 实例。
- */
-export declare function parseLiveMsg(jsonTxt: string): LiveMsg | boolean;
+/**
+ * WebSocket 通信指令
+ * - 下行：服务端推送数据
+ * - 上行：客户端上报数据
+ */
+export declare enum Command {
+    SelfUserInfo = "SELF_USER_INFO",
+    RoomInfo = "ROOM_INFO",
+    RTCInfo = "RTC_INFO",
+    UserList = "USER_LIST",
+    BuiltinMsg = "BUILTIN_MSG",
+    CustomEvent = "CUSTOM_EVENT",
+    KeyframeSync = "KEYFRAME_SYNC",
+    UserKickOut = "USER_KICK_OUT"
+}
+/**
+ * 向服务端请求数据时的数据格式。
+ */
+export declare type ReqLiveMsg = {
+    /**
+     * 请求指令。
+     */
+    command: Command;
+    /**
+     * 前端请求时生成的uuid()。
+     */
+    front_request_id: string;
+    /**
+     * 数据内容
+     */
+    data: {
+        /**
+         * 如果此数据仅发送给某些用户，请提供这些用户的ucid。
+         */
+        to_user_ids?: string[];
+        [key: string]: any;
+    };
+};
+/**
+ * 内置事件类型。
+ */
+export declare enum BuiltinEventType {
+    /**
+     * 变更用户状态。
+     */
+    UserChange = "user_change",
+    /**
+     * 变更房间状态。
+     */
+    RoomChange = "room_change"
+}
+/**
+ * 内置事件行为类型。
+ */
+export declare enum BuiltinActionType {
+    /**
+     * 修改麦克风状态。
+     */
+    UserMicroStatus = "change_micro_status",
+    /**
+     * 同步当前用户状态：客户端麦克风状态已经修改成功，通知服务端
+     */
+    UserMicroStatusSync = "sync_micro_status",
+    /**
+     * 调整某些用户的权限。
+     */
+    UserPermission = "change_permission",
+    /**
+     * 用户状态发生改变。
+     */
+    UserStatus = "change_status",
+    /**
+     * 更新用户信息。
+     */
+    UserInfo = "change_info",
+    /**
+     * 关闭房间。
+     */
+    RoomClose = "close"
+}
+/**
+ * 内置事件数据结构体。
+ */
+export declare type BuiltinMsg = {
+    event_type: BuiltinEventType;
+    action: BuiltinActionType;
+    to_user_ids: string[];
+    data: {
+        extension?: Record<string, any>;
+        [key: string]: any;
+    };
+};
+/**
+ * 麦克风状态。
+ */
+export declare enum MicroStatus {
+    OPEN = "OPEN",
+    CLOSE = "CLOSE"
+}
+/**
+ * 响应的信息结构体。
+ */
+export declare type LiveMsg = {
+    code: string;
+    message: string;
+    command: Command;
+    roomCode: string;
+    appId: string;
+    requestId: string;
+    frontRequestId: string;
+    triggerUserId: string;
+    data: Record<string, any> | Record<string, any>[];
+};
+/**
+ * 解析下后端数据格式。
+ * @param jsonTxt - JSON序列化后的文本。
+ * @returns false 标识解析失败；解析成功返回 {@link LiveMsg} 实例。
+ */
+export declare function parseLiveMsg(jsonTxt: string): LiveMsg | boolean;

package/{lib/typings → dist/typings/live}/LiveOptions.d.ts

@@ -1,46 +1,65 @@
-import { RTCProtocol } from '../typings/RTCProtocol';
-/**
- * 依赖配置。
- */
-export interface LiveOptions {
-    /**
-     * 创建`WebSocket`所依赖的URL。
-     */
-    url?: string;
-    /**
-     * RTC实例。
-     */
-    rtc?: RTCProtocol;
-    /**
-     * 获取建立 WebSocket 连接的依赖Tick
-     */
-    getTicket?: () => Promise<string>;
-    /**
-     * 初始化自动连接，false 需手动执行 live.connect() 方法
-     */
-    /**
-     * 异常断开是否自动重连：默认 `true` 重连三次.
-     * 可以设置 `false` 关闭自动重连，以监控 `ws.readyStateUpdate` 事件自己来实现重连逻辑。
-     */
-    autoReconnect?: boolean | number;
-    /**
-     * 是否开启定时健康检查
-     */
-    healthCheck?: boolean | number;
-    /**
-     * 能否禁用某个/些用户的麦克风
-     */
-    canForbidUserMicro?: (users: string | string[]) => boolean;
-    /**
-     * 能否限制某个/些用户的帧数据同步
-     */
-    canForbidUserSync?: (users: string | string[]) => boolean;
-    /**
-     * 能否强制"踢掉"某个/些用户。
-     */
-    canForbidUserKick?: (users: string | string[]) => boolean;
-    /**
-     * 是否开启调试模式：此模式下会在终端打印日志方便调试。
-     */
-    __debug__?: boolean;
-}
+import { JSBridgeProtocol } from '@realsee/jsbridge-x';
+import { RTCProtocol } from '../rtc/protocol';
+import { RTCType } from '../rtc/type';
+import { GetVoiceSign } from './GetVoiceSign';
+/**
+ * 依赖配置。
+ */
+export interface LiveOptions {
+    /**
+     * 创建`WebSocket`所依赖的URL。
+     */
+    url?: string;
+    /**
+     * RTC实例。
+     * 优先使用该实例。
+     */
+    rtc?: RTCProtocol;
+    /**
+     * RTC类型
+     * rtc 为空时使用内置的rtc实例类型
+     */
+    rtcType?: RTCType;
+    /**
+     * 获取建立 WebSocket 连接的依赖Tick
+     */
+    getTicket?: () => Promise<string>;
+    /**
+     * jsBridge实例
+     * 使用内置rtc时提供给rtc实例使用
+     */
+    jsBridge?: JSBridgeProtocol;
+    /**
+     * 获取语音签名的接口
+     * 使用内置rtc时提供给rtc实例使用
+     */
+    getVoiceSign?: GetVoiceSign;
+    /**
+     * 初始化自动连接，false 需手动执行 live.connect() 方法
+     */
+    /**
+     * 异常断开是否自动重连：默认 `true` 重连三次.
+     * 可以设置 `false` 关闭自动重连，以监控 `ws.readyStateUpdate` 事件自己来实现重连逻辑。
+     */
+    autoReconnect?: boolean | number;
+    /**
+     * 是否开启定时健康检查
+     */
+    healthCheck?: boolean | number;
+    /**
+     * 能否禁用某个/些用户的麦克风
+     */
+    canForbidUserMicro?: (users: string | string[]) => boolean;
+    /**
+     * 能否限制某个/些用户的帧数据同步
+     */
+    canForbidUserSync?: (users: string | string[]) => boolean;
+    /**
+     * 能否强制"踢掉"某个/些用户。
+     */
+    canForbidUserKick?: (users: string | string[]) => boolean;
+    /**
+     * 是否开启调试模式：此模式下会在终端打印日志方便调试。
+     */
+    __debug__?: boolean;
+}

package/{lib/typings → dist/typings/live}/RoomInfo.d.ts

@@ -1,13 +1,13 @@
-export declare type RoomInfo = {
-    info: {
-        id: string | number;
-        status: string | number;
-        create_user_id: string;
-        app_id: string;
-        extension: Record<string, any>;
-        create_time: string;
-        room_code: string;
-    };
-    init_timestamp: string;
-    last_frame: Record<string, any>;
-};
+export declare type RoomInfo = {
+    info: {
+        id: string | number;
+        status: string | number;
+        create_user_id: string;
+        app_id: string;
+        extension: Record<string, any>;
+        create_time: string;
+        room_code: string;
+    };
+    init_timestamp: string;
+    last_frame: Record<string, any>;
+};