npm - @realsee/live - Versions diffs - 0.7.3-alpha.0 → 0.7.4 - Mend

@realsee/live 0.7.3-alpha.0 → 0.7.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (143) hide show

package/dist/index.cjs.js +3 -3
package/dist/index.cjs.js.map +1 -1
package/dist/index.d.ts +1 -0
package/dist/index.es.js +687 -130
package/dist/index.es.js.map +1 -1
package/dist/live/controller.d.ts +163 -42
package/dist/live/createLive.d.ts +35 -3
package/dist/live/createLiveReact.d.ts +51 -3
package/dist/live/live.d.ts +501 -50
package/dist/rtc/BrowserRTC.d.ts +63 -0
package/dist/rtc/BrowserRTC4Chime.d.ts +38 -2
package/dist/rtc/CoreRTC.d.ts +65 -1
package/dist/rtc/VRWebViewRTC.d.ts +56 -6
package/dist/typings/live/EventType.d.ts +58 -10
package/dist/typings/live/GetVoiceSign.d.ts +27 -7
package/dist/typings/live/UserInfo.d.ts +70 -0
package/dist/typings/rtc/eventType.d.ts +55 -8
package/dist/utils/appendUri.d.ts +17 -0
package/dist/utils/uuid.d.ts +11 -1
package/docs/.nojekyll +1 -0
package/docs/assets/highlight.css +127 -0
package/docs/assets/icons.js +18 -0
package/docs/assets/icons.svg +1 -0
package/docs/assets/main.js +60 -0
package/docs/assets/navigation.js +1 -0
package/docs/assets/search.js +1 -0
package/docs/assets/style.css +1493 -0
package/docs/classes/BrowserRTC.html +88 -0
package/docs/classes/BrowserRTC4Chime.html +100 -0
package/docs/classes/CoreRTC.html +65 -0
package/docs/classes/Live.html +249 -0
package/docs/classes/Subscribe.html +36 -0
package/docs/classes/VRWebViewRTC.html +72 -0
package/docs/enums/BuiltInRTCType.html +3 -0
package/docs/enums/BuiltinActionType.html +14 -0
package/docs/enums/BuiltinEventType.html +6 -0
package/docs/enums/Command.html +22 -0
package/docs/enums/LiveState.html +8 -0
package/docs/enums/MemUserStatus.html +15 -0
package/docs/enums/MicroStatus.html +6 -0
package/docs/enums/RTCJoinedInfoCodeEnum.html +12 -0
package/docs/enums/RTCType.html +5 -0
package/docs/enums/UserStatus.html +8 -0
package/docs/enums/WebSocketCloseError.html +20 -0
package/docs/enums/WebSocketErrorType.html +8 -0
package/docs/enums/WebSocketState.html +12 -0
package/docs/functions/GetVoiceSignFn.html +20 -0
package/docs/functions/_clearLiveInstanceIfNeed.html +1 -0
package/docs/functions/createLive.html +9 -0
package/docs/functions/createLiveReact.html +110 -0
package/docs/functions/parseLiveMsg.html +4 -0
package/docs/functions/parseWSClsErr.html +1 -0
package/docs/hierarchy.html +1 -0
package/docs/index.html +336 -0
package/docs/interfaces/AttendeeResponse.html +4 -0
package/docs/interfaces/LiveOptions.html +56 -0
package/docs/interfaces/MeetingResponse.html +3 -0
package/docs/interfaces/MeetingSessionConfigurationOptions.html +8 -0
package/docs/interfaces/Permission.html +31 -0
package/docs/interfaces/RTCJoinedInfo.html +7 -0
package/docs/interfaces/RTCProtocol.html +65 -0
package/docs/interfaces/SubscribeMixinType.emit.html +1 -0
package/docs/interfaces/SubscribeMixinType.hasListener.html +1 -0
package/docs/interfaces/SubscribeMixinType.off.html +1 -0
package/docs/interfaces/SubscribeMixinType.on.html +1 -0
package/docs/interfaces/SubscribeMixinType.once.html +1 -0
package/docs/interfaces/VRWebViewRTCOptions.html +22 -0
package/docs/modules/SubscribeMixinType.html +6 -0
package/docs/modules.html +55 -0
package/docs/types/BuiltinMsg.html +2 -0
package/docs/types/EventMap.html +1 -0
package/docs/types/EventType.html +2 -0
package/docs/types/GetVoiceSign.html +3 -0
package/docs/types/GetVoiceSignParams.html +5 -0
package/docs/types/GetVoiceSignReturnType.html +6 -0
package/docs/types/KeyframeEventType.html +2 -0
package/docs/types/LiveBuiltInData.html +1 -0
package/docs/types/LiveConnectOptions.html +8 -0
package/docs/types/LiveEventType.html +41 -0
package/docs/types/LiveMsg.html +2 -0
package/docs/types/LiveProviderPropTypes.html +5 -0
package/docs/types/RTCActionReactCallback.html +1 -0
package/docs/types/RTCEventType.html +29 -0
package/docs/types/ReqLiveMsg.html +6 -0
package/docs/types/RoomInfo.html +1 -0
package/docs/types/UserInfo.html +12 -0
package/docs/types/UserInfoExt.html +5 -0
package/docs/types/UserVolume.html +2 -0
package/docs/types/WebSocketError.html +1 -0
package/package.json +1 -2
package/docs/README.md +0 -437
package/docs/classes/BrowserRTC.md +0 -436
package/docs/classes/BrowserRTC4Chime.md +0 -558
package/docs/classes/CoreRTC.md +0 -448
package/docs/classes/Live.md +0 -770
package/docs/classes/VRWebViewRTC.md +0 -436
package/docs/enumerations/BuiltInRTCType.md +0 -27
package/docs/enumerations/BuiltinActionType.md +0 -81
package/docs/enumerations/BuiltinEventType.md +0 -33
package/docs/enumerations/Command.md +0 -107
package/docs/enumerations/LiveState.md +0 -53
package/docs/enumerations/MemUserStatus.md +0 -67
package/docs/enumerations/MicroStatus.md +0 -33
package/docs/enumerations/RTCJoinedInfoCodeEnum.md +0 -69
package/docs/enumerations/RTCType.md +0 -39
package/docs/enumerations/UserStatus.md +0 -45
package/docs/enumerations/WebSocketCloseError.md +0 -117
package/docs/enumerations/WebSocketErrorType.md +0 -77
package/docs/enumerations/WebSocketState.md +0 -69
package/docs/functions/GetVoiceSignFn.md +0 -27
package/docs/functions/clearLiveInstanceIfNeed.md +0 -17
package/docs/functions/createLive.md +0 -27
package/docs/functions/createLiveReact.md +0 -449
package/docs/functions/parseLiveMsg.md +0 -27
package/docs/functions/parseWSClsErr.md +0 -21
package/docs/globals.md +0 -71
package/docs/interfaces/AttendeeResponse.md +0 -37
package/docs/interfaces/LiveOptions.md +0 -246
package/docs/interfaces/MeetingResponse.md +0 -55
package/docs/interfaces/MeetingSessionConfigurationOptions.md +0 -93
package/docs/interfaces/Permission.md +0 -147
package/docs/interfaces/RTCJoinedInfo.md +0 -67
package/docs/interfaces/RTCProtocol.md +0 -404
package/docs/interfaces/VRWebViewRTCOptions.md +0 -41
package/docs/type-aliases/BuiltinMsg.md +0 -41
package/docs/type-aliases/EventType.md +0 -19
package/docs/type-aliases/GetVoiceSign.md +0 -15
package/docs/type-aliases/GetVoiceSignParams.md +0 -35
package/docs/type-aliases/GetVoiceSignReturnType.md +0 -41
package/docs/type-aliases/KeyframeEventType.md +0 -19
package/docs/type-aliases/LiveBuiltInData.md +0 -47
package/docs/type-aliases/LiveConnectOptions.md +0 -47
package/docs/type-aliases/LiveEventType.md +0 -165
package/docs/type-aliases/LiveMsg.md +0 -53
package/docs/type-aliases/LiveProviderPropTypes.md +0 -27
package/docs/type-aliases/RTCActionReactCallback.md +0 -13
package/docs/type-aliases/RTCEventType.md +0 -65
package/docs/type-aliases/ReqLiveMsg.md +0 -45
package/docs/type-aliases/RoomInfo.md +0 -55
package/docs/type-aliases/UserInfo.md +0 -77
package/docs/type-aliases/UserInfoExt.md +0 -33
package/docs/type-aliases/UserVolume.md +0 -25
package/docs/type-aliases/WebSocketError.md +0 -31

package/docs/enumerations/MemUserStatus.md DELETED Viewed

@@ -1,67 +0,0 @@
-[**如视 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 DELETED Viewed

@@ -1,33 +0,0 @@
-[**如视 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 DELETED Viewed

@@ -1,69 +0,0 @@
-[**如视 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 DELETED Viewed

@@ -1,39 +0,0 @@
-[**如视 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 DELETED Viewed

@@ -1,45 +0,0 @@
-[**如视 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 DELETED Viewed

@@ -1,117 +0,0 @@
-[**如视 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 DELETED Viewed

@@ -1,77 +0,0 @@
-[**如视 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

package/docs/enumerations/WebSocketState.md DELETED Viewed

@@ -1,69 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-***
-[如视 Live SDK](../globals.md) / WebSocketState
-# Enumeration: WebSocketState
-WebSocket 连接状态枚举
-## Enumeration Members
-### CLOSED
-> **CLOSED**: `3`
-连接已关闭或者没有链接成功
-#### Defined in
-typings/live/WebSocket.ts:28
-***
-### CLOSING
-> **CLOSING**: `2`
-连接正在关闭
-#### Defined in
-typings/live/WebSocket.ts:23
-***
-### CONNECTING
-> **CONNECTING**: `0`
-正在链接中
-#### Defined in
-typings/live/WebSocket.ts:13
-***
-### NOTINITIALIZED
-> **NOTINITIALIZED**: `-1`
-尚未初始化
-#### Defined in
-typings/live/WebSocket.ts:8
-***
-### OPEN
-> **OPEN**: `1`
-已经链接并且可以通讯
-#### Defined in
-typings/live/WebSocket.ts:18

package/docs/functions/GetVoiceSignFn.md DELETED Viewed

@@ -1,27 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-***
-[如视 Live SDK](../globals.md) / GetVoiceSignFn
-# Function: GetVoiceSignFn()
-> **GetVoiceSignFn**(`params`): `Promise`\<[`GetVoiceSignReturnType`](../type-aliases/GetVoiceSignReturnType.md)\>
-获取用户语音签名的方法
-## Parameters
-• **params**: [`GetVoiceSignParams`](../type-aliases/GetVoiceSignParams.md)
-获取语音签名所需的参数
-## Returns
-`Promise`\<[`GetVoiceSignReturnType`](../type-aliases/GetVoiceSignReturnType.md)\>
-返回一个Promise，解析为语音签名的相关信息
-## Defined in
-typings/live/GetVoiceSign.ts:50

package/docs/functions/clearLiveInstanceIfNeed.md DELETED Viewed

@@ -1,17 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-***
-[如视 Live SDK](../globals.md) / \_clearLiveInstanceIfNeed
-# Function: \_clearLiveInstanceIfNeed()
-> **\_clearLiveInstanceIfNeed**(): `void`
-## Returns
-`void`
-## Defined in
-live/live.ts:55

package/docs/functions/createLive.md DELETED Viewed

@@ -1,27 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-***
-[如视 Live SDK](../globals.md) / createLive
-# Function: createLive()
-> **createLive**\<`KeyframesSnapshot`\>(`opts`): [`Live`](../classes/Live.md)\<`KeyframesSnapshot`\>
-创建`Live`实例
-## Type Parameters
-• **KeyframesSnapshot** *extends* `Record`\<`string`, `any`\>
-## Parameters
-• **opts**: [`LiveOptions`](../interfaces/LiveOptions.md)
-## Returns
-[`Live`](../classes/Live.md)\<`KeyframesSnapshot`\>
-## Defined in
-live/createLive.ts:10