@realsee/live 0.7.0 → 0.7.2

package/dist/index.d.ts

@@ -1,1336 +1,5 @@
-import * as trtc_js_sdk from 'trtc-js-sdk';
-import { CheckResult } from 'trtc-js-sdk';
-import { ConsoleLogger, DefaultDeviceController, DefaultMeetingSession, DeviceChangeObserver, AudioVideoObserver, AudioMixObserver, LogLevel } from 'amazon-chime-sdk-js';
-import * as _realsee_jsbridge_x from '@realsee/jsbridge-x';
-import { JSBridgeProtocol } from '@realsee/jsbridge-x';
-import * as Y from 'yjs';
-import React from 'react';
-
-/**
- * 用户的音量信息。
- */
-type UserVolume = {
-    userId: string;
-    audioVolume: number;
-};
-
-/**
- * rtc加入返回值code枚举
- */
-declare enum RTCJoinedInfoCodeEnum {
-    /**
-     * 成功
-     */
-    Success = 0,
-    /**
-     * 失败
-     */
-    Failure = 1,
-    /**
-     * 重复加入
-     */
-    ReJoin = 2,
-    /**
-     * 无麦克风权限
-     */
-    NoMicroPermission = 3,
-    /**
-     * 未知异常
-     */
-    Unknown = 500
-}
-/**
- * 进入rtc房间的回调信息
- */
-interface RTCJoinedInfo {
-    code: RTCJoinedInfoCodeEnum;
-    message: string;
-    userId?: string;
-    roomId?: number;
-    errInfo?: {
-        errCode: number;
-        errMsg: string;
-    };
-}
-
-/**
- * RTC 异步事件类型。
- */
-type RTCEventType = {
-    /**
-     * 错误\异常
-     * @param error
-     */
-    "error"(error: Error | RTCJoinedInfo): void;
-    /**
-     * 即将加入房间。
-     */
-    "joinWillStart"(): void;
-    /**
-     * 成功加入语音房间。
-     */
-    "joined"(): void;
-    /**
-     * 弱网提醒事件。
-     */
-    "weakNetwork"(): void;
-    /**
-     * 每个用户的音量。
-     * @param userVolumes
-     */
-    "userVolumes"(userVolumes: UserVolume[]): void;
-    /**
-     * rtc 成功
-     * @private 内置事件，行为会随版本变更，请勿通过外部注册监听
-     */
-    "inner.rtc.success"(result: RTCJoinedInfo | boolean): void;
-    /**
-     * rtc 失败
-     * @private 内置事件，行为会随版本变更，请勿通过外部注册监听
-     */
-    "inner.rtc.fail"(result: RTCJoinedInfo | boolean): void;
-    /**
-     * rtc 错误
-     * @private 内置事件，行为会随版本变更，请勿通过外部注册监听
-     */
-    "inner.rtc.error"(error: Error): void;
-};
-
-type EventMap = {
-    [name: string]: (...args: any[]) => void | boolean;
-};
-/**
- * 监听者模式
- * @template T 预设的监听回调类型
- * @example
- * ```
- * new Subscribe<{
- * "foo": [arg1: number, arg2: string],
- * "bar": [arg: boolean],
- * }>()
- * ```
- */
-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;
-}
-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;
-    }
-}
-
-/**
- * rtc 类型
- */
-declare enum RTCType {
-    RealseeBrowserRTC = "RealseeBrowserRTC",
-    RealseeVRWebViewRTC = "RealseeVRWebViewRTC",
-    RealseeBrowserChimeRTC = "RealseeBrowserChimeRTC"
-}
-declare enum BuiltInRTCType {
-    RealseeXTRTC = "trtc",
-    RealseeXChimeRTC = "chime"
-}
-
-/**
- * rtc 协议接口
- * @interface
- * @extends Subscribe<RTCEventType>
- */
-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;
-}
-
-/**
- * rtc 基础抽象类
- */
-declare abstract class CoreRTC extends Subscribe<RTCEventType> implements RTCProtocol {
-    abstract joined: boolean;
-    abstract micro: boolean;
-    abstract voiceId: string;
-    abstract type: RTCType;
-    abstract join(options: {
-        voiceId: string;
-        userId: string;
-        roomId: string | number | undefined;
-        type: RTCType;
-    }): Promise<boolean>;
-    abstract quit(): Promise<boolean>;
-    abstract detectMicro(): Promise<boolean>;
-    abstract toggleMicro(flag?: boolean): Promise<boolean>;
-    abstract shock(): void;
-}
-
-/**
- * 语音签名的返回值
- */
-type GetVoiceSignReturnType = {
-    /**
-     * rtc 的 sdkAppId
-     */
-    sdkAppId: number;
-    /**
-     * rtc 的 用户 id
-     */
-    userId: string;
-    /**
-     * rtc 的 语音房间号
-     */
-    roomId: string | number;
-    /**
-     * rtc 的 用户签名
-     */
-    userSig: string;
-};
-/**
- * 获取用户语音签名的参数
- */
-type GetVoiceSignParams = {
-    /**
-     * 语音房间号
-     */
-    voiceId: string;
-    /**
-     * 用户 id
-     */
-    userId: string;
-    /**
-     * 房间 id
-     */
-    roomId: string | number;
-};
-/**
- * 获取用户语音签名的方法
- * @param {GetVoiceSignParams} params - 获取语音签名所需的参数
- * @returns {Promise<GetVoiceSignReturnType>} 返回一个Promise，解析为语音签名的相关信息
- * @property {number} sdkAppId - RTC的sdkAppId
- * @property {string} userId - RTC的用户ID
- * @property {string|number} roomId - RTC的语音房间号
- * @property {string} userSig - RTC的用户签名
- */
-declare function GetVoiceSignFn(params: GetVoiceSignParams): Promise<GetVoiceSignReturnType>;
-/**
- * 获取用户语音签名的方法类型
- */
-type GetVoiceSign = typeof GetVoiceSignFn;
-
-declare class BrowserRTC extends CoreRTC {
-    type: RTCType;
-    joined: boolean;
-    micro: boolean;
-    voiceId: string;
-    private _getVoiceSign;
-    private _autoPlayConfirm;
-    checkRequirement: () => Promise<trtc_js_sdk.CheckResult>;
-    private $dom;
-    private _trtc;
-    constructor(options: {
-        getVoiceSign: GetVoiceSign;
-        autoPlayConfirm?: (opts: {
-            onConfirm: () => void;
-        }) => void;
-    });
-    private _initParentDom;
-    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;
-    private _registerRtcEvent;
-    private _handleStreamAdded;
-    private _handleStreamSubscribed;
-}
-
-/**
- * amazon-chime-sdk-js 适配的rtc实现
- */
-declare class BrowserRTC4Chime extends CoreRTC {
-    type: RTCType;
-    joined: boolean;
-    micro: boolean;
-    voiceId: string;
-    userId: string;
-    logger: ConsoleLogger;
-    deviceController: DefaultDeviceController;
-    meetingSession: DefaultMeetingSession | undefined;
-    audioInput: MediaDeviceInfo | undefined;
-    audioOutput: MediaDeviceInfo | undefined;
-    deviceChangeObserver: DeviceChangeObserver;
-    audioVideoObserver: AudioVideoObserver;
-    audioMixObserver?: AudioMixObserver;
-    private _getVoiceSign;
-    private _autoPlayConfirm;
-    private $dom;
-    private $audio;
-    constructor(options: {
-        getVoiceSign: GetVoiceSign;
-        autoPlayConfirm?: (opts: {
-            onConfirm: () => void;
-        }) => void;
-        logLevel?: LogLevel;
-    });
-    /**
-     * 对audio标签初始化
-     */
-    _initDom: () => void;
-    /**
-     * 初始化事件监听器
-     */
-    initObservers: () => void;
-    /**
-     * 加入语音会议
-     * @param options
-     * @returns
-     */
-    join(options: {
-        voiceId: string;
-        userId: string;
-        roomId: string | number | undefined;
-        type: RTCType;
-    }): Promise<boolean>;
-    /**
-     * 注册rtc事件
-     */
-    _registerRtcEvent: () => void;
-    quit(): Promise<boolean>;
-    detectMicro(): Promise<boolean>;
-    toggleMicro(flag?: boolean): Promise<boolean>;
-    shock(): void;
-}
-
-interface VRWebViewRTCOptions {
-    jsBridge: JSBridgeProtocol;
-    getVoiceSign: GetVoiceSign;
-}
-
-declare class VRWebViewRTC extends CoreRTC {
-    type: RTCType;
-    joined: boolean;
-    micro: boolean;
-    voiceId: string;
-    /**
-     * 保留加入房间参数，用于重连
-     */
-    private _joinOptions;
-    private options;
-    get jsBridge(): _realsee_jsbridge_x.JSBridgeProtocol;
-    constructor({ jsBridge, getVoiceSign }: VRWebViewRTCOptions);
-    /**
-     * 处理用户音量
-     * @param userVolumes
-     */
-    private handleUserVolumes;
-    /**
-     * 处理弱网络情况
-     * @param weakNetwork
-     */
-    private handleWeakNetwork;
-    /**
-     * 加入语音房间
-     * @param options
-     * @returns
-     */
-    join: (options: {
-        voiceId: string;
-        userId: string;
-        roomId: string;
-        type: RTCType;
-    }) => 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;
-}
-
-interface AttendeeResponse {
-    attendee_id: string;
-    external_user_id: string;
-    join_token: string;
-}
-
-interface MeetingResponse {
-    MediaPlacement: {
-        AudioFallbackUrl: string;
-        AudioHostUrl: string;
-        ScreenDataUrl: string;
-        ScreenSharingUrl: string;
-        ScreenViewingUrl: string;
-        SignalingUrl: string;
-        TurnControlUrl: string;
-    };
-    MeetingId: string;
-}
-
-interface MeetingSessionConfigurationOptions {
-    attendence: AttendeeResponse;
-    config: {
-        passport: string;
-        vendor: string;
-        app_id: string;
-        bypass: any;
-    };
-    expire_time: number;
-    identifier: string;
-    user_id: string;
-    user_sig: string;
-    vendor_wrapper: MeetingResponse;
-}
-
-/**
- * WebSocket 通信指令
- * - 下行：服务端推送数据
- * - 上行：客户端上报数据
- */
-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"
-}
-/**
- * 向服务端请求数据时的数据格式。
- */
-type ReqLiveMsg = {
-    /**
-     * 请求指令。
-     */
-    command: Command;
-    /**
-     * 前端请求时生成的uuid()。
-     */
-    front_request_id: string | number;
-    /**
-     * 数据内容
-     */
-    data: {
-        /**
-         * 如果此数据仅发送给某些用户，请提供这些用户的ucid。
-         */
-        to_user_ids?: string[];
-        [key: string]: any;
-    };
-};
-/**
- * 内置事件类型。
- */
-declare enum BuiltinEventType {
-    /**
-     * 变更用户状态。
-     */
-    UserChange = "user_change",
-    /**
-     * 变更房间状态。
-     */
-    RoomChange = "room_change"
-}
-/**
- * 内置事件行为类型。
- */
-declare enum BuiltinActionType {
-    /**
-     * 修改麦克风状态。
-     */
-    UserMicroStatus = "change_micro_status",
-    /**
-     * 同步当前用户状态：客户端麦克风状态已经修改成功，通知服务端
-     */
-    UserMicroStatusSync = "sync_micro_status",
-    /**
-     * 调整某些用户的权限。
-     */
-    UserPermission = "change_permission",
-    /**
-     * 用户状态发生改变。
-     */
-    UserStatus = "change_status",
-    /**
-     * 更新用户信息。
-     */
-    UserInfo = "change_info",
-    /**
-     * 关闭房间。
-     */
-    RoomClose = "close"
-}
-/**
- * 内置事件数据结构体。
- */
-type BuiltinMsg = {
-    event_type: BuiltinEventType;
-    action: BuiltinActionType;
-    to_user_ids: string[];
-    data: {
-        extension?: Record<string, any>;
-        [key: string]: any;
-    };
-};
-/**
- * 麦克风状态。
- */
-declare enum MicroStatus {
-    /**
-     * 打开
-     */
-    OPEN = "OPEN",
-    /**
-     * 关闭
-     */
-    CLOSE = "CLOSE"
-}
-/**
- * 响应的信息结构体。
- */
-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} 实例。
- */
-declare function parseLiveMsg(jsonTxt: string): LiveMsg | boolean;
-
-declare enum LiveState {
-    NOTINITIALIZED = -1,
-    /**
-     * 正在链接中
-     */
-    CONNECTING = 0,
-    /**
-     * 已经链接并且可以通讯
-     */
-    OPEN = 1,
-    /**
-     * 连接已关闭或者链接失败
-     */
-    CLOSED = 3
-}
-
-/**
- * 用户当前状态枚举。
- */
-declare enum UserStatus {
-    /**
-     * 正常
-     */
-    Normal = 0,
-    /**
-     * 被移除
-     */
-    Removed = 1,
-    /**
-     * 被替换
-     */
-    Replaced = 2
-}
-declare enum MemUserStatus {
-    WAIT_ENTER = "WAIT_ENTER",
-    ONLINE = "ONLINE",
-    LEAVE = "LEAVE",
-    KICK_OUT = "KICK_OUT",
-    BE_REPLACE = "BE_REPLACE",
-    EXCEPTION = "EXCEPTION"
-}
-/**
- * 用户信息扩展字段：比如提供用户画像相关的数据。
- */
-type UserInfoExt = {
-    /**
-     * 用户昵称。
-     */
-    nickname?: string;
-    /**
-     * 用户头像。
-     */
-    avatar?: string;
-    /**
-     * 其他用户相关的字段，比如用户职称、住址、联系方式等信息。
-     */
-    [key: string]: any;
-};
-/**
- * 带看会话房间用户的信息格式。
- */
-type UserInfo = {
-    /**
-     * 用户唯一标识ID。
-     */
-    id: string;
-    /**
-     * 用户当前的状态。
-     */
-    status?: UserStatus;
-    /**
-     * 内存中的用户状态。
-     */
-    mem_user_status?: MemUserStatus;
-    /**
-     * 用户当前是否开启麦克风。
-     */
-    micro_status: boolean;
-    /**
-     * 用户角色定义。（前端不关注此字段）。
-     */
-    user_role?: number | string;
-    /**
-     * 用户当前是否在线。
-     */
-    current_ws_online?: boolean;
-    /**
-     * 用户曾经是否在线过，即进入房间后又由于某种原因离开后重新进入。
-     */
-    once_ws_online?: boolean;
-    /**
-     * RTC 环境是否就绪，即当前语音是否联通。
-     */
-    rtc: boolean;
-    /**
-     * 当前用户的权限配置。（UI层面理解）。
-     */
-    permission?: Partial<Permission>;
-    /**
-     * 用户信息扩展字段。
-     */
-    extension?: UserInfoExt;
-};
-interface Permission {
-    more_vr_scene: boolean;
-    invite_other: boolean;
-    control_own_micro: boolean;
-    control_other_micro: boolean;
-    view_own_micro_status: boolean;
-    view_other_micro_status: boolean;
-    close_live_room: boolean;
-    apply_other_phone: boolean;
-    dynamic_enter: boolean;
-    sync_frame: boolean;
-    transfer_role: boolean;
-    change_other_status: boolean;
-    control_other_sync: boolean;
-    extension: Record<string, boolean>;
-}
-
-/**
- * 带看事件列表
- */
-type LiveEventType<KeyframesSnapshot> = {
-    /**
-     * 带看状态变化
-     * @param state
-     * @param prevState
-     */
-    'stateChange'(state: LiveState, prevState?: LiveState): void;
-    /**
-     * 内置消息事件
-     * @param builtinMsg
-     */
-    'builtinEvent'(builtinMsg: BuiltinMsg): void;
-    /**
-     * 内置消息事件: 用户信息改变
-     * @param builtinMsg
-     */
-    'userChange'(builtinMsg: BuiltinMsg): void;
-    /**
-     * 内置消息事件：房间信息改变
-     * @param builtinMsg
-     */
-    'roomChange'(builtinMsg: BuiltinMsg): void;
-    /**
-     * 收到其他用户的广播消息。
-     * @param evtMsg
-     */
-    'broadcast'(evtMsg: Record<string, any>, frontRequestId: string): void;
-    /**
-     * 带看已经就绪，可以发送帧数据。
-     * @param lastKeyframe 带看最后一帧数据（链接切换、断网等重连恢复上次会话帧状态），你可以通过此数据拉齐当前UI状态。
-     * @deprecated 此事件已废弃，请使用 `keyframes` 事件替代，最后的帧数据会通过 `keyframes` 事件发送，同时 keyframes 对象在 ready 后会自动更新。
-     */
-    'readyKeyframeSync'(lastKeyframe: Partial<KeyframesSnapshot>): void;
-    /**
-     * 获取其他用户输送的帧数据：根据此帧数据更新UI状态。
-     * @param keyframes
-     */
-    'keyframes'(keyframes: Partial<KeyframesSnapshot>, frontRequestId: string): void;
-    /**
-     * 个人信息发生更新。
-     * @param userInfo
-     */
-    'selfInfoUpdate'(userInfo: UserInfo, frontRequestId: string): void;
-    /**
-     * 用户列表更新。
-     * @param userList
-     */
-    'userListUpdate'(userList: UserInfo[], frontRequestId: string): void;
-    /**
-     * 被踢出房间
-     * */
-    'kickOut'(): void;
-    /**
-     * 异常消息：不符合规范。
-     * @param liveMsg
-     */
-    'error'(liveMsg: LiveMsg): void;
-};
-/**
- * 帧数据订阅发布的事件描述
- */
-type KeyframeEventType<KeyframesSnapshot> = {
-    [key in keyof KeyframesSnapshot]: (nextKeyframes: KeyframesSnapshot[key], prevKeyframes: KeyframesSnapshot[key], frontRequestId: string) => void;
-};
-/**
- * 事件解析
- */
-type EventType<KeyframesSnapshot> = LiveEventType<KeyframesSnapshot>;
-
-/**
- * 依赖配置。
- */
-interface LiveOptions {
-    /**
-     * 创建`WebSocket`所依赖的URL。
-     */
-    url?: string;
-    /**
-     * RTC实例。
-     * 优先使用该实例。
-     */
-    rtc?: RTCProtocol;
-    /**
-     * RTC类型
-     * rtc 为空时使用内置的rtc实例类型
-     */
-    rtcType?: RTCType;
-    /**
-     * 麦克风初始状态
-     */
-    initialMicroStatus?: MicroStatus;
-    /**
-     * 获取建立 WebSocket 连接的依赖Tick
-     */
-    getTicket?: () => Promise<string>;
-    /**
-     * jsBridge实例
-     * 使用内置rtc时提供给rtc实例使用
-     */
-    jsBridge?: JSBridgeProtocol;
-    /**
-     * 获取语音签名的接口
-     * 使用内置rtc时提供给rtc实例使用
-     */
-    getVoiceSign?: GetVoiceSign;
-    /**
-     * 使用webRTC时会有自动播放的安全策略限制，用户有交互
-     * @param options
-     * @returns
-     */
-    autoPlayConfirm?: (options: {
-        onConfirm: () => void;
-    }) => void;
-    /**
-     * 使用内置的rtc实例
-     */
-    useBuiltInRTC?: boolean;
-    /**
-     * 内置的rtc通道类型
-     * trtc or chime , default trtc
-     */
-    builtInRTCType?: BuiltInRTCType;
-    /**
-     * 使用内置的jsBridge实例
-     */
-    useBuiltInJsBridge?: boolean;
-    /**
-     * 能否禁用某个/些用户的麦克风
-     */
-    canForbidUserMicro?: (users: string | string[]) => boolean;
-    /**
-     * 能否限制某个/些用户的帧数据同步
-     */
-    canForbidUserSync?: (users: string | string[]) => boolean;
-    /**
-     * 能否强制"踢掉"某个/些用户。
-     */
-    canForbidUserKick?: (users: string | string[]) => boolean;
-    /**
-     * 是否开启调试模式：此模式下会在终端打印日志方便调试。
-     */
-    __debug__?: boolean;
-}
-
-/**
- * 带看连接配置项
- */
-type LiveConnectOptions = {
-    /**
-     * 这个是带看房间的 ws 地址
-     */
-    url?: string;
-    /**
-     * 是否强制加入
-     * 如果为 true，会强制加入房间，不管之前是否已经加入，会把之前的连接断开
-     * 如果为 false，会检查是否已经加入房间，如果已经加入，不会再次加入
-     */
-    force?: boolean;
-    /**
-     * 获取带看房间 ticket 的方法
-     */
-    getTicket?: () => Promise<string>;
-    /**
-     * 初始的麦克风状态
-     */
-    rtcMicStatus?: MicroStatus;
-};
-
-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>;
-};
-
-/**
- * WebSocket 连接状态枚举
- */
-declare enum WebSocketState {
-    /**
-     * 尚未初始化
-     */
-    NOTINITIALIZED = -1,
-    /**
-     * 正在链接中
-     */
-    CONNECTING = 0,
-    /**
-     * 已经链接并且可以通讯
-     */
-    OPEN = 1,
-    /**
-     * 连接正在关闭
-     */
-    CLOSING = 2,
-    /**
-     * 连接已关闭或者没有链接成功
-     */
-    CLOSED = 3
-}
-type WebSocketError = {
-    type: WebSocketErrorType;
-    closeError?: WebSocketCloseError;
-    target?: Event | CloseEvent;
-    error?: any;
-};
-declare enum WebSocketErrorType {
-    Error = "Error",
-    Close = "Close",
-    MicroAuth = "MicroAuth",
-    DuplicateConnect = "DuplicateConnect",
-    IllegalURL = "IllegalURL",
-    Unknown = "Unknown",
-    IllegalArgs = "IllegalArgs"
-}
-/**
- * WebSocket 异常关闭枚举：https://developer.mozilla.org/zh-CN/docs/Web/API/CloseEvent。
- */
-declare enum WebSocketCloseError {
-    /**
-     * 正常关闭; 无论为何目的而创建，该链接都已成功完成任务。
-     */
-    Err_1000 = "CLOSE_NORMAL",
-    /**
-     * 终端离开, 可能因为服务端错误, 也可能因为浏览器正从打开连接的页面跳转离开。
-     */
-    Err_1001 = "CLOSE_GOING_AWAY",
-    /**
-     * 由于协议错误而中断连接。
-     */
-    Err_1002 = "CLOSE_PROTOCOL_ERROR",
-    /**
-     * 由于接收到不允许的数据类型而断开连接 (如仅接收文本数据的终端接收到了二进制数据)。
-     */
-    Err_1003 = "CLOSE_UNSUPPORTED",
-    /**
-     * 安全因素或WebSocket连接次数达到上限。
-     */
-    Err_1006 = "CLOSE_ABNORMAL",
-    /**
-     * 由于收到了格式不符的数据而断开连接 (如文本消息中包含了非 UTF-8 数据)。
-     */
-    Err_1007 = "Unsupported Data",
-    /**
-     * 由于收到不符合约定的数据而断开连接。
-     */
-    Err_1008 = "Policy Violation",
-    /**
-     * 由于收到过大的数据帧而断开连接。
-     */
-    Err_1009 = "CLOSE_TOO_LARGE",
-    /**
-     * 未知错误。
-     */
-    Err_unknown = "unknown"
-}
-declare function parseWSClsErr(code: number): WebSocketCloseError;
-
-type RTCActionReactCallback = Pick<RTCProtocol, 'join' | 'quit' | 'shock' | 'toggleMicro' | 'detectMicro'>;
-
-type LiveBuiltInData<KeyframesSnapshot> = {
-    selfInfo?: UserInfo;
-    userList?: UserInfo[];
-    roomInfo?: RoomInfo;
-    rtcInfo?: {
-        voiceId: string;
-        type: RTCType;
-    };
-    keyframes: Y.Map<KeyframesSnapshot>;
-};
-declare const _clearLiveInstanceIfNeed: () => void;
-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<KeyframeEventType<KeyframesSnapshot>>;
-    /**
-     * 带看的 yDoc
-     */
-    private _yDoc;
-    /**
-     * 内置的一些数据
-     */
-    private _buildInData;
-    constructor(opts: LiveOptions);
-    get _buildInKeyframes(): Y.Map<KeyframesSnapshot>;
-    /**
-     * 当前帧数据快照
-     */
-    get snapshot(): Partial<KeyframesSnapshot>;
-    _initializeKeyframesObservers: () => void;
-    _handleKeyframesChange: (event: Y.YMapEvent<KeyframesSnapshot>) => void;
-    /**
-     * 根据键值取帧数据
-     * @param key 帧数据的键值
-     * @returns
-     */
-    getFramesByKey: <Key extends keyof KeyframesSnapshot>(key: Key) => Partial<KeyframesSnapshot>[Key] | undefined;
-    /**
-     * 发送帧数据（需要能够被序列化）
-     * @param key 帧数据键值
-     * @param frame 帧数据本体
-     * @returns 发送结果，成功返回true，失败返回false或Error
-     */
-    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;
-    private _initializeOptions;
-    private _initializeJsBridge;
-    private _initializeRTC;
-    private _createBuiltInRTC;
-    private _createVRWebViewRTC;
-    private _createBrowserRTC;
-    private _createDefaultRTC;
-    private _autoConnect;
-    private _debugSetup;
-    /**
-     * 添加带看控制的事件监听
-     */
-    private _addLiveControllerEventListeners;
-    /**
-     * 移除带看控制的事件监听
-     */
-    private _removeLiveControllerEventListeners;
-    /**
-     * 带看状态变化处理
-     * @param state 当前状态
-     * @param prevState 之前的状态
-     */
-    private _handleStateChange;
-    /**
-     * 消息接收
-     * @param liveMsg
-     */
-    private _handleMessage;
-    /**
-     * 清理带看缓存的数据
-     */
-    private _clearLiveData;
-    /**
-     * 连接带看
-     * @param options 连接选项
-     * @returns 连接结果，成功返回true，失败返回Error
-     */
-    connect: (options?: LiveConnectOptions) => Promise<true | Error>;
-    /**
-     * 退出带看
-     * @returns
-     */
-    _exit: () => Promise<boolean>;
-    /**
-     * 退出带看
-     * @returns
-     */
-    exit: () => Promise<void>;
-    /**
-     * 关闭带看房间
-     * @returns 关闭结果
-     */
-    close: () => Promise<void>;
-    /**
-     * 销毁带看
-     * @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 extends Record<string, any>, 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>;
-    /**
-     * 获取当前某个 keyframe 的数据快照
-     */
-    getSnapshotForKey<Key extends keyof KeyframesSnapshot>(key: Key): any;
-}
-
-/**
- * 创建`Live`实例
- * @param opts
- * @returns
- */
-declare const createLive: <KeyframesSnapshot extends Record<string, any>>(opts: LiveOptions) => Live<KeyframesSnapshot>;
-
-type LiveProviderPropTypes<KeyframesSnapshot extends Record<string, any>> = {
-    children?: React.ReactNode;
-    live?: Live<KeyframesSnapshot>;
-};
-/**
- * 创建 LiveReact 实例，并提供 `React` 技术栈相关工具链。
- * @param options 带看配置
- * @returns 返回当前的带看上下文实例
- */
-declare function createLiveReact<KeyframesSnapshot extends Record<string, any>>(options: LiveOptions): {
-    live: Live<KeyframesSnapshot>;
-    jsBridge: _realsee_jsbridge_x.JSBridgeProtocol;
-    LiveProvider: (props: LiveProviderPropTypes<KeyframesSnapshot>) => React.FunctionComponentElement<React.ProviderProps<Live<KeyframesSnapshot> | null>>;
-    unsafe__useLiveInstance: () => Live<KeyframesSnapshot>;
-    unsafe__useRTCInstance: () => RTCProtocol;
-    useConnect: () => (options: LiveConnectOptions) => Promise<true | Error>;
-    useKeyframe: <K extends keyof KeyframesSnapshot>(key: K) => (KeyframesSnapshot[K] | ((frame: KeyframesSnapshot[K]) => boolean | Error) | undefined)[];
-    useKeyframeUpdateCallback: <KeyOfKeyframe extends keyof KeyframeEventType<KeyframesSnapshot>>(key: KeyOfKeyframe, callback: (...args: Parameters<KeyframeEventType<KeyframesSnapshot>[KeyOfKeyframe]>) => ReturnType<KeyframeEventType<KeyframesSnapshot>[KeyOfKeyframe]>, deps?: React.DependencyList) => () => void;
-    useLiveAction: () => {
-        connect: (options: LiveConnectOptions) => Promise<void>;
-        broadcast: (data: Record<string, any>, toUserIds: string | string[], timeout?: number) => Promise<void>;
-        exit: () => Promise<void>;
-        kick: (toUserIds: string | string[]) => Promise<void>;
-        toggleMicro: (microStatus: boolean) => void;
-        forbidMicro: (micro: MicroStatus, toUserIds?: string | string[]) => Promise<void>;
-        forbidSync: (sync: boolean, toUserIds?: string | string[]) => void;
-        sendKeyframe: (key: keyof KeyframesSnapshot, frame: KeyframesSnapshot[keyof KeyframesSnapshot]) => void;
-        getFramesByKey: (key: keyof KeyframesSnapshot) => Partial<KeyframesSnapshot>[keyof KeyframesSnapshot] | undefined;
-        setSelfInfo: (userInfo: Partial<UserInfo>) => void;
-        updateStatus: (evtType: BuiltinEventType, atnType: BuiltinActionType, status: Record<string, any>, toUserIds?: string | string[]) => void;
-    };
-    useLiveEventCallback: <K extends keyof LiveEventType<KeyframesSnapshot>>(name: K, callback: (...args: Parameters<LiveEventType<KeyframesSnapshot>[K]>) => ReturnType<LiveEventType<KeyframesSnapshot>[K]>, 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 extends keyof RTCEventType>(name: K, callback: (...args: Parameters<RTCEventType[K]>) => ReturnType<RTCEventType[K]>, deps?: React.DependencyList) => () => void;
-    useSelfInfo: () => (Partial<UserInfo> | ((userInfo: Partial<UserInfo>) => Promise<boolean>))[];
-    useKeyframesSnapshot: () => Partial<KeyframesSnapshot>;
-    useUserList: () => UserInfo[];
-};
-
-export { type AttendeeResponse, BrowserRTC, BrowserRTC4Chime, BuiltInRTCType, BuiltinActionType, BuiltinEventType, type BuiltinMsg, Command, CoreRTC, type EventMap, type EventType, type GetVoiceSign, GetVoiceSignFn, type GetVoiceSignParams, type GetVoiceSignReturnType, type KeyframeEventType, Live, type LiveBuiltInData, type LiveConnectOptions, type LiveEventType, type LiveMsg, type LiveOptions, type LiveProviderPropTypes, LiveState, type MeetingResponse, type MeetingSessionConfigurationOptions, MemUserStatus, MicroStatus, type Permission, type RTCActionReactCallback, type RTCEventType, type RTCJoinedInfo, RTCJoinedInfoCodeEnum, type RTCProtocol, RTCType, type ReqLiveMsg, type RoomInfo, Subscribe, SubscribeMixinType, type UserInfo, type UserInfoExt, UserStatus, type UserVolume, VRWebViewRTC, type VRWebViewRTCOptions, WebSocketCloseError, type WebSocketError, WebSocketErrorType, WebSocketState, _clearLiveInstanceIfNeed, createLive, createLiveReact, parseLiveMsg, parseWSClsErr };
+export * from './rtc';
+export * from './typings';
+export * from './live/createLive';
+export * from './live/createLiveReact';
+export * from './live/live';