@realsee/live 0.6.15 → 0.7.1

package/dist/typings/live/EventType.d.ts

@@ -1,74 +0,0 @@
-import { BuiltinMsg, LiveMsg } from './LiveMsg';
-import { LiveState } from './LiveState';
-import { UserInfo } from './UserInfo';
-/**
- * 带看事件列表
- */
-export 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状态。
-     */
-    '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;
-    /**
-     * 被踢出房间
-     * @param
-     * */
-    'kickOut'(): void;
-    /**
-     * 异常消息：不符合规范。
-     * @param liveMsg
-     */
-    'error'(liveMsg: LiveMsg): void;
-};
-/**
- * 帧数据类型
- */
-export type KeyframeTypes<Type> = {
-    [Property in keyof Type as Property]: (nextKeyframes: Type[Property], prevKeyframes: Type[Property], frontRequestId: string) => void;
-};
-/**
- * 事件解析
- */
-export type EventType<KeyframesSnapshot> = LiveEventType<KeyframesSnapshot>;

package/dist/typings/live/GetVoiceSign.d.ts

@@ -1,45 +0,0 @@
-/**
- * 语音签名的返回值
- */
-export type GetVoiceSignReturnType = {
-    /**
-     * rtc 的 sdkAppId
-     */
-    sdkAppId: number;
-    /**
-     * rtc 的 用户 id
-     */
-    userId: string;
-    /**
-     * rtc 的 语音房间号
-     */
-    roomId: string | number;
-    /**
-     * rtc 的 用户签名
-     */
-    userSig: string;
-};
-/**
- * 获取用户语音签名的参数
- */
-export type GetVoiceSignParams = {
-    /**
-     * 语音房间号
-     */
-    voiceId: string;
-    /**
-     * 用户 id
-     */
-    userId: string;
-    /**
-     * 房间 id
-     */
-    roomId: string | number;
-};
-/**
- * 获取用户语音签名的方法
- * @param voiceId 语音房间号
- * @param userId 用户 id
- * @param roomId 房间 id
- */
-export type GetVoiceSign = (params: GetVoiceSignParams) => Promise<GetVoiceSignReturnType>;

package/dist/typings/live/LiveConnectOptions.d.ts

@@ -1,24 +0,0 @@
-import { MicroStatus } from "./LiveMsg";
-/**
- * 带看连接配置项
- */
-export type LiveConnectOptions = {
-    /**
-     * 这个是带看房间的 ws 地址
-     */
-    url?: string;
-    /**
-     * 是否强制加入
-     * 如果为 true，会强制加入房间，不管之前是否已经加入，会把之前的连接断开
-     * 如果为 false，会检查是否已经加入房间，如果已经加入，不会再次加入
-     */
-    force?: boolean;
-    /**
-     * 获取带看房间 ticket 的方法
-     */
-    getTicket?: () => Promise<string>;
-    /**
-     * 初始的麦克风状态
-     */
-    rtcMicStatus?: MicroStatus;
-};

package/dist/typings/live/LiveMsg.d.ts

@@ -1,133 +0,0 @@
-/**
- * WebSocket 通信指令
- * - 下行：服务端推送数据
- * - 上行：客户端上报数据
- */
-export 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"
-}
-/**
- * 向服务端请求数据时的数据格式。
- */
-export 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 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 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/dist/typings/live/LiveOptions.d.ts

@@ -1,79 +0,0 @@
-import { JSBridgeProtocol } from '@realsee/jsbridge-x';
-import { RTCProtocol } from '../rtc/protocol';
-import { BuiltInRTCType, RTCType } from '../rtc/type';
-import { GetVoiceSign } from './GetVoiceSign';
-import { MicroStatus } from './LiveMsg';
-/**
- * 依赖配置。
- */
-export 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;
-}

package/dist/typings/live/LiveState.d.ts

@@ -1,15 +0,0 @@
-export declare enum LiveState {
-    NOTINITIALIZED = -1,
-    /**
-     * 正在链接中
-     */
-    CONNECTING = 0,
-    /**
-     * 已经链接并且可以通讯
-     */
-    OPEN = 1,
-    /**
-     * 连接已关闭或者链接失败
-     */
-    CLOSED = 3
-}

package/dist/typings/live/RoomInfo.d.ts

@@ -1,13 +0,0 @@
-export 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>;
-};

package/dist/typings/live/UserInfo.d.ts

@@ -1,103 +0,0 @@
-/**
- * 用户当前状态枚举。
- */
-export declare enum UserStatus {
-    /**
-     * 正常
-     */
-    Normal = 0,
-    /**
-     * 被移除
-     */
-    Removed = 1,
-    /**
-     * 被替换
-     */
-    Replaced = 2
-}
-export declare enum MemUserStatus {
-    WAIT_ENTER = "WAIT_ENTER",
-    ONLINE = "ONLINE",
-    LEAVE = "LEAVE",
-    KICK_OUT = "KICK_OUT",
-    BE_REPLACE = "BE_REPLACE",
-    EXCEPTION = "EXCEPTION"
-}
-/**
- * 用户信息扩展字段：比如提供用户画像相关的数据。
- */
-export type UserInfoExt = {
-    /**
-     * 用户昵称。
-     */
-    nickname?: string;
-    /**
-     * 用户头像。
-     */
-    avatar?: string;
-    /**
-     * 其他用户相关的字段，比如用户职称、住址、联系方式等信息。
-     */
-    [key: string]: any;
-};
-/**
- * 带看会话房间用户的信息格式。
- */
-export 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;
-};
-export 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>;
-}

package/dist/typings/live/UserVolume.d.ts

@@ -1,7 +0,0 @@
-/**
- * 用户的音量信息。
- */
-export type UserVolume = {
-    userId: string;
-    audioVolume: number;
-};

package/dist/typings/live/WebSocket.d.ts

@@ -1,82 +0,0 @@
-/**
- * WebSocket 连接状态枚举
- */
-export declare enum WebSocketState {
-    /**
-     * 尚未初始化
-     */
-    NOTINITIALIZED = -1,
-    /**
-     * 正在链接中
-     */
-    CONNECTING = 0,
-    /**
-     * 已经链接并且可以通讯
-     */
-    OPEN = 1,
-    /**
-     * 连接正在关闭
-     */
-    CLOSING = 2,
-    /**
-     * 连接已关闭或者没有链接成功
-     */
-    CLOSED = 3
-}
-export type WebSocketError = {
-    type: WebSocketErrorType;
-    closeError?: WebSocketCloseError;
-    target?: Event | CloseEvent;
-    error?: any;
-};
-export 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。
- */
-export 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"
-}
-export declare function parseWSClsErr(code: number): WebSocketCloseError;

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

@@ -1,10 +0,0 @@
-export * from './EventType';
-export * from './GetVoiceSign';
-export * from './LiveMsg';
-export * from './LiveOptions';
-export * from './LiveState';
-export * from './LiveConnectOptions';
-export * from './RoomInfo';
-export * from './UserInfo';
-export * from './UserVolume';
-export * from './WebSocket';

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

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

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

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

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

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

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

@@ -1,44 +0,0 @@
-import { UserVolume } from "../live/UserVolume";
-import { RTCJoinedInfo } from "./joinedInfo";
-/**
- * RTC 异步事件类型。
- */
-export type RTCEventType = {
-    /**
-     * 错误\异常
-     * @param error
-     */
-    "error"(error: Error | RTCJoinedInfo): void;
-    /**
-     * 即将加入房间。
-     */
-    "joinWillStart"(): void;
-    /**
-     * 成功加入语音房间。
-     */
-    "joined"(): void;
-    /**
-     * 弱网提醒事件。
-     */
-    "weakNetwork"(): void;
-    /**
-     * 每个用户的音量。
-     * @param userVolumes
-     */
-    "userVolumes"(userVolumes: UserVolume[]): void;
-    /**
-     * rtc 成功
-     * @inner 内置事件，行为会随版本变更，请勿通过外部注册监听
-     */
-    "inner.rtc.success"(result: RTCJoinedInfo | boolean): void;
-    /**
-     * rtc 失败
-     * @inner 内置事件，行为会随版本变更，请勿通过外部注册监听
-     */
-    "inner.rtc.fail"(result: RTCJoinedInfo | boolean): void;
-    /**
-     * rtc 错误
-     * @inner 内置事件，行为会随版本变更，请勿通过外部注册监听
-     */
-    "inner.rtc.error"(error: Error): void;
-};

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

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

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

@@ -1,38 +0,0 @@
-/**
- * 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;
-    };
-}