@realsee/live 0.6.14 → 0.7.0

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,29 +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;
-};

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,34 +0,0 @@
-/**
- * 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/dist/typings/rtc/protocol.d.ts

@@ -1,58 +0,0 @@
-import { CheckResult } from 'trtc-js-sdk';
-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;
-    /**
-     * 检查rtc的系统依赖是否满足
-     */
-    checkRequirement?(): Promise<CheckResult>;
-    /**
-     * 加入房间。
-     * @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

@@ -1,12 +0,0 @@
-/**
- * rtc 类型
- */
-export declare enum RTCType {
-    RealseeBrowserRTC = "RealseeBrowserRTC",
-    RealseeVRWebViewRTC = "RealseeVRWebViewRTC",
-    RealseeBrowserChimeRTC = "RealseeBrowserChimeRTC"
-}
-export declare enum BuiltInRTCType {
-    RealseeXTRTC = "trtc",
-    RealseeXChimeRTC = "chime"
-}

package/dist/utils/RobustWebSocket.d.ts

@@ -1,157 +0,0 @@
-import { Subscribe } from './subscribe';
-/**
- * 鲁棒ws的配置参数
- */
-export type RobustWebSocketConstructorOptions = {
-    url: string | ((ws: RobustWebSocket) => string);
-    protocols?: string[];
-    robustOptions?: RobustOptions;
-};
-/**
- * ws 鲁棒性的配置
- */
-export type RobustOptions = {
-    timeout?: number;
-    shouldReconnect?: (event: CloseEvent, ws: RobustWebSocket) => undefined | number;
-    should1000Reconnect?: boolean;
-    ignoreConnectivityEvents?: boolean;
-    automaticOpen?: boolean;
-};
-export type RobustWebSocketEventDetail = {
-    reconnects: number;
-    attempts: number;
-};
-export type RobustWebSocketEvent<T> = Event & {
-    detail: T;
-};
-export type RobustWebSocketEventMap = {
-    connecting: (event: RobustWebSocketEvent<RobustWebSocketEventDetail>) => void;
-    timeout: (event: RobustWebSocketEvent<RobustWebSocketEventDetail>) => void;
-    open: (event: RobustWebSocketEvent<RobustWebSocketEventDetail>) => void;
-    closing: () => void;
-    close: (event: CloseEvent) => void;
-    error: (event: Event) => void;
-    message: (event: MessageEvent<string | ArrayBuffer | Blob | ArrayBufferView>) => void;
-};
-/**
- * 具有鲁棒性的WebSocket封装
- * 1、自动重连
- * 2、可根据网络情况进行重连
- */
-export declare class RobustWebSocket extends Subscribe<RobustWebSocketEventMap> {
-    private _realWebSocket;
-    private _url?;
-    private _protocols;
-    private _readyState;
-    private _options;
-    private _connectTimeout;
-    private _attempts;
-    private _reconnects;
-    private _reconnectWhenOnlineAgain;
-    _explicitlyClosed: boolean;
-    private _pendingReconnect;
-    private _connectivityEventsAttached;
-    private _heathCheckTimer;
-    get attempts(): number;
-    constructor(options?: RobustWebSocketConstructorOptions);
-    setOptions(options: RobustWebSocketConstructorOptions): void;
-    /**
-     * 做一个健康检查
-     */
-    private _healthCheck;
-    /**
-     * 清理超时计时器
-     */
-    private _clearConnectTimeoutIfNeed;
-    /**
-     * 清理健康检查
-     */
-    private _clearHeathCheckIfNeed;
-    /**
-     * 开启健康检查
-     */
-    private _startHealthCheck;
-    /**
-     * 停止健康检查
-     */
-    private _stopHealthCheck;
-    /**
-     * 清理连接中的请求
-     */
-    private _clearPendingReconnectIfNeeded;
-    /**
-     * 当网页连接上网络进行重连
-     * @param event
-     */
-    private _online;
-    /**
-     * 当网页断开网络进行关闭
-     */
-    private _offline;
-    /**
-     * 解除网络监听事件
-     */
-    private _detachConnectivityEvents;
-    /**
-     * 注册网络监听事件
-     */
-    private _attachConnectivityEvents;
-    /**
-     * 发送消息
-     * @param data
-     * @returns
-     */
-    send: (data: string | ArrayBuffer | Blob | ArrayBufferView) => void | undefined;
-    /**
-     * 关闭连接
-     * @param code 代码
-     * @param reason 原因
-     * @returns
-     */
-    close: (code?: number | string, reason?: string) => void | undefined;
-    /**
-     * 进行ws连接
-     */
-    open: (url?: string) => void;
-    /**
-     * 创建ws连接
-     */
-    private _createWebSocket;
-    /**
-     * 断开ws事件
-     */
-    private _removeWebSocketEvent;
-    /**
-     * 分发ws事件
-     */
-    private _dispatchWebSocketEvent;
-    /**
-     * ws连接事件
-     * @returns
-     */
-    private _webSocketOpenHandler;
-    /**
-     * ws 关闭事件
-     * @param event
-     * @returns
-     */
-    private _webSocketCloseHandler;
-    /**
-     * ws 异常
-     * @param event
-     * @returns
-     */
-    private _webSocketErrorHandler;
-    /**
-     * ws消息
-     * @param event
-     * @returns
-     */
-    private _webSocketMessageHandler;
-    /**
-     * 进行重连
-     * @param event
-     * @returns
-     */
-    private _reconnect;
-}

package/dist/utils/appendUri.d.ts

@@ -1 +0,0 @@
-export declare function appendUri(uri: string, query?: Record<string, string | number>): string;

package/dist/utils/clientDetector.d.ts

@@ -1,4 +0,0 @@
-export declare const isAndroid: boolean;
-export declare const isIOS: boolean;
-export declare const isWxMiniProgram: boolean;
-export declare const isRealseeVRWebview: boolean;

package/dist/utils/equal.d.ts

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

package/dist/utils/logger.d.ts

@@ -1,16 +0,0 @@
-/**
- * 输出格式化日志
- */
-export declare enum LOG_LEVEL {
-    info = "INFO",
-    log = "LOG",
-    error = "ERROR",
-    warn = "WARN"
-}
-declare const logger: {
-    log: (...args: any[]) => void;
-    info: (...args: any[]) => void;
-    error: (...args: any[]) => void;
-    warn: (...args: any[]) => void;
-};
-export default logger;