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

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

@@ -1,87 +1,87 @@
-/**
- * 用户当前状态枚举。
- */
-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 declare type UserInfoExt = {
-    /**
-     * 用户昵称。
-     */
-    nickname?: string;
-    /**
-     * 用户头像。
-     */
-    avatar?: string;
-    /**
-     * 其他用户相关的字段，比如用户职称、住址、联系方式等信息。
-     */
-    [key: string]: any;
-};
-/**
- * 带看会话房间用户的信息格式。
- */
-export declare 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?: Record<string, boolean>;
-    /**
-     * 用户信息扩展字段。
-     */
-    extension?: UserInfoExt;
-};
+/**
+ * 用户当前状态枚举。
+ */
+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 declare type UserInfoExt = {
+    /**
+     * 用户昵称。
+     */
+    nickname?: string;
+    /**
+     * 用户头像。
+     */
+    avatar?: string;
+    /**
+     * 其他用户相关的字段，比如用户职称、住址、联系方式等信息。
+     */
+    [key: string]: any;
+};
+/**
+ * 带看会话房间用户的信息格式。
+ */
+export declare 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?: Record<string, boolean>;
+    /**
+     * 用户信息扩展字段。
+     */
+    extension?: UserInfoExt;
+};

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

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

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

@@ -1,78 +1,78 @@
-/**
- * WebSocket 连接状态枚举
- */
-export declare enum WebSocketState {
-    /**
-     * 尚未初始化
-     */
-    NOTINITIALIZED = -1,
-    /**
-     * 正在链接中
-     */
-    CONNECTING = 0,
-    /**
-     * 已经链接并且可以通讯
-     */
-    OPEN = 1,
-    /**
-     * 连接正在关闭
-     */
-    CLOSING = 2,
-    /**
-     * 连接已关闭或者没有链接成功
-     */
-    CLOSED = 3
-}
-export declare 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_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;
+/**
+ * WebSocket 连接状态枚举
+ */
+export declare enum WebSocketState {
+    /**
+     * 尚未初始化
+     */
+    NOTINITIALIZED = -1,
+    /**
+     * 正在链接中
+     */
+    CONNECTING = 0,
+    /**
+     * 已经链接并且可以通讯
+     */
+    OPEN = 1,
+    /**
+     * 连接正在关闭
+     */
+    CLOSING = 2,
+    /**
+     * 连接已关闭或者没有链接成功
+     */
+    CLOSED = 3
+}
+export declare 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_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

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