@realsee/live 0.6.15 → 0.7.0
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.
- package/README.md +50 -55
- package/dist/index.cjs.js +89 -24
- package/dist/index.d.cts +1336 -0
- package/dist/index.d.ts +1336 -5
- package/dist/index.esm.js +30 -0
- package/docs/README.md +435 -0
- package/docs/classes/BrowserRTC.md +436 -0
- package/docs/classes/BrowserRTC4Chime.md +558 -0
- package/docs/classes/CoreRTC.md +448 -0
- package/docs/classes/Live.md +797 -0
- package/docs/classes/Subscribe.md +211 -0
- package/docs/classes/VRWebViewRTC.md +436 -0
- package/docs/enumerations/BuiltInRTCType.md +27 -0
- package/docs/enumerations/BuiltinActionType.md +81 -0
- package/docs/enumerations/BuiltinEventType.md +33 -0
- package/docs/enumerations/Command.md +107 -0
- package/docs/enumerations/LiveState.md +53 -0
- package/docs/enumerations/MemUserStatus.md +67 -0
- package/docs/enumerations/MicroStatus.md +33 -0
- package/docs/enumerations/RTCJoinedInfoCodeEnum.md +69 -0
- package/docs/enumerations/RTCType.md +39 -0
- package/docs/enumerations/UserStatus.md +45 -0
- package/docs/enumerations/WebSocketCloseError.md +117 -0
- package/docs/enumerations/WebSocketErrorType.md +77 -0
- package/docs/enumerations/WebSocketState.md +69 -0
- package/docs/functions/GetVoiceSignFn.md +27 -0
- package/docs/functions/clearLiveInstanceIfNeed.md +17 -0
- package/docs/functions/createLive.md +27 -0
- package/docs/functions/createLiveReact.md +449 -0
- package/docs/functions/parseLiveMsg.md +27 -0
- package/docs/functions/parseWSClsErr.md +21 -0
- package/docs/globals.md +77 -0
- package/docs/interfaces/AttendeeResponse.md +37 -0
- package/docs/interfaces/LiveOptions.md +246 -0
- package/docs/interfaces/MeetingResponse.md +55 -0
- package/docs/interfaces/MeetingSessionConfigurationOptions.md +93 -0
- package/docs/interfaces/Permission.md +147 -0
- package/docs/interfaces/RTCJoinedInfo.md +67 -0
- package/docs/interfaces/RTCProtocol.md +404 -0
- package/docs/interfaces/VRWebViewRTCOptions.md +41 -0
- package/docs/namespaces/SubscribeMixinType/README.md +17 -0
- package/docs/namespaces/SubscribeMixinType/interfaces/emit.md +31 -0
- package/docs/namespaces/SubscribeMixinType/interfaces/hasListener.md +25 -0
- package/docs/namespaces/SubscribeMixinType/interfaces/off.md +31 -0
- package/docs/namespaces/SubscribeMixinType/interfaces/on.md +37 -0
- package/docs/namespaces/SubscribeMixinType/interfaces/once.md +35 -0
- package/docs/type-aliases/BuiltinMsg.md +41 -0
- package/docs/type-aliases/EventMap.md +17 -0
- package/docs/type-aliases/EventType.md +19 -0
- package/docs/type-aliases/GetVoiceSign.md +15 -0
- package/docs/type-aliases/GetVoiceSignParams.md +35 -0
- package/docs/type-aliases/GetVoiceSignReturnType.md +41 -0
- package/docs/type-aliases/KeyframeEventType.md +19 -0
- package/docs/type-aliases/LiveBuiltInData.md +47 -0
- package/docs/type-aliases/LiveConnectOptions.md +47 -0
- package/docs/type-aliases/LiveEventType.md +165 -0
- package/docs/type-aliases/LiveMsg.md +53 -0
- package/docs/type-aliases/LiveProviderPropTypes.md +27 -0
- package/docs/type-aliases/RTCActionReactCallback.md +13 -0
- package/docs/type-aliases/RTCEventType.md +65 -0
- package/docs/type-aliases/ReqLiveMsg.md +45 -0
- package/docs/type-aliases/RoomInfo.md +55 -0
- package/docs/type-aliases/UserInfo.md +77 -0
- package/docs/type-aliases/UserInfoExt.md +33 -0
- package/docs/type-aliases/UserVolume.md +25 -0
- package/docs/type-aliases/WebSocketError.md +31 -0
- package/package.json +41 -31
- package/dist/index.cjs.js.map +0 -1
- package/dist/index.es.js +0 -2328
- package/dist/index.es.js.map +0 -1
- package/dist/live/controller.d.ts +0 -118
- package/dist/live/createLive.d.ts +0 -8
- package/dist/live/createLiveReact.d.ts +0 -52
- package/dist/live/live.d.ts +0 -182
- package/dist/rtc/BrowserRTC.d.ts +0 -39
- package/dist/rtc/BrowserRTC4Chime.d.ts +0 -60
- package/dist/rtc/CoreRTC.d.ts +0 -23
- package/dist/rtc/VRWebViewRTC.d.ts +0 -97
- package/dist/rtc/index.d.ts +0 -5
- package/dist/typings/chime/AttendeeResponse.d.ts +0 -5
- package/dist/typings/chime/MeetingResponse.d.ts +0 -12
- package/dist/typings/chime/MeetingSessionConfigurationOptions.d.ts +0 -16
- package/dist/typings/chime/index.d.ts +0 -3
- package/dist/typings/index.d.ts +0 -4
- package/dist/typings/live/EventType.d.ts +0 -74
- package/dist/typings/live/GetVoiceSign.d.ts +0 -45
- package/dist/typings/live/LiveConnectOptions.d.ts +0 -24
- package/dist/typings/live/LiveMsg.d.ts +0 -133
- package/dist/typings/live/LiveOptions.d.ts +0 -79
- package/dist/typings/live/LiveState.d.ts +0 -15
- package/dist/typings/live/RoomInfo.d.ts +0 -13
- package/dist/typings/live/UserInfo.d.ts +0 -103
- package/dist/typings/live/UserVolume.d.ts +0 -7
- package/dist/typings/live/WebSocket.d.ts +0 -82
- package/dist/typings/live/index.d.ts +0 -10
- package/dist/typings/react/RTCActionReactCallback.d.ts +0 -2
- package/dist/typings/react/index.d.ts +0 -1
- package/dist/typings/rtc/VRWebViewRTCOptions.d.ts +0 -6
- package/dist/typings/rtc/eventType.d.ts +0 -44
- package/dist/typings/rtc/index.d.ts +0 -5
- package/dist/typings/rtc/joinedInfo.d.ts +0 -38
- package/dist/typings/rtc/protocol.d.ts +0 -62
- package/dist/typings/rtc/type.d.ts +0 -12
- package/dist/utils/RobustWebSocket.d.ts +0 -160
- package/dist/utils/appendUri.d.ts +0 -1
- package/dist/utils/clientDetector.d.ts +0 -4
- package/dist/utils/equal.d.ts +0 -10
- package/dist/utils/logger.d.ts +0 -16
- package/dist/utils/subscribe.d.ts +0 -75
- package/dist/utils/uuid.d.ts +0 -4
- package/docs/.nojekyll +0 -1
- package/docs/assets/highlight.css +0 -120
- package/docs/assets/main.js +0 -58
- package/docs/assets/search.js +0 -1
- package/docs/assets/style.css +0 -1280
- package/docs/classes/BrowserRTC.html +0 -561
- package/docs/classes/BrowserRTC4Chime.html +0 -602
- package/docs/classes/CoreRTC.html +0 -432
- package/docs/classes/Live.html +0 -812
- package/docs/classes/VRWebViewRTC.html +0 -639
- package/docs/enums/BuiltInRTCType.html +0 -69
- package/docs/enums/BuiltinActionType.html +0 -112
- package/docs/enums/BuiltinEventType.html +0 -76
- package/docs/enums/Command.html +0 -134
- package/docs/enums/LiveState.html +0 -89
- package/docs/enums/MemUserStatus.html +0 -97
- package/docs/enums/MicroStatus.html +0 -76
- package/docs/enums/RTCJoinedInfoCodeEnum.html +0 -103
- package/docs/enums/RTCType.html +0 -79
- package/docs/enums/UserStatus.html +0 -85
- package/docs/enums/WebSocketCloseError.html +0 -139
- package/docs/enums/WebSocketErrorType.html +0 -104
- package/docs/enums/WebSocketState.html +0 -103
- package/docs/functions/_clearLiveInstanceIfNeed.html +0 -98
- package/docs/functions/createLive.html +0 -111
- package/docs/functions/createLiveReact.html +0 -579
- package/docs/functions/parseLiveMsg.html +0 -109
- package/docs/functions/parseWSClsErr.html +0 -103
- package/docs/index.html +0 -474
- package/docs/interfaces/AttendeeResponse.html +0 -80
- package/docs/interfaces/LiveOptions.html +0 -272
- package/docs/interfaces/MeetingResponse.html +0 -90
- package/docs/interfaces/MeetingSessionConfigurationOptions.html +0 -119
- package/docs/interfaces/Permission.html +0 -157
- package/docs/interfaces/RTCJoinedInfo.html +0 -104
- package/docs/interfaces/RTCProtocol.html +0 -424
- package/docs/interfaces/VRWebViewRTCOptions.html +0 -73
- package/docs/modules.html +0 -156
- package/docs/types/BuiltinMsg.html +0 -112
- package/docs/types/EventType.html +0 -101
- package/docs/types/GetVoiceSign.html +0 -109
- package/docs/types/GetVoiceSignParams.html +0 -111
- package/docs/types/GetVoiceSignReturnType.html +0 -115
- package/docs/types/KeyframeTypes.html +0 -101
- package/docs/types/LiveBuiltInData.html +0 -117
- package/docs/types/LiveConnectOptions.html +0 -123
- package/docs/types/LiveEventType.html +0 -276
- package/docs/types/LiveMsg.html +0 -117
- package/docs/types/LiveProviderPropTypes.html +0 -106
- package/docs/types/RTCActionReactCallback.html +0 -94
- package/docs/types/RTCEventType.html +0 -210
- package/docs/types/ReqLiveMsg.html +0 -118
- package/docs/types/RoomInfo.html +0 -118
- package/docs/types/UserInfo.html +0 -139
- package/docs/types/UserInfoExt.html +0 -109
- package/docs/types/UserVolume.html +0 -103
- package/docs/types/WebSocketError.html +0 -105
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
[**如视 Live SDK**](../README.md) • **Docs**
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[如视 Live SDK](../globals.md) / UserInfoExt
|
|
6
|
+
|
|
7
|
+
# Type Alias: UserInfoExt
|
|
8
|
+
|
|
9
|
+
> **UserInfoExt**: `object`
|
|
10
|
+
|
|
11
|
+
用户信息扩展字段:比如提供用户画像相关的数据。
|
|
12
|
+
|
|
13
|
+
## Index Signature
|
|
14
|
+
|
|
15
|
+
\[`key`: `string`\]: `any`
|
|
16
|
+
|
|
17
|
+
## Type declaration
|
|
18
|
+
|
|
19
|
+
### avatar?
|
|
20
|
+
|
|
21
|
+
> `optional` **avatar**: `string`
|
|
22
|
+
|
|
23
|
+
用户头像。
|
|
24
|
+
|
|
25
|
+
### nickname?
|
|
26
|
+
|
|
27
|
+
> `optional` **nickname**: `string`
|
|
28
|
+
|
|
29
|
+
用户昵称。
|
|
30
|
+
|
|
31
|
+
## Defined in
|
|
32
|
+
|
|
33
|
+
typings/live/UserInfo.ts:31
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
[**如视 Live SDK**](../README.md) • **Docs**
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[如视 Live SDK](../globals.md) / UserVolume
|
|
6
|
+
|
|
7
|
+
# Type Alias: UserVolume
|
|
8
|
+
|
|
9
|
+
> **UserVolume**: `object`
|
|
10
|
+
|
|
11
|
+
用户的音量信息。
|
|
12
|
+
|
|
13
|
+
## Type declaration
|
|
14
|
+
|
|
15
|
+
### audioVolume
|
|
16
|
+
|
|
17
|
+
> **audioVolume**: `number`
|
|
18
|
+
|
|
19
|
+
### userId
|
|
20
|
+
|
|
21
|
+
> **userId**: `string`
|
|
22
|
+
|
|
23
|
+
## Defined in
|
|
24
|
+
|
|
25
|
+
typings/live/UserVolume.ts:4
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
[**如视 Live SDK**](../README.md) • **Docs**
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[如视 Live SDK](../globals.md) / WebSocketError
|
|
6
|
+
|
|
7
|
+
# Type Alias: WebSocketError
|
|
8
|
+
|
|
9
|
+
> **WebSocketError**: `object`
|
|
10
|
+
|
|
11
|
+
## Type declaration
|
|
12
|
+
|
|
13
|
+
### closeError?
|
|
14
|
+
|
|
15
|
+
> `optional` **closeError**: [`WebSocketCloseError`](../enumerations/WebSocketCloseError.md)
|
|
16
|
+
|
|
17
|
+
### error?
|
|
18
|
+
|
|
19
|
+
> `optional` **error**: `any`
|
|
20
|
+
|
|
21
|
+
### target?
|
|
22
|
+
|
|
23
|
+
> `optional` **target**: `Event` \| `CloseEvent`
|
|
24
|
+
|
|
25
|
+
### type
|
|
26
|
+
|
|
27
|
+
> **type**: [`WebSocketErrorType`](../enumerations/WebSocketErrorType.md)
|
|
28
|
+
|
|
29
|
+
## Defined in
|
|
30
|
+
|
|
31
|
+
typings/live/WebSocket.ts:31
|
package/package.json
CHANGED
|
@@ -1,49 +1,59 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@realsee/live",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.7.0",
|
|
4
4
|
"description": "如视 Live SDK:基于如视 WebSocket 长链双工通信能力的前端封装,借助此 SDK 您可以快捷地实现具备同屏连线、实时语音的 VR 带看业务能力。",
|
|
5
|
-
"
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
"
|
|
9
|
-
"
|
|
10
|
-
"prepack": "npm run build && npm run docs"
|
|
5
|
+
"author": "BEIKE REALSEE TECHNOLOGY (HK) LIMITED",
|
|
6
|
+
"license": "SEE LICENSE IN TERMS.txt",
|
|
7
|
+
"publishConfig": {
|
|
8
|
+
"access": "public",
|
|
9
|
+
"registry": "https://registry.npmjs.org/"
|
|
11
10
|
},
|
|
12
|
-
"
|
|
13
|
-
"
|
|
14
|
-
"
|
|
11
|
+
"type": "module",
|
|
12
|
+
"types": "./dist/index.d.ts",
|
|
13
|
+
"main": "./dist/index.cjs.js",
|
|
14
|
+
"import": "./dist/index.esm.js",
|
|
15
15
|
"sideEffects": false,
|
|
16
16
|
"files": [
|
|
17
|
-
"docs",
|
|
18
17
|
"dist",
|
|
18
|
+
"docs",
|
|
19
19
|
"TERMS.txt"
|
|
20
20
|
],
|
|
21
|
+
"exports": {
|
|
22
|
+
".": {
|
|
23
|
+
"types": "./dist/index.d.ts",
|
|
24
|
+
"import": "./dist/index.esm.js",
|
|
25
|
+
"default": "./dist/index.cjs.js"
|
|
26
|
+
}
|
|
27
|
+
},
|
|
28
|
+
"scripts": {
|
|
29
|
+
"dev": "tsup --watch",
|
|
30
|
+
"build": "tsup",
|
|
31
|
+
"docs": "npx typedoc",
|
|
32
|
+
"prepublishOnly": "npm run build && npm run docs",
|
|
33
|
+
"prepack": "npm run build && npm run docs"
|
|
34
|
+
},
|
|
21
35
|
"devDependencies": {
|
|
22
|
-
"@realsee/jsbridge-x": "0.2.
|
|
23
|
-
"@types/react": "18
|
|
24
|
-
"
|
|
25
|
-
"
|
|
26
|
-
"
|
|
27
|
-
"react": "18.2.0",
|
|
28
|
-
"terser": "5.16.5",
|
|
36
|
+
"@realsee/jsbridge-x": "0.2.11",
|
|
37
|
+
"@types/react": "^18",
|
|
38
|
+
"amazon-chime-sdk-js": "3.24.0",
|
|
39
|
+
"esbuild-plugin-wasm": "1.1.0",
|
|
40
|
+
"react": "^18",
|
|
29
41
|
"trtc-js-sdk": "4.15.5",
|
|
30
|
-
"
|
|
31
|
-
"
|
|
32
|
-
"
|
|
33
|
-
"
|
|
42
|
+
"tsup": "8.3.0",
|
|
43
|
+
"typedoc": "0.26.9",
|
|
44
|
+
"typedoc-plugin-markdown": "4.2.9",
|
|
45
|
+
"typescript": "5.6.3",
|
|
46
|
+
"yjs": "13.6.20"
|
|
34
47
|
},
|
|
35
48
|
"peerDependencies": {
|
|
36
49
|
"@realsee/jsbridge-x": ">=0.2.6",
|
|
37
|
-
"@types/react": "
|
|
38
|
-
"react": ">=17.0.0",
|
|
39
|
-
"amazon-chime-sdk-js": ">=3.0.0",
|
|
50
|
+
"@types/react": "^18",
|
|
40
51
|
"@types/trtc-js-sdk": ">=4.9.0",
|
|
52
|
+
"amazon-chime-sdk-js": ">=3.0.0",
|
|
53
|
+
"react": "^18",
|
|
41
54
|
"trtc-js-sdk": ">=4.15.3"
|
|
42
55
|
},
|
|
43
|
-
"
|
|
44
|
-
"
|
|
45
|
-
|
|
46
|
-
},
|
|
47
|
-
"author": "BEIKE REALSEE TECHNOLOGY (HK) LIMITED",
|
|
48
|
-
"license": "SEE LICENSE IN TERMS.txt"
|
|
56
|
+
"dependencies": {
|
|
57
|
+
"lib0": "0.2.98"
|
|
58
|
+
}
|
|
49
59
|
}
|