@realsee/live 0.7.2 → 0.7.3-alpha.1
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/LICENSE-UPDATE.txt +5 -0
- package/README.md +5 -3
- package/TERMS.txt +87 -24
- package/dist/index.cjs.js +3 -3
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.es.js +1785 -1781
- package/dist/index.es.js.map +1 -1
- package/docs/README.md +5 -3
- package/docs/classes/BrowserRTC.md +2 -2
- package/docs/classes/BrowserRTC4Chime.md +1 -1
- package/docs/classes/CoreRTC.md +1 -1
- package/docs/classes/Live.md +30 -30
- package/docs/classes/VRWebViewRTC.md +1 -1
- package/docs/functions/clearLiveInstanceIfNeed.md +1 -1
- package/docs/interfaces/RTCProtocol.md +1 -1
- package/docs/type-aliases/LiveBuiltInData.md +1 -1
- package/package.json +1 -1
package/docs/README.md
CHANGED
|
@@ -57,7 +57,7 @@ const live = createLive({
|
|
|
57
57
|
在创建 `live` 实例时配置了两个参数:
|
|
58
58
|
|
|
59
59
|
- `url`:连接 WebSocket 服务的 URL,如果在创建 `live` 实例阶段并不知道 URL ,您可以在合适的时机通过 `live.connect({ url })` 方法进行 WebScoket 连接。
|
|
60
|
-
- `getTicket()`:是一个异步回调函数,其返回值是连接 WebScoket 服务的 **"门票"**,关于如何获取 `ticket` 请查阅 [VR 带看 API]()。
|
|
60
|
+
- `getTicket()`:是一个异步回调函数,其返回值是连接 WebScoket 服务的 **"门票"**,关于如何获取 `ticket` 请查阅 [VR 带看 API](https://developers.realsee.com/docs/#/docs/live/server/README)。
|
|
61
61
|
|
|
62
62
|
> 关于 `createLive()` 函数的更多参数配置请参考 [LiveOptions](https://unpkg.com/@realsee/live/docs/interfaces/live.LiveOptions.html) 。
|
|
63
63
|
|
|
@@ -200,7 +200,7 @@ live.on('ws.readyStateUpdate', (readyState: WebSocketState) => {
|
|
|
200
200
|
|
|
201
201
|
- `weakNetwork(): void` 弱网提醒事件。
|
|
202
202
|
|
|
203
|
-
`live.$RTC` 实例需满足 [RTC 协议](),其事件通过 `live.$RTC.on('/*事件名*/', /*事件回调*/)` 方式来监听,比如监听语音房间内正在说话的用户及其音量:
|
|
203
|
+
`live.$RTC` 实例需满足 [RTC 协议](https://unpkg.com/@realsee/live/docs/interfaces/rtc.RTCProtocol.html),其事件通过 `live.$RTC.on('/*事件名*/', /*事件回调*/)` 方式来监听,比如监听语音房间内正在说话的用户及其音量:
|
|
204
204
|
|
|
205
205
|
```ts
|
|
206
206
|
live.$RTC.on('userVolumes', (userVolumes: UserVolume[]) => {
|
|
@@ -305,8 +305,10 @@ yarn add trtc-js-sdk
|
|
|
305
305
|
```tsx
|
|
306
306
|
import { createLive, BrowserRTC } from '@realsee/live'
|
|
307
307
|
|
|
308
|
-
const rtcInstance = new
|
|
308
|
+
const rtcInstance = new BrowserRTC({
|
|
309
309
|
getVoiceSign: () => {},
|
|
310
|
+
// 可选:处理自动播放策略
|
|
311
|
+
// autoPlayConfirm: ({ onConfirm }) => showDialogThen(onConfirm)
|
|
310
312
|
})
|
|
311
313
|
|
|
312
314
|
const live = createLive({
|
|
@@ -174,7 +174,7 @@ canceled 是否被触发取消
|
|
|
174
174
|
|
|
175
175
|
#### Defined in
|
|
176
176
|
|
|
177
|
-
utils/subscribe.ts:
|
|
177
|
+
utils/subscribe.ts:115
|
|
178
178
|
|
|
179
179
|
***
|
|
180
180
|
|
|
@@ -405,7 +405,7 @@ rtc/BrowserRTC.ts:121
|
|
|
405
405
|
|
|
406
406
|
#### Defined in
|
|
407
407
|
|
|
408
|
-
rtc/BrowserRTC.ts:
|
|
408
|
+
rtc/BrowserRTC.ts:174
|
|
409
409
|
|
|
410
410
|
***
|
|
411
411
|
|
package/docs/classes/CoreRTC.md
CHANGED
package/docs/classes/Live.md
CHANGED
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
|
|
35
35
|
#### Defined in
|
|
36
36
|
|
|
37
|
-
live/live.ts:
|
|
37
|
+
live/live.ts:124
|
|
38
38
|
|
|
39
39
|
## Properties
|
|
40
40
|
|
|
@@ -46,7 +46,7 @@ live/live.ts:123
|
|
|
46
46
|
|
|
47
47
|
#### Defined in
|
|
48
48
|
|
|
49
|
-
live/live.ts:
|
|
49
|
+
live/live.ts:112
|
|
50
50
|
|
|
51
51
|
## Accessors
|
|
52
52
|
|
|
@@ -62,7 +62,7 @@ live/live.ts:111
|
|
|
62
62
|
|
|
63
63
|
#### Defined in
|
|
64
64
|
|
|
65
|
-
live/live.ts:
|
|
65
|
+
live/live.ts:98
|
|
66
66
|
|
|
67
67
|
***
|
|
68
68
|
|
|
@@ -78,7 +78,7 @@ live/live.ts:97
|
|
|
78
78
|
|
|
79
79
|
#### Defined in
|
|
80
80
|
|
|
81
|
-
live/live.ts:
|
|
81
|
+
live/live.ts:105
|
|
82
82
|
|
|
83
83
|
***
|
|
84
84
|
|
|
@@ -92,7 +92,7 @@ live/live.ts:104
|
|
|
92
92
|
|
|
93
93
|
#### Defined in
|
|
94
94
|
|
|
95
|
-
live/live.ts:
|
|
95
|
+
live/live.ts:68
|
|
96
96
|
|
|
97
97
|
***
|
|
98
98
|
|
|
@@ -112,7 +112,7 @@ live/live.ts:67
|
|
|
112
112
|
|
|
113
113
|
#### Defined in
|
|
114
114
|
|
|
115
|
-
live/live.ts:
|
|
115
|
+
live/live.ts:83
|
|
116
116
|
|
|
117
117
|
***
|
|
118
118
|
|
|
@@ -128,7 +128,7 @@ live/live.ts:82
|
|
|
128
128
|
|
|
129
129
|
#### Defined in
|
|
130
130
|
|
|
131
|
-
live/live.ts:
|
|
131
|
+
live/live.ts:234
|
|
132
132
|
|
|
133
133
|
***
|
|
134
134
|
|
|
@@ -144,7 +144,7 @@ live/live.ts:233
|
|
|
144
144
|
|
|
145
145
|
#### Defined in
|
|
146
146
|
|
|
147
|
-
live/live.ts:
|
|
147
|
+
live/live.ts:220
|
|
148
148
|
|
|
149
149
|
***
|
|
150
150
|
|
|
@@ -160,7 +160,7 @@ live/live.ts:219
|
|
|
160
160
|
|
|
161
161
|
#### Defined in
|
|
162
162
|
|
|
163
|
-
live/live.ts:
|
|
163
|
+
live/live.ts:142
|
|
164
164
|
|
|
165
165
|
***
|
|
166
166
|
|
|
@@ -176,7 +176,7 @@ live/live.ts:141
|
|
|
176
176
|
|
|
177
177
|
#### Defined in
|
|
178
178
|
|
|
179
|
-
live/live.ts:
|
|
179
|
+
live/live.ts:75
|
|
180
180
|
|
|
181
181
|
***
|
|
182
182
|
|
|
@@ -196,7 +196,7 @@ live/live.ts:74
|
|
|
196
196
|
|
|
197
197
|
#### Defined in
|
|
198
198
|
|
|
199
|
-
live/live.ts:
|
|
199
|
+
live/live.ts:91
|
|
200
200
|
|
|
201
201
|
***
|
|
202
202
|
|
|
@@ -212,7 +212,7 @@ live/live.ts:90
|
|
|
212
212
|
|
|
213
213
|
#### Defined in
|
|
214
214
|
|
|
215
|
-
live/live.ts:
|
|
215
|
+
live/live.ts:227
|
|
216
216
|
|
|
217
217
|
## Methods
|
|
218
218
|
|
|
@@ -228,7 +228,7 @@ live/live.ts:226
|
|
|
228
228
|
|
|
229
229
|
#### Defined in
|
|
230
230
|
|
|
231
|
-
live/live.ts:
|
|
231
|
+
live/live.ts:602
|
|
232
232
|
|
|
233
233
|
***
|
|
234
234
|
|
|
@@ -246,7 +246,7 @@ live/live.ts:604
|
|
|
246
246
|
|
|
247
247
|
#### Defined in
|
|
248
248
|
|
|
249
|
-
live/live.ts:
|
|
249
|
+
live/live.ts:150
|
|
250
250
|
|
|
251
251
|
***
|
|
252
252
|
|
|
@@ -260,7 +260,7 @@ live/live.ts:149
|
|
|
260
260
|
|
|
261
261
|
#### Defined in
|
|
262
262
|
|
|
263
|
-
live/live.ts:
|
|
263
|
+
live/live.ts:146
|
|
264
264
|
|
|
265
265
|
***
|
|
266
266
|
|
|
@@ -292,7 +292,7 @@ live/live.ts:145
|
|
|
292
292
|
|
|
293
293
|
#### Defined in
|
|
294
294
|
|
|
295
|
-
live/live.ts:
|
|
295
|
+
live/live.ts:693
|
|
296
296
|
|
|
297
297
|
***
|
|
298
298
|
|
|
@@ -310,7 +310,7 @@ live/live.ts:688
|
|
|
310
310
|
|
|
311
311
|
#### Defined in
|
|
312
312
|
|
|
313
|
-
live/live.ts:
|
|
313
|
+
live/live.ts:624
|
|
314
314
|
|
|
315
315
|
***
|
|
316
316
|
|
|
@@ -334,7 +334,7 @@ live/live.ts:626
|
|
|
334
334
|
|
|
335
335
|
#### Defined in
|
|
336
336
|
|
|
337
|
-
live/live.ts:
|
|
337
|
+
live/live.ts:552
|
|
338
338
|
|
|
339
339
|
***
|
|
340
340
|
|
|
@@ -350,7 +350,7 @@ live/live.ts:554
|
|
|
350
350
|
|
|
351
351
|
#### Defined in
|
|
352
352
|
|
|
353
|
-
live/live.ts:
|
|
353
|
+
live/live.ts:639
|
|
354
354
|
|
|
355
355
|
***
|
|
356
356
|
|
|
@@ -388,7 +388,7 @@ canceled 是否被触发取消
|
|
|
388
388
|
|
|
389
389
|
#### Defined in
|
|
390
390
|
|
|
391
|
-
utils/subscribe.ts:
|
|
391
|
+
utils/subscribe.ts:115
|
|
392
392
|
|
|
393
393
|
***
|
|
394
394
|
|
|
@@ -404,7 +404,7 @@ utils/subscribe.ts:113
|
|
|
404
404
|
|
|
405
405
|
#### Defined in
|
|
406
406
|
|
|
407
|
-
live/live.ts:
|
|
407
|
+
live/live.ts:618
|
|
408
408
|
|
|
409
409
|
***
|
|
410
410
|
|
|
@@ -426,7 +426,7 @@ live/live.ts:620
|
|
|
426
426
|
|
|
427
427
|
#### Defined in
|
|
428
428
|
|
|
429
|
-
live/live.ts:
|
|
429
|
+
live/live.ts:752
|
|
430
430
|
|
|
431
431
|
***
|
|
432
432
|
|
|
@@ -448,7 +448,7 @@ live/live.ts:747
|
|
|
448
448
|
|
|
449
449
|
#### Defined in
|
|
450
450
|
|
|
451
|
-
live/live.ts:
|
|
451
|
+
live/live.ts:777
|
|
452
452
|
|
|
453
453
|
***
|
|
454
454
|
|
|
@@ -474,7 +474,7 @@ live/live.ts:772
|
|
|
474
474
|
|
|
475
475
|
#### Defined in
|
|
476
476
|
|
|
477
|
-
live/live.ts:
|
|
477
|
+
live/live.ts:189
|
|
478
478
|
|
|
479
479
|
***
|
|
480
480
|
|
|
@@ -498,7 +498,7 @@ live/live.ts:188
|
|
|
498
498
|
|
|
499
499
|
#### Defined in
|
|
500
500
|
|
|
501
|
-
live/live.ts:
|
|
501
|
+
live/live.ts:821
|
|
502
502
|
|
|
503
503
|
***
|
|
504
504
|
|
|
@@ -544,7 +544,7 @@ utils/subscribe.ts:41
|
|
|
544
544
|
|
|
545
545
|
#### Defined in
|
|
546
546
|
|
|
547
|
-
live/live.ts:
|
|
547
|
+
live/live.ts:799
|
|
548
548
|
|
|
549
549
|
***
|
|
550
550
|
|
|
@@ -703,7 +703,7 @@ utils/subscribe.ts:74
|
|
|
703
703
|
|
|
704
704
|
#### Defined in
|
|
705
705
|
|
|
706
|
-
live/live.ts:
|
|
706
|
+
live/live.ts:198
|
|
707
707
|
|
|
708
708
|
***
|
|
709
709
|
|
|
@@ -723,7 +723,7 @@ live/live.ts:197
|
|
|
723
723
|
|
|
724
724
|
#### Defined in
|
|
725
725
|
|
|
726
|
-
live/live.ts:
|
|
726
|
+
live/live.ts:683
|
|
727
727
|
|
|
728
728
|
***
|
|
729
729
|
|
|
@@ -741,7 +741,7 @@ live/live.ts:678
|
|
|
741
741
|
|
|
742
742
|
#### Defined in
|
|
743
743
|
|
|
744
|
-
live/live.ts:
|
|
744
|
+
live/live.ts:728
|
|
745
745
|
|
|
746
746
|
***
|
|
747
747
|
|
|
@@ -767,4 +767,4 @@ live/live.ts:723
|
|
|
767
767
|
|
|
768
768
|
#### Defined in
|
|
769
769
|
|
|
770
|
-
live/live.ts:
|
|
770
|
+
live/live.ts:660
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@realsee/live",
|
|
3
|
-
"version": "0.7.
|
|
3
|
+
"version": "0.7.3-alpha.1",
|
|
4
4
|
"description": "如视 Live SDK:基于如视 WebSocket 长链双工通信能力的前端封装,借助此 SDK 您可以快捷地实现具备同屏连线、实时语音的 VR 带看业务能力。",
|
|
5
5
|
"author": "BEIKE REALSEE TECHNOLOGY (HK) LIMITED",
|
|
6
6
|
"license": "SEE LICENSE IN TERMS.txt",
|