@tencentcloud/tuiroom-engine-js 3.2.2 → 3.2.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.
@@ -1,722 +0,0 @@
1
- import { TUIVideoQuality, TUIAudioQuality, TUIRole, TUIVideoStreamType, TUIRoomType, TUIMediaDevice, TUIResolutionMode, TUISeatMode } from '../types';
2
- export declare const TUIRoomEngineValidateConfig: {
3
- login: {
4
- name: string;
5
- required: boolean;
6
- type: string;
7
- properties: {
8
- sdkAppId: {
9
- required: boolean;
10
- type: string;
11
- allowEmpty: boolean;
12
- };
13
- userId: {
14
- required: boolean;
15
- type: string;
16
- allowEmpty: boolean;
17
- };
18
- userSig: {
19
- required: boolean;
20
- type: string;
21
- allowEmpty: boolean;
22
- };
23
- };
24
- };
25
- setSelfInfo: {
26
- name: string;
27
- required: boolean;
28
- type: string;
29
- properties: {
30
- userName: {
31
- required: boolean;
32
- type: string;
33
- };
34
- avatarUrl: {
35
- required: boolean;
36
- type: string;
37
- };
38
- customInfo: {
39
- required: boolean;
40
- type: string;
41
- allowEmpty: boolean;
42
- };
43
- };
44
- };
45
- createRoom: {
46
- name: string;
47
- required: boolean;
48
- type: string;
49
- properties: {
50
- roomId: {
51
- required: boolean;
52
- type: string;
53
- allowEmpty: boolean;
54
- };
55
- roomName: {
56
- type: string;
57
- allowEmpty: boolean;
58
- };
59
- roomType: {
60
- instanceof: typeof TUIRoomType;
61
- };
62
- isMicrophoneDisableForAllUser: {
63
- type: string;
64
- };
65
- isScreenShareDisableForAllUser: {
66
- type: string;
67
- };
68
- isCameraDisableForAllUser: {
69
- type: string;
70
- };
71
- isMessageDisableForAllUser: {
72
- type: string;
73
- };
74
- maxSeatCount: {
75
- type: string;
76
- };
77
- password: {
78
- type: string;
79
- };
80
- };
81
- };
82
- enterRoom: {
83
- name: string;
84
- required: boolean;
85
- type: string;
86
- properties: {
87
- roomId: {
88
- required: boolean;
89
- type: string;
90
- allowEmpty: boolean;
91
- };
92
- roomType: {
93
- instanceof: typeof TUIRoomType;
94
- };
95
- options: {
96
- type: string;
97
- properties: {
98
- password: {
99
- type: string;
100
- };
101
- };
102
- };
103
- };
104
- };
105
- updateRoomNameByAdmin: {
106
- name: string;
107
- require: boolean;
108
- type: string;
109
- properties: {
110
- roomName: {
111
- require: boolean;
112
- type: string;
113
- allowEmpty: boolean;
114
- };
115
- };
116
- };
117
- setRoomMaxSeatCount: {
118
- name: string;
119
- require: boolean;
120
- type: string;
121
- properties: {
122
- maxSeatCount: {
123
- require: boolean;
124
- type: string;
125
- };
126
- };
127
- };
128
- getUserList: {
129
- name: string;
130
- required: boolean;
131
- type: string;
132
- properties: {
133
- nextSequence: {
134
- type: string;
135
- };
136
- };
137
- };
138
- getUserInfo: {
139
- name: string;
140
- required: boolean;
141
- type: string;
142
- properties: {
143
- userId: {
144
- required: boolean;
145
- type: string;
146
- allowEmpty: boolean;
147
- };
148
- };
149
- };
150
- setCustomInfoForUser: {
151
- name: string;
152
- required: boolean;
153
- type: string;
154
- properties: {
155
- userId: {
156
- required: boolean;
157
- type: string;
158
- allowEmpty: boolean;
159
- };
160
- customInfo: {
161
- required: boolean;
162
- type: string;
163
- allowEmpty: boolean;
164
- };
165
- };
166
- };
167
- setRoomMetadataByAdmin: {
168
- name: string;
169
- required: boolean;
170
- type: string;
171
- properties: {
172
- metadata: {
173
- required: boolean;
174
- type: string;
175
- allowEmpty: boolean;
176
- };
177
- };
178
- };
179
- getRoomMetadata: {
180
- name: string;
181
- required: boolean;
182
- type: string;
183
- properties: {
184
- keys: {
185
- required: boolean;
186
- type: string;
187
- allowEmpty: boolean;
188
- };
189
- };
190
- };
191
- takeSeat: {
192
- name: string;
193
- required: boolean;
194
- type: string;
195
- properties: {
196
- seatIndex: {
197
- required: boolean;
198
- type: string;
199
- };
200
- timeout: {
201
- required: boolean;
202
- type: string;
203
- };
204
- requestCallback: {
205
- instanceof: FunctionConstructor;
206
- };
207
- };
208
- };
209
- getSeatList: {};
210
- openRemoteDeviceByAdmin: {
211
- name: string;
212
- required: boolean;
213
- type: string;
214
- properties: {
215
- userId: {
216
- required: boolean;
217
- type: string;
218
- allowEmpty: boolean;
219
- };
220
- timeout: {
221
- required: boolean;
222
- type: string;
223
- };
224
- device: {
225
- require: boolean;
226
- instanceof: typeof TUIMediaDevice;
227
- };
228
- };
229
- };
230
- closeRemoteDeviceByAdmin: {
231
- name: string;
232
- required: boolean;
233
- type: string;
234
- properties: {
235
- userId: {
236
- required: boolean;
237
- type: string;
238
- allowEmpty: boolean;
239
- };
240
- device: {
241
- required: boolean;
242
- instanceof: typeof TUIMediaDevice;
243
- };
244
- };
245
- };
246
- takeUserOnSeatByAdmin: {
247
- name: string;
248
- required: boolean;
249
- type: string;
250
- properties: {
251
- seatIndex: {
252
- required: boolean;
253
- type: string;
254
- };
255
- userId: {
256
- required: boolean;
257
- type: string;
258
- allowEmpty: boolean;
259
- };
260
- timeout: {
261
- required: boolean;
262
- type: string;
263
- };
264
- requestCallback: {
265
- instanceof: FunctionConstructor;
266
- };
267
- };
268
- };
269
- kickUserOffSeatByAdmin: {
270
- name: string;
271
- required: boolean;
272
- type: string;
273
- properties: {
274
- seatIndex: {
275
- required: boolean;
276
- type: string;
277
- };
278
- userId: {
279
- required: boolean;
280
- type: string;
281
- allowEmpty: boolean;
282
- };
283
- };
284
- };
285
- cancelRequest: {
286
- name: string;
287
- required: boolean;
288
- type: string;
289
- properties: {
290
- requestId: {
291
- required: boolean;
292
- type: string;
293
- allowEmpty: boolean;
294
- };
295
- };
296
- };
297
- responseRemoteRequest: {
298
- name: string;
299
- required: boolean;
300
- type: string;
301
- properties: {
302
- requestId: {
303
- required: boolean;
304
- type: string;
305
- allowEmpty: boolean;
306
- };
307
- agree: {
308
- required: boolean;
309
- type: string;
310
- };
311
- };
312
- };
313
- setLocalVideoView: {
314
- name: string;
315
- required: boolean;
316
- type: string;
317
- properties: {
318
- view: {
319
- required: boolean;
320
- type: string[];
321
- allowEmpty: boolean;
322
- validate: (value: any) => void;
323
- };
324
- };
325
- };
326
- openLocalCamera: {
327
- name: string;
328
- type: string;
329
- properties: {
330
- isFrontCamera: {
331
- type: string;
332
- allowEmpty: boolean;
333
- };
334
- };
335
- };
336
- closeLocalCamera: {};
337
- openLocalMicrophone: {};
338
- closeLocalMicrophone: {};
339
- setVideoResolutionMode: {
340
- name: string;
341
- required: boolean;
342
- type: string;
343
- properties: {
344
- streamType: {
345
- required: boolean;
346
- instanceof: typeof TUIVideoStreamType;
347
- };
348
- resolutionMode: {
349
- required: boolean;
350
- instanceof: typeof TUIResolutionMode;
351
- };
352
- };
353
- };
354
- updateVideoQuality: {
355
- name: string;
356
- required: boolean;
357
- type: string;
358
- properties: {
359
- quality: {
360
- required: boolean;
361
- instanceof: typeof TUIVideoQuality;
362
- };
363
- };
364
- };
365
- updateVideoQualityEx: {
366
- name: string;
367
- required: boolean;
368
- type: string;
369
- properties: {
370
- streamType: {
371
- required: boolean;
372
- instanceof: typeof TUIVideoStreamType;
373
- };
374
- encoderParams: {
375
- required: boolean;
376
- properties: {
377
- quality: {
378
- instanceof: typeof TUIVideoQuality;
379
- };
380
- fps: {
381
- type: string;
382
- };
383
- bitrate: {
384
- type: string;
385
- };
386
- resolutionMode: {
387
- instanceof: typeof TUIResolutionMode;
388
- };
389
- };
390
- };
391
- };
392
- };
393
- updateAudioQuality: {
394
- name: string;
395
- required: boolean;
396
- type: string;
397
- properties: {
398
- quality: {
399
- required: boolean;
400
- instanceof: typeof TUIAudioQuality;
401
- };
402
- };
403
- };
404
- muteRemoteAudioStream: {
405
- name: string;
406
- required: boolean;
407
- type: string;
408
- properties: {
409
- userId: {
410
- required: boolean;
411
- type: string;
412
- allowEmpty: boolean;
413
- };
414
- isMute: {
415
- required: boolean;
416
- type: string;
417
- };
418
- };
419
- };
420
- startPushLocalVideo: {};
421
- stopPushLocalVideo: {};
422
- setRemoteVideoView: {
423
- name: string;
424
- required: boolean;
425
- type: string;
426
- properties: {
427
- userId: {
428
- required: boolean;
429
- type: string;
430
- allowEmpty: boolean;
431
- };
432
- streamType: {
433
- required: boolean;
434
- instanceof: typeof TUIVideoStreamType;
435
- };
436
- view: {
437
- required: boolean;
438
- type: string[];
439
- allowEmpty: boolean;
440
- };
441
- };
442
- };
443
- startPlayRemoteVideo: {
444
- name: string;
445
- required: boolean;
446
- type: string;
447
- properties: {
448
- userId: {
449
- required: boolean;
450
- type: string;
451
- allowEmpty: boolean;
452
- };
453
- streamType: {
454
- required: boolean;
455
- instanceof: typeof TUIVideoStreamType;
456
- };
457
- };
458
- };
459
- stopPlayRemoteVideo: {
460
- name: string;
461
- required: boolean;
462
- type: string;
463
- properties: {
464
- userId: {
465
- required: boolean;
466
- type: string;
467
- allowEmpty: boolean;
468
- };
469
- streamType: {
470
- required: boolean;
471
- instanceof: typeof TUIVideoStreamType;
472
- };
473
- };
474
- };
475
- changeUserRole: {
476
- name: string;
477
- required: boolean;
478
- type: string;
479
- properties: {
480
- userId: {
481
- required: boolean;
482
- type: string;
483
- allowEmpty: boolean;
484
- };
485
- userRole: {
486
- required: boolean;
487
- instanceof: typeof TUIRole;
488
- };
489
- };
490
- };
491
- changeUserNameCard: {
492
- name: string;
493
- required: boolean;
494
- type: string;
495
- properties: {
496
- userId: {
497
- required: boolean;
498
- type: string;
499
- allowEmpty: boolean;
500
- };
501
- nameCard: {
502
- required: boolean;
503
- type: string;
504
- };
505
- };
506
- };
507
- kickRemoteUserOutOfRoom: {
508
- name: string;
509
- required: boolean;
510
- type: string;
511
- properties: {
512
- userId: {
513
- required: boolean;
514
- type: string;
515
- allowEmpty: boolean;
516
- };
517
- };
518
- };
519
- sendTextMessage: {
520
- name: string;
521
- required: boolean;
522
- type: string;
523
- properties: {
524
- messageText: {
525
- require: boolean;
526
- type: string;
527
- allowEmpty: boolean;
528
- };
529
- };
530
- };
531
- sendCustomMessage: {
532
- name: string;
533
- required: boolean;
534
- type: string;
535
- properties: {
536
- messageText: {
537
- require: boolean;
538
- type: string;
539
- allowEmpty: boolean;
540
- };
541
- };
542
- };
543
- startScreenSharing: {
544
- name: string;
545
- type: string;
546
- properties: {
547
- screenAudio: {
548
- type: string;
549
- };
550
- view: {
551
- type: string;
552
- };
553
- };
554
- };
555
- stopScreenSharing: {};
556
- startScreenSharingElectron: {
557
- name: string;
558
- required: boolean;
559
- type: string[];
560
- properties: {
561
- targetId: {
562
- require: boolean;
563
- type: string;
564
- };
565
- view: {
566
- type: string;
567
- };
568
- };
569
- };
570
- selectScreenSharingTarget: {
571
- name: string;
572
- required: boolean;
573
- type: string[];
574
- properties: {
575
- targetId: {
576
- require: boolean;
577
- type: string;
578
- };
579
- };
580
- };
581
- setCurrentCameraDevice: {
582
- name: string;
583
- required: boolean;
584
- type: string;
585
- properties: {
586
- deviceId: {
587
- require: boolean;
588
- type: string;
589
- };
590
- };
591
- };
592
- setCurrentMicDevice: {
593
- name: string;
594
- required: boolean;
595
- type: string;
596
- properties: {
597
- deviceId: {
598
- require: boolean;
599
- type: string;
600
- };
601
- };
602
- };
603
- setCurrentSpeakerDevice: {
604
- name: string;
605
- required: boolean;
606
- type: string;
607
- properties: {
608
- deviceId: {
609
- require: boolean;
610
- type: string;
611
- };
612
- };
613
- };
614
- disableDeviceForAllUserByAdmin: {
615
- name: string;
616
- required: boolean;
617
- type: string;
618
- properties: {
619
- isDisable: {
620
- require: boolean;
621
- type: string;
622
- };
623
- device: {
624
- require: boolean;
625
- instanceof: typeof TUIMediaDevice;
626
- };
627
- };
628
- };
629
- disableSendingMessageForAllUser: {
630
- name: string;
631
- required: boolean;
632
- type: string;
633
- properties: {
634
- isDisable: {
635
- require: boolean;
636
- type: string;
637
- };
638
- };
639
- };
640
- disableSendingMessageByAdmin: {
641
- name: string;
642
- required: boolean;
643
- type: string;
644
- properties: {
645
- userId: {
646
- require: boolean;
647
- instanceof: string;
648
- };
649
- isDisable: {
650
- require: boolean;
651
- type: string;
652
- };
653
- };
654
- };
655
- updateRoomSeatModeByAdmin: {
656
- name: string;
657
- required: boolean;
658
- type: string;
659
- properties: {
660
- seatMode: {
661
- require: boolean;
662
- instanceof: typeof TUISeatMode;
663
- };
664
- };
665
- };
666
- updateRoomPasswordByAdmin: {
667
- name: string;
668
- required: boolean;
669
- type: string;
670
- properties: {
671
- password: {
672
- required: boolean;
673
- type: string;
674
- allowEmpty: boolean;
675
- };
676
- };
677
- };
678
- applyToAdminToOpenLocalDevice: {
679
- name: string;
680
- required: boolean;
681
- type: string;
682
- properties: {
683
- timeout: {
684
- required: boolean;
685
- type: string;
686
- };
687
- device: {
688
- require: boolean;
689
- instanceof: typeof TUIMediaDevice;
690
- };
691
- };
692
- };
693
- lockSeatByAdmin: {
694
- name: string;
695
- required: boolean;
696
- type: string;
697
- properties: {
698
- seatIndex: {
699
- required: boolean;
700
- type: string;
701
- };
702
- lockParams: {
703
- require: boolean;
704
- type: string;
705
- properties: {
706
- lockSeat: {
707
- require: boolean;
708
- type: string;
709
- };
710
- lockVideo: {
711
- require: boolean;
712
- type: string;
713
- };
714
- lockAudio: {
715
- require: boolean;
716
- type: string;
717
- };
718
- };
719
- };
720
- };
721
- };
722
- };