@realsee/live 0.6.15 → 0.7.0

package/docs/enumerations/BuiltinActionType.md

@@ -0,0 +1,81 @@
+[**如视 Live SDK**](../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../globals.md) / BuiltinActionType
+
+# Enumeration: BuiltinActionType
+
+内置事件行为类型。
+
+## Enumeration Members
+
+### RoomClose
+
+> **RoomClose**: `"close"`
+
+关闭房间。
+
+#### Defined in
+
+typings/live/LiveMsg.ts:90
+
+***
+
+### UserInfo
+
+> **UserInfo**: `"change_info"`
+
+更新用户信息。
+
+#### Defined in
+
+typings/live/LiveMsg.ts:86
+
+***
+
+### UserMicroStatus
+
+> **UserMicroStatus**: `"change_micro_status"`
+
+修改麦克风状态。
+
+#### Defined in
+
+typings/live/LiveMsg.ts:70
+
+***
+
+### UserMicroStatusSync
+
+> **UserMicroStatusSync**: `"sync_micro_status"`
+
+同步当前用户状态：客户端麦克风状态已经修改成功，通知服务端
+
+#### Defined in
+
+typings/live/LiveMsg.ts:74
+
+***
+
+### UserPermission
+
+> **UserPermission**: `"change_permission"`
+
+调整某些用户的权限。
+
+#### Defined in
+
+typings/live/LiveMsg.ts:78
+
+***
+
+### UserStatus
+
+> **UserStatus**: `"change_status"`
+
+用户状态发生改变。
+
+#### Defined in
+
+typings/live/LiveMsg.ts:82

package/docs/enumerations/BuiltinEventType.md

@@ -0,0 +1,33 @@
+[**如视 Live SDK**](../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../globals.md) / BuiltinEventType
+
+# Enumeration: BuiltinEventType
+
+内置事件类型。
+
+## Enumeration Members
+
+### RoomChange
+
+> **RoomChange**: `"room_change"`
+
+变更房间状态。
+
+#### Defined in
+
+typings/live/LiveMsg.ts:60
+
+***
+
+### UserChange
+
+> **UserChange**: `"user_change"`
+
+变更用户状态。
+
+#### Defined in
+
+typings/live/LiveMsg.ts:56

package/docs/enumerations/Command.md

@@ -0,0 +1,107 @@
+[**如视 Live SDK**](../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../globals.md) / Command
+
+# Enumeration: Command
+
+WebSocket 通信指令
+- 下行：服务端推送数据
+- 上行：客户端上报数据
+
+## Enumeration Members
+
+### BuiltinMsg
+
+> **BuiltinMsg**: `"BUILTIN_MSG"`
+
+内置消息：下行、上行
+
+#### Defined in
+
+typings/live/LiveMsg.ts:16
+
+***
+
+### CustomEvent
+
+> **CustomEvent**: `"CUSTOM_EVENT"`
+
+自定义广播事件消息：下行、上行
+
+#### Defined in
+
+typings/live/LiveMsg.ts:18
+
+***
+
+### KeyframeSync
+
+> **KeyframeSync**: `"KEYFRAME_SYNC"`
+
+帧数据同步：下行、上行
+
+#### Defined in
+
+typings/live/LiveMsg.ts:20
+
+***
+
+### RoomInfo
+
+> **RoomInfo**: `"ROOM_INFO"`
+
+房间信息：下行
+
+#### Defined in
+
+typings/live/LiveMsg.ts:10
+
+***
+
+### RTCInfo
+
+> **RTCInfo**: `"RTC_INFO"`
+
+RTC信息：下行
+
+#### Defined in
+
+typings/live/LiveMsg.ts:12
+
+***
+
+### SelfUserInfo
+
+> **SelfUserInfo**: `"SELF_USER_INFO"`
+
+当前用户信息：下行
+
+#### Defined in
+
+typings/live/LiveMsg.ts:8
+
+***
+
+### UserKickOut
+
+> **UserKickOut**: `"USER_KICK_OUT"`
+
+被踢出房间：下行
+
+#### Defined in
+
+typings/live/LiveMsg.ts:22
+
+***
+
+### UserList
+
+> **UserList**: `"USER_LIST"`
+
+用户列表：下行
+
+#### Defined in
+
+typings/live/LiveMsg.ts:14

package/docs/enumerations/LiveState.md

@@ -0,0 +1,53 @@
+[**如视 Live SDK**](../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../globals.md) / LiveState
+
+# Enumeration: LiveState
+
+## Enumeration Members
+
+### CLOSED
+
+> **CLOSED**: `3`
+
+连接已关闭或者链接失败
+
+#### Defined in
+
+typings/live/LiveState.ts:20
+
+***
+
+### CONNECTING
+
+> **CONNECTING**: `0`
+
+正在链接中
+
+#### Defined in
+
+typings/live/LiveState.ts:10
+
+***
+
+### NOTINITIALIZED
+
+> **NOTINITIALIZED**: `-1`
+
+#### Defined in
+
+typings/live/LiveState.ts:5
+
+***
+
+### OPEN
+
+> **OPEN**: `1`
+
+已经链接并且可以通讯
+
+#### Defined in
+
+typings/live/LiveState.ts:15

package/docs/enumerations/MemUserStatus.md

@@ -0,0 +1,67 @@
+[**如视 Live SDK**](../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../globals.md) / MemUserStatus
+
+# Enumeration: MemUserStatus
+
+## Enumeration Members
+
+### BE\_REPLACE
+
+> **BE\_REPLACE**: `"BE_REPLACE"`
+
+#### Defined in
+
+typings/live/UserInfo.ts:24
+
+***
+
+### EXCEPTION
+
+> **EXCEPTION**: `"EXCEPTION"`
+
+#### Defined in
+
+typings/live/UserInfo.ts:25
+
+***
+
+### KICK\_OUT
+
+> **KICK\_OUT**: `"KICK_OUT"`
+
+#### Defined in
+
+typings/live/UserInfo.ts:23
+
+***
+
+### LEAVE
+
+> **LEAVE**: `"LEAVE"`
+
+#### Defined in
+
+typings/live/UserInfo.ts:22
+
+***
+
+### ONLINE
+
+> **ONLINE**: `"ONLINE"`
+
+#### Defined in
+
+typings/live/UserInfo.ts:21
+
+***
+
+### WAIT\_ENTER
+
+> **WAIT\_ENTER**: `"WAIT_ENTER"`
+
+#### Defined in
+
+typings/live/UserInfo.ts:20

package/docs/enumerations/MicroStatus.md

@@ -0,0 +1,33 @@
+[**如视 Live SDK**](../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../globals.md) / MicroStatus
+
+# Enumeration: MicroStatus
+
+麦克风状态。
+
+## Enumeration Members
+
+### CLOSE
+
+> **CLOSE**: `"CLOSE"`
+
+关闭
+
+#### Defined in
+
+typings/live/LiveMsg.ts:117
+
+***
+
+### OPEN
+
+> **OPEN**: `"OPEN"`
+
+打开
+
+#### Defined in
+
+typings/live/LiveMsg.ts:113

package/docs/enumerations/RTCJoinedInfoCodeEnum.md

@@ -0,0 +1,69 @@
+[**如视 Live SDK**](../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../globals.md) / RTCJoinedInfoCodeEnum
+
+# Enumeration: RTCJoinedInfoCodeEnum
+
+rtc加入返回值code枚举
+
+## Enumeration Members
+
+### Failure
+
+> **Failure**: `1`
+
+失败
+
+#### Defined in
+
+typings/rtc/joinedInfo.ts:12
+
+***
+
+### NoMicroPermission
+
+> **NoMicroPermission**: `3`
+
+无麦克风权限
+
+#### Defined in
+
+typings/rtc/joinedInfo.ts:20
+
+***
+
+### ReJoin
+
+> **ReJoin**: `2`
+
+重复加入
+
+#### Defined in
+
+typings/rtc/joinedInfo.ts:16
+
+***
+
+### Success
+
+> **Success**: `0`
+
+成功
+
+#### Defined in
+
+typings/rtc/joinedInfo.ts:8
+
+***
+
+### Unknown
+
+> **Unknown**: `500`
+
+未知异常
+
+#### Defined in
+
+typings/rtc/joinedInfo.ts:25

package/docs/enumerations/RTCType.md

@@ -0,0 +1,39 @@
+[**如视 Live SDK**](../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../globals.md) / RTCType
+
+# Enumeration: RTCType
+
+rtc 类型
+
+## Enumeration Members
+
+### RealseeBrowserChimeRTC
+
+> **RealseeBrowserChimeRTC**: `"RealseeBrowserChimeRTC"`
+
+#### Defined in
+
+typings/rtc/type.ts:7
+
+***
+
+### RealseeBrowserRTC
+
+> **RealseeBrowserRTC**: `"RealseeBrowserRTC"`
+
+#### Defined in
+
+typings/rtc/type.ts:5
+
+***
+
+### RealseeVRWebViewRTC
+
+> **RealseeVRWebViewRTC**: `"RealseeVRWebViewRTC"`
+
+#### Defined in
+
+typings/rtc/type.ts:6

package/docs/enumerations/UserStatus.md

@@ -0,0 +1,45 @@
+[**如视 Live SDK**](../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../globals.md) / UserStatus
+
+# Enumeration: UserStatus
+
+用户当前状态枚举。
+
+## Enumeration Members
+
+### Normal
+
+> **Normal**: `0`
+
+正常
+
+#### Defined in
+
+typings/live/UserInfo.ts:8
+
+***
+
+### Removed
+
+> **Removed**: `1`
+
+被移除
+
+#### Defined in
+
+typings/live/UserInfo.ts:12
+
+***
+
+### Replaced
+
+> **Replaced**: `2`
+
+被替换
+
+#### Defined in
+
+typings/live/UserInfo.ts:16

package/docs/enumerations/WebSocketCloseError.md

@@ -0,0 +1,117 @@
+[**如视 Live SDK**](../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../globals.md) / WebSocketCloseError
+
+# Enumeration: WebSocketCloseError
+
+WebSocket 异常关闭枚举：https://developer.mozilla.org/zh-CN/docs/Web/API/CloseEvent。
+
+## Enumeration Members
+
+### Err\_1000
+
+> **Err\_1000**: `"CLOSE_NORMAL"`
+
+正常关闭; 无论为何目的而创建，该链接都已成功完成任务。
+
+#### Defined in
+
+typings/live/WebSocket.ts:55
+
+***
+
+### Err\_1001
+
+> **Err\_1001**: `"CLOSE_GOING_AWAY"`
+
+终端离开, 可能因为服务端错误, 也可能因为浏览器正从打开连接的页面跳转离开。
+
+#### Defined in
+
+typings/live/WebSocket.ts:59
+
+***
+
+### Err\_1002
+
+> **Err\_1002**: `"CLOSE_PROTOCOL_ERROR"`
+
+由于协议错误而中断连接。
+
+#### Defined in
+
+typings/live/WebSocket.ts:64
+
+***
+
+### Err\_1003
+
+> **Err\_1003**: `"CLOSE_UNSUPPORTED"`
+
+由于接收到不允许的数据类型而断开连接 (如仅接收文本数据的终端接收到了二进制数据)。
+
+#### Defined in
+
+typings/live/WebSocket.ts:69
+
+***
+
+### Err\_1006
+
+> **Err\_1006**: `"CLOSE_ABNORMAL"`
+
+安全因素或WebSocket连接次数达到上限。
+
+#### Defined in
+
+typings/live/WebSocket.ts:74
+
+***
+
+### Err\_1007
+
+> **Err\_1007**: `"Unsupported Data"`
+
+由于收到了格式不符的数据而断开连接 (如文本消息中包含了非 UTF-8 数据)。
+
+#### Defined in
+
+typings/live/WebSocket.ts:79
+
+***
+
+### Err\_1008
+
+> **Err\_1008**: `"Policy Violation"`
+
+由于收到不符合约定的数据而断开连接。
+
+#### Defined in
+
+typings/live/WebSocket.ts:83
+
+***
+
+### Err\_1009
+
+> **Err\_1009**: `"CLOSE_TOO_LARGE"`
+
+由于收到过大的数据帧而断开连接。
+
+#### Defined in
+
+typings/live/WebSocket.ts:87
+
+***
+
+### Err\_unknown
+
+> **Err\_unknown**: `"unknown"`
+
+未知错误。
+
+#### Defined in
+
+typings/live/WebSocket.ts:91

package/docs/enumerations/WebSocketErrorType.md

@@ -0,0 +1,77 @@
+[**如视 Live SDK**](../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../globals.md) / WebSocketErrorType
+
+# Enumeration: WebSocketErrorType
+
+## Enumeration Members
+
+### Close
+
+> **Close**: `"Close"`
+
+#### Defined in
+
+typings/live/WebSocket.ts:40
+
+***
+
+### DuplicateConnect
+
+> **DuplicateConnect**: `"DuplicateConnect"`
+
+#### Defined in
+
+typings/live/WebSocket.ts:42
+
+***
+
+### Error
+
+> **Error**: `"Error"`
+
+#### Defined in
+
+typings/live/WebSocket.ts:39
+
+***
+
+### IllegalArgs
+
+> **IllegalArgs**: `"IllegalArgs"`
+
+#### Defined in
+
+typings/live/WebSocket.ts:45
+
+***
+
+### IllegalURL
+
+> **IllegalURL**: `"IllegalURL"`
+
+#### Defined in
+
+typings/live/WebSocket.ts:43
+
+***
+
+### MicroAuth
+
+> **MicroAuth**: `"MicroAuth"`
+
+#### Defined in
+
+typings/live/WebSocket.ts:41
+
+***
+
+### Unknown
+
+> **Unknown**: `"Unknown"`
+
+#### Defined in
+
+typings/live/WebSocket.ts:44