@tencentcloud/sdk-mcp 1.1.2 → 1.1.3

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,2656 +0,0 @@
1
- atomicx-core SDK 是腾讯云最新推出的面向即时通信、音视频通话、视频直播、语聊房等场景的全新一代基于响应式的 API,您可以非常快速的基于这组 API 构建自己的 UI 页面,它支持房间管理、屏幕分享、成员管理、麦位控制、基础美颜等丰富功能,同时基于 TRTC SDK,能够提供超低延时、高品质的音视频体验,本页面包含 atomicx-core SDK 的所有 API 接口,按功能模块分类展示。
2
-
3
- ## LoginState
4
-
5
- 用户身份认证与登录管理模块
6
- - 核心功能:提供用户登录、登出、个人信息管理等基础身份认证功能,是整个系统的用户身份基础。
7
-
8
- - 技术特点:支持多种登录方式、用户信息缓存、登录状态持久化等功能,确保用户身份的安全性和可靠性。
9
-
10
- - 业务价值:为所有业务模块提供统一的用户身份认证服务,是系统安全和用户体验的基础保障。
11
-
12
- - 应用场景:用户登录、身份验证、个人信息管理、权限控制等核心身份认证场景。
13
-
14
-
15
- **响应式数据**
16
-
17
- <table>
18
- <tr>
19
- <td rowspan="1" colSpan="1" >**数据列表**</td>
20
-
21
- <td rowspan="1" colSpan="1" >**描述**</td>
22
- </tr>
23
-
24
- <tr>
25
- <td rowspan="1" colSpan="1" >[loginUserInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#loginUserInfo)</td>
26
-
27
- <td rowspan="1" colSpan="1" >当前登录用户信息。</td>
28
- </tr>
29
- </table>
30
-
31
-
32
- **接口函数**
33
-
34
- <table>
35
- <tr>
36
- <td rowspan="1" colSpan="1" >**函数列表**</td>
37
-
38
- <td rowspan="1" colSpan="1" >**描述**</td>
39
- </tr>
40
-
41
- <tr>
42
- <td rowspan="1" colSpan="1" >[login](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#login)</td>
43
-
44
- <td rowspan="1" colSpan="1" >用户登录。</td>
45
- </tr>
46
-
47
- <tr>
48
- <td rowspan="1" colSpan="1" >[setSelfInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setSelfInfo)</td>
49
-
50
- <td rowspan="1" colSpan="1" >设置用户个人信息。</td>
51
- </tr>
52
-
53
- <tr>
54
- <td rowspan="1" colSpan="1" >[logout](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#logout)</td>
55
-
56
- <td rowspan="1" colSpan="1" >用户登出函数。</td>
57
- </tr>
58
- </table>
59
-
60
-
61
- ## DeviceState
62
-
63
- 设备状态管理模块
64
- - 核心功能:管理摄像头、麦克风等音视频设备的控制,提供设备状态监控、权限检查等基础设备服务。
65
-
66
- - 技术特点:支持多设备管理、设备状态实时监控、权限动态检查、设备故障自动恢复等高级功能。
67
-
68
- - 业务价值:为直播系统提供稳定的设备基础,确保音视频采集的可靠性和用户体验。
69
-
70
- - 应用场景:设备管理、权限控制、音视频采集、设备故障处理等基础技术场景。
71
-
72
-
73
- **响应式数据**
74
-
75
- <table>
76
- <tr>
77
- <td rowspan="1" colSpan="1" >**数据列表**</td>
78
-
79
- <td rowspan="1" colSpan="1" >**描述**</td>
80
- </tr>
81
-
82
- <tr>
83
- <td rowspan="1" colSpan="1" >[microphoneStatus](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#microphoneStatus)</td>
84
-
85
- <td rowspan="1" colSpan="1" >麦克风状态。</td>
86
- </tr>
87
-
88
- <tr>
89
- <td rowspan="1" colSpan="1" >[microphoneList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#microphoneList)</td>
90
-
91
- <td rowspan="1" colSpan="1" >麦克风设备列表。</td>
92
- </tr>
93
-
94
- <tr>
95
- <td rowspan="1" colSpan="1" >[currentMicrophone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentMicrophone)</td>
96
-
97
- <td rowspan="1" colSpan="1" >当前选中的麦克风设备。</td>
98
- </tr>
99
-
100
- <tr>
101
- <td rowspan="1" colSpan="1" >[microphoneLastError](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#microphoneLastError)</td>
102
-
103
- <td rowspan="1" colSpan="1" >麦克风最后一次错误信息。</td>
104
- </tr>
105
-
106
- <tr>
107
- <td rowspan="1" colSpan="1" >[captureVolume](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#captureVolume)</td>
108
-
109
- <td rowspan="1" colSpan="1" >麦克风采集音量。</td>
110
- </tr>
111
-
112
- <tr>
113
- <td rowspan="1" colSpan="1" >[currentMicVolume](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentMicVolume)</td>
114
-
115
- <td rowspan="1" colSpan="1" >当前麦克风音量。</td>
116
- </tr>
117
-
118
- <tr>
119
- <td rowspan="1" colSpan="1" >[isMicrophoneTesting](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isMicrophoneTesting)</td>
120
-
121
- <td rowspan="1" colSpan="1" >麦克风测试状态。</td>
122
- </tr>
123
-
124
- <tr>
125
- <td rowspan="1" colSpan="1" >[testingMicVolume](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#testingMicVolume)</td>
126
-
127
- <td rowspan="1" colSpan="1" >测试时的麦克风音量。</td>
128
- </tr>
129
-
130
- <tr>
131
- <td rowspan="1" colSpan="1" >[cameraStatus](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#cameraStatus)</td>
132
-
133
- <td rowspan="1" colSpan="1" >摄像头状态。</td>
134
- </tr>
135
-
136
- <tr>
137
- <td rowspan="1" colSpan="1" >[cameraList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#cameraList)</td>
138
-
139
- <td rowspan="1" colSpan="1" >摄像头设备列表。</td>
140
- </tr>
141
-
142
- <tr>
143
- <td rowspan="1" colSpan="1" >[currentCamera](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentCamera)</td>
144
-
145
- <td rowspan="1" colSpan="1" >当前选中的摄像头设备。</td>
146
- </tr>
147
-
148
- <tr>
149
- <td rowspan="1" colSpan="1" >[cameraLastError](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#cameraLastError)</td>
150
-
151
- <td rowspan="1" colSpan="1" >摄像头最后一次错误信息。</td>
152
- </tr>
153
-
154
- <tr>
155
- <td rowspan="1" colSpan="1" >[isCameraTesting](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isCameraTesting)</td>
156
-
157
- <td rowspan="1" colSpan="1" >摄像头测试状态。</td>
158
- </tr>
159
-
160
- <tr>
161
- <td rowspan="1" colSpan="1" >[isCameraTestLoading](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isCameraTestLoading)</td>
162
-
163
- <td rowspan="1" colSpan="1" >摄像头测试加载状态。</td>
164
- </tr>
165
-
166
- <tr>
167
- <td rowspan="1" colSpan="1" >[isFrontCamera](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isFrontCamera)</td>
168
-
169
- <td rowspan="1" colSpan="1" >是否为前置摄像头。</td>
170
- </tr>
171
-
172
- <tr>
173
- <td rowspan="1" colSpan="1" >[localMirrorType](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#localMirrorType)</td>
174
-
175
- <td rowspan="1" colSpan="1" >本地视频镜像类型。</td>
176
- </tr>
177
-
178
- <tr>
179
- <td rowspan="1" colSpan="1" >[localVideoQuality](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#localVideoQuality)</td>
180
-
181
- <td rowspan="1" colSpan="1" >本地视频质量。</td>
182
- </tr>
183
-
184
- <tr>
185
- <td rowspan="1" colSpan="1" >[speakerList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#speakerList)</td>
186
-
187
- <td rowspan="1" colSpan="1" >扬声器设备列表。</td>
188
- </tr>
189
-
190
- <tr>
191
- <td rowspan="1" colSpan="1" >[currentSpeaker](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentSpeaker)</td>
192
-
193
- <td rowspan="1" colSpan="1" >当前选中的扬声器设备。</td>
194
- </tr>
195
-
196
- <tr>
197
- <td rowspan="1" colSpan="1" >[outputVolume](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#outputVolume)</td>
198
-
199
- <td rowspan="1" colSpan="1" >扬声器输出音量。</td>
200
- </tr>
201
-
202
- <tr>
203
- <td rowspan="1" colSpan="1" >[currentAudioRoute](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentAudioRoute)</td>
204
-
205
- <td rowspan="1" colSpan="1" >当前音频路由。</td>
206
- </tr>
207
-
208
- <tr>
209
- <td rowspan="1" colSpan="1" >[isSpeakerTesting](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isSpeakerTesting)</td>
210
-
211
- <td rowspan="1" colSpan="1" >扬声器测试状态。</td>
212
- </tr>
213
-
214
- <tr>
215
- <td rowspan="1" colSpan="1" >[screenStatus](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#screenStatus)</td>
216
-
217
- <td rowspan="1" colSpan="1" >屏幕分享状态。</td>
218
- </tr>
219
-
220
- <tr>
221
- <td rowspan="1" colSpan="1" >[networkInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#networkInfo)</td>
222
-
223
- <td rowspan="1" colSpan="1" >网络信息。</td>
224
- </tr>
225
- </table>
226
-
227
-
228
- **接口函数**
229
-
230
- <table>
231
- <tr>
232
- <td rowspan="1" colSpan="1" >**函数列表**</td>
233
-
234
- <td rowspan="1" colSpan="1" >**描述**</td>
235
- </tr>
236
-
237
- <tr>
238
- <td rowspan="1" colSpan="1" >[openLocalMicrophone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#openLocalMicrophone)</td>
239
-
240
- <td rowspan="1" colSpan="1" >开启本地麦克风。</td>
241
- </tr>
242
-
243
- <tr>
244
- <td rowspan="1" colSpan="1" >[closeLocalMicrophone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#closeLocalMicrophone)</td>
245
-
246
- <td rowspan="1" colSpan="1" >关闭本地麦克风。</td>
247
- </tr>
248
-
249
- <tr>
250
- <td rowspan="1" colSpan="1" >[muteLocalAudio](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#muteLocalAudio)</td>
251
-
252
- <td rowspan="1" colSpan="1" >静音本地音频。</td>
253
- </tr>
254
-
255
- <tr>
256
- <td rowspan="1" colSpan="1" >[unmuteLocalAudio](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#unmuteLocalAudio)</td>
257
-
258
- <td rowspan="1" colSpan="1" >取消静音本地音频。</td>
259
- </tr>
260
-
261
- <tr>
262
- <td rowspan="1" colSpan="1" >[getMicrophoneList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getMicrophoneList)</td>
263
-
264
- <td rowspan="1" colSpan="1" >获取麦克风设备列表。</td>
265
- </tr>
266
-
267
- <tr>
268
- <td rowspan="1" colSpan="1" >[setCurrentMicrophone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setCurrentMicrophone)</td>
269
-
270
- <td rowspan="1" colSpan="1" >设置当前麦克风设备。</td>
271
- </tr>
272
-
273
- <tr>
274
- <td rowspan="1" colSpan="1" >[startMicrophoneTest](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#startMicrophoneTest)</td>
275
-
276
- <td rowspan="1" colSpan="1" >开始麦克风测试。</td>
277
- </tr>
278
-
279
- <tr>
280
- <td rowspan="1" colSpan="1" >[setCaptureVolume](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setCaptureVolume)</td>
281
-
282
- <td rowspan="1" colSpan="1" >设置音频采集音量。</td>
283
- </tr>
284
-
285
- <tr>
286
- <td rowspan="1" colSpan="1" >[setOutputVolume](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setOutputVolume)</td>
287
-
288
- <td rowspan="1" colSpan="1" >设置音频播放音量。</td>
289
- </tr>
290
-
291
- <tr>
292
- <td rowspan="1" colSpan="1" >[stopMicrophoneTest](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#stopMicrophoneTest)</td>
293
-
294
- <td rowspan="1" colSpan="1" >停止麦克风测试。</td>
295
- </tr>
296
-
297
- <tr>
298
- <td rowspan="1" colSpan="1" >[getSpeakerList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getSpeakerList)</td>
299
-
300
- <td rowspan="1" colSpan="1" >获取扬声器设备列表。</td>
301
- </tr>
302
-
303
- <tr>
304
- <td rowspan="1" colSpan="1" >[setCurrentSpeaker](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setCurrentSpeaker)</td>
305
-
306
- <td rowspan="1" colSpan="1" >设置当前扬声器设备。</td>
307
- </tr>
308
-
309
- <tr>
310
- <td rowspan="1" colSpan="1" >[setAudioRoute](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setAudioRoute)</td>
311
-
312
- <td rowspan="1" colSpan="1" >设置音频路由。</td>
313
- </tr>
314
-
315
- <tr>
316
- <td rowspan="1" colSpan="1" >[startSpeakerTest](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#startSpeakerTest)</td>
317
-
318
- <td rowspan="1" colSpan="1" >开始扬声器测试。</td>
319
- </tr>
320
-
321
- <tr>
322
- <td rowspan="1" colSpan="1" >[stopSpeakerTest](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#stopSpeakerTest)</td>
323
-
324
- <td rowspan="1" colSpan="1" >停止扬声器测试。</td>
325
- </tr>
326
-
327
- <tr>
328
- <td rowspan="1" colSpan="1" >[openLocalCamera](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#openLocalCamera)</td>
329
-
330
- <td rowspan="1" colSpan="1" >开启本地摄像头。</td>
331
- </tr>
332
-
333
- <tr>
334
- <td rowspan="1" colSpan="1" >[closeLocalCamera](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#closeLocalCamera)</td>
335
-
336
- <td rowspan="1" colSpan="1" >关闭本地摄像头。</td>
337
- </tr>
338
-
339
- <tr>
340
- <td rowspan="1" colSpan="1" >[getCameraList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getCameraList)</td>
341
-
342
- <td rowspan="1" colSpan="1" >获取摄像头设备列表。</td>
343
- </tr>
344
-
345
- <tr>
346
- <td rowspan="1" colSpan="1" >[setCurrentCamera](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setCurrentCamera)</td>
347
-
348
- <td rowspan="1" colSpan="1" >设置当前摄像头设备。</td>
349
- </tr>
350
-
351
- <tr>
352
- <td rowspan="1" colSpan="1" >[switchCamera](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#switchCamera)</td>
353
-
354
- <td rowspan="1" colSpan="1" >切换前后摄像头。</td>
355
- </tr>
356
-
357
- <tr>
358
- <td rowspan="1" colSpan="1" >[switchMirror](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#switchMirror)</td>
359
-
360
- <td rowspan="1" colSpan="1" >切换视频镜像模式。</td>
361
- </tr>
362
-
363
- <tr>
364
- <td rowspan="1" colSpan="1" >[updateVideoQuality](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#updateVideoQuality)</td>
365
-
366
- <td rowspan="1" colSpan="1" >更新视频质量。</td>
367
- </tr>
368
-
369
- <tr>
370
- <td rowspan="1" colSpan="1" >[startCameraDeviceTest](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#startCameraDeviceTest)</td>
371
-
372
- <td rowspan="1" colSpan="1" >开始摄像头设备测试。</td>
373
- </tr>
374
-
375
- <tr>
376
- <td rowspan="1" colSpan="1" >[startScreenShare](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#startScreenShare)</td>
377
-
378
- <td rowspan="1" colSpan="1" >开始屏幕分享。</td>
379
- </tr>
380
-
381
- <tr>
382
- <td rowspan="1" colSpan="1" >[stopScreenShare](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#stopScreenShare)</td>
383
-
384
- <td rowspan="1" colSpan="1" >停止屏幕分享。</td>
385
- </tr>
386
-
387
- <tr>
388
- <td rowspan="1" colSpan="1" >[stopCameraDeviceTest](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#stopCameraDeviceTest)</td>
389
-
390
- <td rowspan="1" colSpan="1" >停止摄像头设备测试。</td>
391
- </tr>
392
-
393
- <tr>
394
- <td rowspan="1" colSpan="1" >[screenCaptureStopped](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#screenCaptureStopped)</td>
395
-
396
- <td rowspan="1" colSpan="1" >屏幕分享停止回调。</td>
397
- </tr>
398
- </table>
399
-
400
-
401
- ## LiveListState
402
-
403
- 直播列表管理模块
404
- - 核心功能:管理直播间的完整生命周期,包括创建、加入、离开、结束等核心业务流程,支持直播列表的分页获取和实时更新。
405
-
406
- - 技术特点:支持分页加载、实时状态同步、直播信息动态更新,采用响应式数据管理,确保 UI 与数据状态实时同步。新增 liveList 和 liveListCursor 响应式数据,提供 fetchLiveList 接口函数。
407
-
408
- - 业务价值:为直播平台提供核心的直播间管理能力,支持大规模并发直播场景,是直播业务的基础设施。
409
-
410
- - 应用场景:直播列表展示、直播间创建、直播状态管理、直播数据统计等核心业务场景。
411
-
412
-
413
- **响应式数据**
414
-
415
- <table>
416
- <tr>
417
- <td rowspan="1" colSpan="1" >**数据列表**</td>
418
-
419
- <td rowspan="1" colSpan="1" >**描述**</td>
420
- </tr>
421
-
422
- <tr>
423
- <td rowspan="1" colSpan="1" >[currentLive](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentLive)</td>
424
-
425
- <td rowspan="1" colSpan="1" >转换TUILiveInfo为LiveInfo格式。</td>
426
- </tr>
427
-
428
- <tr>
429
- <td rowspan="1" colSpan="1" >[liveList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#liveList)</td>
430
-
431
- <td rowspan="1" colSpan="1" >直播列表数据,包含所有直播间的信息。</td>
432
- </tr>
433
-
434
- <tr>
435
- <td rowspan="1" colSpan="1" >[liveListCursor](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#liveListCursor)</td>
436
-
437
- <td rowspan="1" colSpan="1" >直播列表分页游标,用于获取下一页数据。</td>
438
- </tr>
439
- </table>
440
-
441
-
442
- **接口函数**
443
-
444
- <table>
445
- <tr>
446
- <td rowspan="1" colSpan="1" >**函数列表**</td>
447
-
448
- <td rowspan="1" colSpan="1" >**描述**</td>
449
- </tr>
450
-
451
- <tr>
452
- <td rowspan="1" colSpan="1" >[createLive](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#createLive)</td>
453
-
454
- <td rowspan="1" colSpan="1" >创建直播间。</td>
455
- </tr>
456
-
457
- <tr>
458
- <td rowspan="1" colSpan="1" >[joinLive](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#joinLive)</td>
459
-
460
- <td rowspan="1" colSpan="1" >加入直播间。</td>
461
- </tr>
462
-
463
- <tr>
464
- <td rowspan="1" colSpan="1" >[leaveLive](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#leaveLive)</td>
465
-
466
- <td rowspan="1" colSpan="1" >离开直播间。</td>
467
- </tr>
468
-
469
- <tr>
470
- <td rowspan="1" colSpan="1" >[endLive](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#endLive)</td>
471
-
472
- <td rowspan="1" colSpan="1" >结束直播。</td>
473
- </tr>
474
-
475
- <tr>
476
- <td rowspan="1" colSpan="1" >[updateLiveInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#updateLiveInfo)</td>
477
-
478
- <td rowspan="1" colSpan="1" >更新直播间信息。</td>
479
- </tr>
480
-
481
- <tr>
482
- <td rowspan="1" colSpan="1" >[queryMetaData](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#queryMetaData)</td>
483
-
484
- <td rowspan="1" colSpan="1" >查询元数据。</td>
485
- </tr>
486
-
487
- <tr>
488
- <td rowspan="1" colSpan="1" >[updateLiveMetaData](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#updateLiveMetaData)</td>
489
-
490
- <td rowspan="1" colSpan="1" >更新直播间元数据。</td>
491
- </tr>
492
-
493
- <tr>
494
- <td rowspan="1" colSpan="1" >[fetchLiveList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#fetchLiveList)</td>
495
-
496
- <td rowspan="1" colSpan="1" >获取直播列表。</td>
497
- </tr>
498
- </table>
499
-
500
-
501
- ## LiveSeatState
502
-
503
- 直播间座位管理模块
504
- - 核心功能:实现多人连麦场景下的座位控制,支持复杂的座位状态管理和音视频设备控制,包括上麦、下麦、座位锁定等完整功能。
505
-
506
- - 技术特点:基于 WebRTC 技术,支持多路音视频流管理,提供座位锁定、设备控制、权限管理等高级功能。新增 seatList、canvas、speakingUsers、networkQualities 响应式数据,以及完整的座位操作接口。
507
-
508
- - 业务价值:为多人互动直播提供核心技术支撑,支持 PK、连麦、多人游戏等丰富的互动场景。
509
-
510
- - 应用场景:多人连麦、主播 PK、互动游戏、在线教育、会议直播等需要多人音视频互动的场景。
511
-
512
-
513
- **响应式数据**
514
-
515
- <table>
516
- <tr>
517
- <td rowspan="1" colSpan="1" >**数据列表**</td>
518
-
519
- <td rowspan="1" colSpan="1" >**描述**</td>
520
- </tr>
521
-
522
- <tr>
523
- <td rowspan="1" colSpan="1" >[seatList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#seatList)</td>
524
-
525
- <td rowspan="1" colSpan="1" >麦位列表,包含所有麦位的状态和用户信息。</td>
526
- </tr>
527
-
528
- <tr>
529
- <td rowspan="1" colSpan="1" >[canvas](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#canvas)</td>
530
-
531
- <td rowspan="1" colSpan="1" >画布配置,用于视频渲染和布局管理。</td>
532
- </tr>
533
-
534
- <tr>
535
- <td rowspan="1" colSpan="1" >[speakingUsers](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#speakingUsers)</td>
536
-
537
- <td rowspan="1" colSpan="1" >正在发言的用户列表。</td>
538
- </tr>
539
-
540
- <tr>
541
- <td rowspan="1" colSpan="1" >[networkQualities](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#networkQualities)</td>
542
-
543
- <td rowspan="1" colSpan="1" >网络质量信息,包含各用户的网络状态。</td>
544
- </tr>
545
- </table>
546
-
547
-
548
- **接口函数**
549
-
550
- <table>
551
- <tr>
552
- <td rowspan="1" colSpan="1" >**函数列表**</td>
553
-
554
- <td rowspan="1" colSpan="1" >**描述**</td>
555
- </tr>
556
-
557
- <tr>
558
- <td rowspan="1" colSpan="1" >[takeSeat](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#takeSeat)</td>
559
-
560
- <td rowspan="1" colSpan="1" >用户上麦。</td>
561
- </tr>
562
-
563
- <tr>
564
- <td rowspan="1" colSpan="1" >[leaveSeat](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#leaveSeat)</td>
565
-
566
- <td rowspan="1" colSpan="1" >用户下麦。</td>
567
- </tr>
568
-
569
- <tr>
570
- <td rowspan="1" colSpan="1" >[lockSeat](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#lockSeat)</td>
571
-
572
- <td rowspan="1" colSpan="1" >锁定麦位。</td>
573
- </tr>
574
-
575
- <tr>
576
- <td rowspan="1" colSpan="1" >[unLockSeat](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#unLockSeat)</td>
577
-
578
- <td rowspan="1" colSpan="1" >解锁麦位。</td>
579
- </tr>
580
-
581
- <tr>
582
- <td rowspan="1" colSpan="1" >[kickUserOutOfSeat](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#kickUserOutOfSeat)</td>
583
-
584
- <td rowspan="1" colSpan="1" >踢用户下麦。</td>
585
- </tr>
586
-
587
- <tr>
588
- <td rowspan="1" colSpan="1" >[moveUserToSeat](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#moveUserToSeat)</td>
589
-
590
- <td rowspan="1" colSpan="1" >移动用户到指定麦位。</td>
591
- </tr>
592
-
593
- <tr>
594
- <td rowspan="1" colSpan="1" >[openRemoteCamera](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#openRemoteCamera)</td>
595
-
596
- <td rowspan="1" colSpan="1" >开启远端摄像头。</td>
597
- </tr>
598
-
599
- <tr>
600
- <td rowspan="1" colSpan="1" >[closeRemoteCamera](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#closeRemoteCamera)</td>
601
-
602
- <td rowspan="1" colSpan="1" >关闭远端摄像头。</td>
603
- </tr>
604
-
605
- <tr>
606
- <td rowspan="1" colSpan="1" >[openRemoteMicrophone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#openRemoteMicrophone)</td>
607
-
608
- <td rowspan="1" colSpan="1" >开启远端麦克风。</td>
609
- </tr>
610
-
611
- <tr>
612
- <td rowspan="1" colSpan="1" >[closeRemoteMicrophone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#closeRemoteMicrophone)</td>
613
-
614
- <td rowspan="1" colSpan="1" >关闭远端麦克风。</td>
615
- </tr>
616
-
617
- <tr>
618
- <td rowspan="1" colSpan="1" >[muteMicrophone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#muteMicrophone)</td>
619
-
620
- <td rowspan="1" colSpan="1" >静音麦克风。</td>
621
- </tr>
622
-
623
- <tr>
624
- <td rowspan="1" colSpan="1" >[unmuteMicrophone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#unmuteMicrophone)</td>
625
-
626
- <td rowspan="1" colSpan="1" >取消静音麦克风。</td>
627
- </tr>
628
-
629
- <tr>
630
- <td rowspan="1" colSpan="1" >[startPlayStream](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#startPlayStream)</td>
631
-
632
- <td rowspan="1" colSpan="1" >开始播放流。</td>
633
- </tr>
634
-
635
- <tr>
636
- <td rowspan="1" colSpan="1" >[stopPlayStream](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#stopPlayStream)</td>
637
-
638
- <td rowspan="1" colSpan="1" >停止播放流。</td>
639
- </tr>
640
- </table>
641
-
642
-
643
- ## LiveAudienceState
644
-
645
- 直播间观众管理模块
646
- - 核心功能:管理直播间观众列表,提供观众权限控制、管理员设置等直播间秩序维护功能,支持实时观众统计。
647
-
648
- - 技术特点:支持实时观众列表更新、权限分级管理、批量操作等高级功能,确保直播间秩序和用户体验。新增 audienceList 和 audienceCount 响应式数据。
649
-
650
- - 业务价值:为直播平台提供完整的观众管理解决方案,支持大规模观众场景下的秩序维护。
651
-
652
- - 应用场景:观众管理、权限控制、直播间秩序维护、观众互动管理等核心业务场景。
653
-
654
-
655
- **响应式数据**
656
-
657
- <table>
658
- <tr>
659
- <td rowspan="1" colSpan="1" >**数据列表**</td>
660
-
661
- <td rowspan="1" colSpan="1" >**描述**</td>
662
- </tr>
663
-
664
- <tr>
665
- <td rowspan="1" colSpan="1" >[audienceList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#audienceList)</td>
666
-
667
- <td rowspan="1" colSpan="1" >观众列表,包含直播间所有观众的信息。</td>
668
- </tr>
669
-
670
- <tr>
671
- <td rowspan="1" colSpan="1" >[audienceCount](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#audienceCount)</td>
672
-
673
- <td rowspan="1" colSpan="1" >观众总数统计。</td>
674
- </tr>
675
- </table>
676
-
677
-
678
- **接口函数**
679
-
680
- <table>
681
- <tr>
682
- <td rowspan="1" colSpan="1" >**函数列表**</td>
683
-
684
- <td rowspan="1" colSpan="1" >**描述**</td>
685
- </tr>
686
-
687
- <tr>
688
- <td rowspan="1" colSpan="1" >[fetchAudienceList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#fetchAudienceList)</td>
689
-
690
- <td rowspan="1" colSpan="1" >获取观众列表。</td>
691
- </tr>
692
-
693
- <tr>
694
- <td rowspan="1" colSpan="1" >[setAdministrator](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setAdministrator)</td>
695
-
696
- <td rowspan="1" colSpan="1" >设置管理员。</td>
697
- </tr>
698
-
699
- <tr>
700
- <td rowspan="1" colSpan="1" >[revokeAdministrator](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#revokeAdministrator)</td>
701
-
702
- <td rowspan="1" colSpan="1" >撤销管理员。</td>
703
- </tr>
704
-
705
- <tr>
706
- <td rowspan="1" colSpan="1" >[kickUserOutOfRoom](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#kickUserOutOfRoom)</td>
707
-
708
- <td rowspan="1" colSpan="1" >踢出房间。</td>
709
- </tr>
710
-
711
- <tr>
712
- <td rowspan="1" colSpan="1" >[disableSendMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#disableSendMessage)</td>
713
-
714
- <td rowspan="1" colSpan="1" >禁言用户。</td>
715
- </tr>
716
- </table>
717
-
718
-
719
- ## LiveMonitorState
720
-
721
- 直播监控管理模块
722
- - 核心功能:提供直播间实时监控功能,包括直播状态监控、数据统计、异常检测等核心监控能力,支持多直播间监控。
723
-
724
- - 技术特点:支持实时数据采集、多维度监控指标、智能告警机制,确保直播服务的稳定性和可靠性。新增 monitorLiveInfoList 响应式数据,优化监控接口。
725
-
726
- - 业务价值:为直播平台提供全方位的监控保障,及时发现和处理异常情况,提升服务质量。
727
-
728
- - 应用场景:直播质量监控、性能分析、异常告警、数据统计等运营管理场景。
729
-
730
-
731
- **响应式数据**
732
-
733
- <table>
734
- <tr>
735
- <td rowspan="1" colSpan="1" >**数据列表**</td>
736
-
737
- <td rowspan="1" colSpan="1" >**描述**</td>
738
- </tr>
739
-
740
- <tr>
741
- <td rowspan="1" colSpan="1" >[monitorLiveInfoList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#monitorLiveInfoList)</td>
742
-
743
- <td rowspan="1" colSpan="1" >监控的直播间信息列表。</td>
744
- </tr>
745
- </table>
746
-
747
-
748
- **接口函数**
749
-
750
- <table>
751
- <tr>
752
- <td rowspan="1" colSpan="1" >**函数列表**</td>
753
-
754
- <td rowspan="1" colSpan="1" >**描述**</td>
755
- </tr>
756
-
757
- <tr>
758
- <td rowspan="1" colSpan="1" >[init](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#init)</td>
759
-
760
- <td rowspan="1" colSpan="1" >初始化监控。</td>
761
- </tr>
762
-
763
- <tr>
764
- <td rowspan="1" colSpan="1" >[getLiveList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getLiveList)</td>
765
-
766
- <td rowspan="1" colSpan="1" >获取直播列表。</td>
767
- </tr>
768
-
769
- <tr>
770
- <td rowspan="1" colSpan="1" >[closeRoom](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#closeRoom)</td>
771
-
772
- <td rowspan="1" colSpan="1" >关闭房间。</td>
773
- </tr>
774
-
775
- <tr>
776
- <td rowspan="1" colSpan="1" >[sendMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#sendMessage)</td>
777
-
778
- <td rowspan="1" colSpan="1" >发送消息。</td>
779
- </tr>
780
-
781
- <tr>
782
- <td rowspan="1" colSpan="1" >[startPlay](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#startPlay)</td>
783
-
784
- <td rowspan="1" colSpan="1" >开始播放。</td>
785
- </tr>
786
-
787
- <tr>
788
- <td rowspan="1" colSpan="1" >[stopPlay](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#stopPlay)</td>
789
-
790
- <td rowspan="1" colSpan="1" >停止播放。</td>
791
- </tr>
792
-
793
- <tr>
794
- <td rowspan="1" colSpan="1" >[muteLiveAudio](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#muteLiveAudio)</td>
795
-
796
- <td rowspan="1" colSpan="1" >静音直播音频。</td>
797
- </tr>
798
- </table>
799
-
800
-
801
- ## CoGuestState
802
-
803
- 连麦嘉宾管理模块
804
- - 核心功能:处理观众与主播之间的连麦互动,管理连麦申请、邀请、接受、拒绝等完整的连麦流程,支持连麦状态管理。
805
-
806
- - 技术特点:基于实时音视频技术,支持连麦状态实时同步、音视频质量自适应、网络状况监控等高级功能。新增 connected、invitees、applicants、candidates 响应式数据和 applyForSeat 接口。
807
-
808
- - 业务价值:为直播平台提供观众参与互动的核心能力,增强用户粘性和直播趣味性。
809
-
810
- - 应用场景:观众连麦、互动问答、在线K歌、游戏直播等需要观众参与的互动场景。
811
-
812
-
813
- **响应式数据**
814
-
815
- <table>
816
- <tr>
817
- <td rowspan="1" colSpan="1" >**数据列表**</td>
818
-
819
- <td rowspan="1" colSpan="1" >**描述**</td>
820
- </tr>
821
-
822
- <tr>
823
- <td rowspan="1" colSpan="1" >[candidates](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#candidates)</td>
824
-
825
- <td rowspan="1" colSpan="1" >取消订阅连麦事件。</td>
826
- </tr>
827
-
828
- <tr>
829
- <td rowspan="1" colSpan="1" >[connected](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#connected)</td>
830
-
831
- <td rowspan="1" colSpan="1" >连麦连接状态。</td>
832
- </tr>
833
-
834
- <tr>
835
- <td rowspan="1" colSpan="1" >[invitees](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#invitees)</td>
836
-
837
- <td rowspan="1" colSpan="1" >被邀请的用户列表。</td>
838
- </tr>
839
-
840
- <tr>
841
- <td rowspan="1" colSpan="1" >[applicants](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#applicants)</td>
842
-
843
- <td rowspan="1" colSpan="1" >申请连麦的用户列表。</td>
844
- </tr>
845
- </table>
846
-
847
-
848
- **接口函数**
849
-
850
- <table>
851
- <tr>
852
- <td rowspan="1" colSpan="1" >**函数列表**</td>
853
-
854
- <td rowspan="1" colSpan="1" >**描述**</td>
855
- </tr>
856
-
857
- <tr>
858
- <td rowspan="1" colSpan="1" >[cancelApplication](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#cancelApplication)</td>
859
-
860
- <td rowspan="1" colSpan="1" >取消申请。</td>
861
- </tr>
862
-
863
- <tr>
864
- <td rowspan="1" colSpan="1" >[acceptApplication](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#acceptApplication)</td>
865
-
866
- <td rowspan="1" colSpan="1" >接受申请。</td>
867
- </tr>
868
-
869
- <tr>
870
- <td rowspan="1" colSpan="1" >[rejectApplication](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#rejectApplication)</td>
871
-
872
- <td rowspan="1" colSpan="1" >拒绝申请。</td>
873
- </tr>
874
-
875
- <tr>
876
- <td rowspan="1" colSpan="1" >[cancelInvitation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#cancelInvitation)</td>
877
-
878
- <td rowspan="1" colSpan="1" >取消邀请。</td>
879
- </tr>
880
-
881
- <tr>
882
- <td rowspan="1" colSpan="1" >[acceptInvitation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#acceptInvitation)</td>
883
-
884
- <td rowspan="1" colSpan="1" >接受邀请。</td>
885
- </tr>
886
-
887
- <tr>
888
- <td rowspan="1" colSpan="1" >[rejectInvitation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#rejectInvitation)</td>
889
-
890
- <td rowspan="1" colSpan="1" >拒绝邀请。</td>
891
- </tr>
892
-
893
- <tr>
894
- <td rowspan="1" colSpan="1" >[disConnect](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#disConnect)</td>
895
-
896
- <td rowspan="1" colSpan="1" >断开连接。</td>
897
- </tr>
898
-
899
- <tr>
900
- <td rowspan="1" colSpan="1" >[applyForSeat](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#applyForSeat)</td>
901
-
902
- <td rowspan="1" colSpan="1" >申请上麦。</td>
903
- </tr>
904
- </table>
905
-
906
-
907
- ## CoHostState
908
-
909
- 连麦主播管理模块
910
- - 核心功能:实现主播间的连麦功能,支持主播邀请、连麦申请、连麦状态管理等主播间互动功能,提供完整的主播连麦流程。
911
-
912
- - 技术特点:支持多主播音视频同步、画中画显示、音视频质量优化等高级技术,确保连麦体验的流畅性。新增 coHostStatus、connected、applicant、invitees、candidates 响应式数据和完整的连麦控制接口。
913
-
914
- - 业务价值:为直播平台提供主播间协作的核心能力,支持 PK、合作直播等高级业务场景。
915
-
916
- - 应用场景:主播 PK、合作直播、跨平台连麦、主播互动等高级直播场景。
917
-
918
-
919
- **响应式数据**
920
-
921
- <table>
922
- <tr>
923
- <td rowspan="1" colSpan="1" >**数据列表**</td>
924
-
925
- <td rowspan="1" colSpan="1" >**描述**</td>
926
- </tr>
927
-
928
- <tr>
929
- <td rowspan="1" colSpan="1" >[coHostStatus](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#coHostStatus)</td>
930
-
931
- <td rowspan="1" colSpan="1" >连麦主播状态。</td>
932
- </tr>
933
-
934
- <tr>
935
- <td rowspan="1" colSpan="1" >[connected](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#connected)</td>
936
-
937
- <td rowspan="1" colSpan="1" >连麦连接状态。</td>
938
- </tr>
939
-
940
- <tr>
941
- <td rowspan="1" colSpan="1" >[applicant](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#applicant)</td>
942
-
943
- <td rowspan="1" colSpan="1" >申请连麦的主播信息。</td>
944
- </tr>
945
-
946
- <tr>
947
- <td rowspan="1" colSpan="1" >[invitees](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#invitees)</td>
948
-
949
- <td rowspan="1" colSpan="1" >被邀请的用户列表。</td>
950
- </tr>
951
-
952
- <tr>
953
- <td rowspan="1" colSpan="1" >[candidates](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#candidates)</td>
954
-
955
- <td rowspan="1" colSpan="1" >候选用户列表。</td>
956
- </tr>
957
- </table>
958
-
959
-
960
- **接口函数**
961
-
962
- <table>
963
- <tr>
964
- <td rowspan="1" colSpan="1" >**函数列表**</td>
965
-
966
- <td rowspan="1" colSpan="1" >**描述**</td>
967
- </tr>
968
-
969
- <tr>
970
- <td rowspan="1" colSpan="1" >[requestHostConnection](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#requestHostConnection)</td>
971
-
972
- <td rowspan="1" colSpan="1" >请求主播连麦。</td>
973
- </tr>
974
-
975
- <tr>
976
- <td rowspan="1" colSpan="1" >[cancelHostConnection](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#cancelHostConnection)</td>
977
-
978
- <td rowspan="1" colSpan="1" >取消主播连麦。</td>
979
- </tr>
980
-
981
- <tr>
982
- <td rowspan="1" colSpan="1" >[acceptHostConnection](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#acceptHostConnection)</td>
983
-
984
- <td rowspan="1" colSpan="1" >接受主播连麦。</td>
985
- </tr>
986
-
987
- <tr>
988
- <td rowspan="1" colSpan="1" >[rejectHostConnection](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#rejectHostConnection)</td>
989
-
990
- <td rowspan="1" colSpan="1" >拒绝主播连麦。</td>
991
- </tr>
992
-
993
- <tr>
994
- <td rowspan="1" colSpan="1" >[exitHostConnection](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#exitHostConnection)</td>
995
-
996
- <td rowspan="1" colSpan="1" >退出主播连麦。</td>
997
- </tr>
998
- </table>
999
-
1000
-
1001
- ## BattleState
1002
-
1003
- PK 对战管理模块
1004
- - 核心功能:管理主播间的 PK 对战功能,包括对战邀请、接受、拒绝、结束等完整的 PK 流程,支持实时比分统计。
1005
-
1006
- - 技术特点:支持实时对战状态同步、比分计算、对战结果统计等功能。新增 battleScore 响应式数据,提供完整的 PK 对战体验。
1007
-
1008
- - 业务价值:为直播平台提供竞技互动功能,增强直播趣味性和用户参与度。
1009
-
1010
- - 应用场景:主播 PK、才艺比拼、游戏对战、互动竞技等娱乐场景。
1011
-
1012
-
1013
- **响应式数据**
1014
-
1015
- <table>
1016
- <tr>
1017
- <td rowspan="1" colSpan="1" >**数据列表**</td>
1018
-
1019
- <td rowspan="1" colSpan="1" >**描述**</td>
1020
- </tr>
1021
-
1022
- <tr>
1023
- <td rowspan="1" colSpan="1" >[currentBattleInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentBattleInfo)</td>
1024
-
1025
- <td rowspan="1" colSpan="1" >当前PK信息。</td>
1026
- </tr>
1027
-
1028
- <tr>
1029
- <td rowspan="1" colSpan="1" >[battleUsers](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#battleUsers)</td>
1030
-
1031
- <td rowspan="1" colSpan="1" >PK参与用户列表。</td>
1032
- </tr>
1033
-
1034
- <tr>
1035
- <td rowspan="1" colSpan="1" >[battleScore](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#battleScore)</td>
1036
-
1037
- <td rowspan="1" colSpan="1" >PK对战的实时比分。</td>
1038
- </tr>
1039
- </table>
1040
-
1041
-
1042
- **接口函数**
1043
-
1044
- <table>
1045
- <tr>
1046
- <td rowspan="1" colSpan="1" >**函数列表**</td>
1047
-
1048
- <td rowspan="1" colSpan="1" >**描述**</td>
1049
- </tr>
1050
-
1051
- <tr>
1052
- <td rowspan="1" colSpan="1" >[requestBattle](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#requestBattle)</td>
1053
-
1054
- <td rowspan="1" colSpan="1" >请求 PK。</td>
1055
- </tr>
1056
-
1057
- <tr>
1058
- <td rowspan="1" colSpan="1" >[cancelBattleRequest](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#cancelBattleRequest)</td>
1059
-
1060
- <td rowspan="1" colSpan="1" >取消 PK 请求。</td>
1061
- </tr>
1062
-
1063
- <tr>
1064
- <td rowspan="1" colSpan="1" >[acceptBattle](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#acceptBattle)</td>
1065
-
1066
- <td rowspan="1" colSpan="1" >接受 PK。</td>
1067
- </tr>
1068
-
1069
- <tr>
1070
- <td rowspan="1" colSpan="1" >[rejectBattle](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#rejectBattle)</td>
1071
-
1072
- <td rowspan="1" colSpan="1" >拒绝 PK。</td>
1073
- </tr>
1074
-
1075
- <tr>
1076
- <td rowspan="1" colSpan="1" >[exitBattle](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#exitBattle)</td>
1077
-
1078
- <td rowspan="1" colSpan="1" >退出 PK。</td>
1079
- </tr>
1080
- </table>
1081
-
1082
-
1083
- ## BarrageState
1084
-
1085
- 弹幕消息管理模块
1086
- - 核心功能:处理直播间内的文本消息、自定义消息等弹幕功能,支持弹幕发送、消息状态同步等完整弹幕系统,提供本地提示功能。
1087
-
1088
- - 技术特点:支持高并发消息处理、实时消息同步、消息过滤、表情包支持等高级功能。新增 sendTextMessage、sendCustomMessage、appendLocalTip 接口函数。
1089
-
1090
- - 业务价值:为直播平台提供核心的互动能力,增强用户参与度和直播氛围。
1091
-
1092
- - 应用场景:弹幕互动、消息管理、表情包、聊天室等社交互动场景。
1093
-
1094
-
1095
- **响应式数据**
1096
-
1097
- <table>
1098
- <tr>
1099
- <td rowspan="1" colSpan="1" >**数据列表**</td>
1100
-
1101
- <td rowspan="1" colSpan="1" >**描述**</td>
1102
- </tr>
1103
-
1104
- <tr>
1105
- <td rowspan="1" colSpan="1" >[messageList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#messageList)</td>
1106
-
1107
- <td rowspan="1" colSpan="1" >弹幕消息列表。</td>
1108
- </tr>
1109
- </table>
1110
-
1111
-
1112
- **接口函数**
1113
-
1114
- <table>
1115
- <tr>
1116
- <td rowspan="1" colSpan="1" >**函数列表**</td>
1117
-
1118
- <td rowspan="1" colSpan="1" >**描述**</td>
1119
- </tr>
1120
-
1121
- <tr>
1122
- <td rowspan="1" colSpan="1" >[sendTextMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#sendTextMessage)</td>
1123
-
1124
- <td rowspan="1" colSpan="1" >发送文本消息。</td>
1125
- </tr>
1126
-
1127
- <tr>
1128
- <td rowspan="1" colSpan="1" >[sendCustomMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#sendCustomMessage)</td>
1129
-
1130
- <td rowspan="1" colSpan="1" >发送自定义消息。</td>
1131
- </tr>
1132
-
1133
- <tr>
1134
- <td rowspan="1" colSpan="1" >[appendLocalTip](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#appendLocalTip)</td>
1135
-
1136
- <td rowspan="1" colSpan="1" >添加本地提示。</td>
1137
- </tr>
1138
- </table>
1139
-
1140
-
1141
- ## MessageListState
1142
-
1143
- 消息列表管理模块
1144
- - 核心功能:管理聊天消息列表,支持消息加载、滚动控制、已读回执、消息高亮等完整的消息展示功能。
1145
-
1146
- - 技术特点:支持虚拟滚动、消息优化、实时更新等高性能消息处理。新增 activeConversationID、messageList、hasMoreOlderMessage 等响应式数据。
1147
-
1148
- - 业务价值:为即时通信提供核心的消息展示能力,确保良好的聊天体验。
1149
-
1150
- - 应用场景:即时通信、群聊、私聊、消息管理等通信场景。
1151
-
1152
-
1153
- **响应式数据**
1154
-
1155
- <table>
1156
- <tr>
1157
- <td rowspan="1" colSpan="1" >**数据列表**</td>
1158
-
1159
- <td rowspan="1" colSpan="1" >**描述**</td>
1160
- </tr>
1161
-
1162
- <tr>
1163
- <td rowspan="1" colSpan="1" >[activeConversationID](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#activeConversationID)</td>
1164
-
1165
- <td rowspan="1" colSpan="1" >当前活跃的会话 ID。</td>
1166
- </tr>
1167
-
1168
- <tr>
1169
- <td rowspan="1" colSpan="1" >[messageList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#messageList)</td>
1170
-
1171
- <td rowspan="1" colSpan="1" >消息列表数据。</td>
1172
- </tr>
1173
-
1174
- <tr>
1175
- <td rowspan="1" colSpan="1" >[hasMoreOlderMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#hasMoreOlderMessage)</td>
1176
-
1177
- <td rowspan="1" colSpan="1" >是否有更多旧消息。</td>
1178
- </tr>
1179
-
1180
- <tr>
1181
- <td rowspan="1" colSpan="1" >[hasMoreNewerMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#hasMoreNewerMessage)</td>
1182
-
1183
- <td rowspan="1" colSpan="1" >是否有更多新消息。</td>
1184
- </tr>
1185
-
1186
- <tr>
1187
- <td rowspan="1" colSpan="1" >[enableReadReceipt](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#enableReadReceipt)</td>
1188
-
1189
- <td rowspan="1" colSpan="1" >是否启用已读回执。</td>
1190
- </tr>
1191
-
1192
- <tr>
1193
- <td rowspan="1" colSpan="1" >[isDisableScroll](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isDisableScroll)</td>
1194
-
1195
- <td rowspan="1" colSpan="1" >是否禁用滚动。</td>
1196
- </tr>
1197
-
1198
- <tr>
1199
- <td rowspan="1" colSpan="1" >[recalledMessageIDSet](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#recalledMessageIDSet)</td>
1200
-
1201
- <td rowspan="1" colSpan="1" >已撤回消息的 ID 集合。</td>
1202
- </tr>
1203
-
1204
- <tr>
1205
- <td rowspan="1" colSpan="1" >[highlightMessageIDSet](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#highlightMessageIDSet)</td>
1206
-
1207
- <td rowspan="1" colSpan="1" >高亮消息的 ID 集合。</td>
1208
- </tr>
1209
- </table>
1210
-
1211
-
1212
- **接口函数**
1213
-
1214
- <table>
1215
- <tr>
1216
- <td rowspan="1" colSpan="1" >**函数列表**</td>
1217
-
1218
- <td rowspan="1" colSpan="1" >**描述**</td>
1219
- </tr>
1220
-
1221
- <tr>
1222
- <td rowspan="1" colSpan="1" >[setEnableReadReceipt](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setEnableReadReceipt)</td>
1223
-
1224
- <td rowspan="1" colSpan="1" >设置已读回执。</td>
1225
- </tr>
1226
-
1227
- <tr>
1228
- <td rowspan="1" colSpan="1" >[setIsDisableScroll](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setIsDisableScroll)</td>
1229
-
1230
- <td rowspan="1" colSpan="1" >设置滚动禁用。</td>
1231
- </tr>
1232
-
1233
- <tr>
1234
- <td rowspan="1" colSpan="1" >[highlightMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#highlightMessage)</td>
1235
-
1236
- <td rowspan="1" colSpan="1" >高亮消息。</td>
1237
- </tr>
1238
- </table>
1239
-
1240
-
1241
- ## MessageInputState
1242
-
1243
- 消息输入管理模块
1244
- - 核心功能:管理消息输入框的状态和行为,支持文本输入、表情包、@功能、输入状态提示等完整的输入体验。
1245
-
1246
- - 技术特点:支持富文本编辑、输入状态同步、草稿保存等功能。新增 inputRawValue、isPeerTyping 响应式数据。
1247
-
1248
- - 业务价值:为用户提供便捷的消息输入体验,提升沟通效率。
1249
-
1250
- - 应用场景:消息编辑、表情输入、文件发送、语音输入等输入场景。
1251
-
1252
-
1253
- **响应式数据**
1254
-
1255
- <table>
1256
- <tr>
1257
- <td rowspan="1" colSpan="1" >**数据列表**</td>
1258
-
1259
- <td rowspan="1" colSpan="1" >**描述**</td>
1260
- </tr>
1261
-
1262
- <tr>
1263
- <td rowspan="1" colSpan="1" >[inputRawValue](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#inputRawValue)</td>
1264
-
1265
- <td rowspan="1" colSpan="1" >输入框的原始文本内容。</td>
1266
- </tr>
1267
-
1268
- <tr>
1269
- <td rowspan="1" colSpan="1" >[isPeerTyping](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isPeerTyping)</td>
1270
-
1271
- <td rowspan="1" colSpan="1" >对方是否正在输入。</td>
1272
- </tr>
1273
- </table>
1274
-
1275
-
1276
- **接口函数**
1277
-
1278
- <table>
1279
- <tr>
1280
- <td rowspan="1" colSpan="1" >**函数列表**</td>
1281
-
1282
- <td rowspan="1" colSpan="1" >**描述**</td>
1283
- </tr>
1284
-
1285
- <tr>
1286
- <td rowspan="1" colSpan="1" >[updateRawValue](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#updateRawValue)</td>
1287
-
1288
- <td rowspan="1" colSpan="1" >更新原始值。</td>
1289
- </tr>
1290
-
1291
- <tr>
1292
- <td rowspan="1" colSpan="1" >[setEditorInstance](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setEditorInstance)</td>
1293
-
1294
- <td rowspan="1" colSpan="1" >设置编辑器实例。</td>
1295
- </tr>
1296
-
1297
- <tr>
1298
- <td rowspan="1" colSpan="1" >[setContent](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setContent)</td>
1299
-
1300
- <td rowspan="1" colSpan="1" >设置内容。</td>
1301
- </tr>
1302
-
1303
- <tr>
1304
- <td rowspan="1" colSpan="1" >[insertContent](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#insertContent)</td>
1305
-
1306
- <td rowspan="1" colSpan="1" >插入内容。</td>
1307
- </tr>
1308
-
1309
- <tr>
1310
- <td rowspan="1" colSpan="1" >[focusEditor](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#focusEditor)</td>
1311
-
1312
- <td rowspan="1" colSpan="1" >聚焦编辑器。</td>
1313
- </tr>
1314
-
1315
- <tr>
1316
- <td rowspan="1" colSpan="1" >[blurEditor](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#blurEditor)</td>
1317
-
1318
- <td rowspan="1" colSpan="1" >失焦编辑器。</td>
1319
- </tr>
1320
-
1321
- <tr>
1322
- <td rowspan="1" colSpan="1" >[sendMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#sendMessage)</td>
1323
-
1324
- <td rowspan="1" colSpan="1" >发送消息。</td>
1325
- </tr>
1326
- </table>
1327
-
1328
-
1329
- ## MessageActionState
1330
-
1331
- 消息操作管理模块
1332
- - 核心功能:管理消息的各种操作,包括转发、引用、复制、删除、撤回等完整的消息操作功能。
1333
-
1334
- - 技术特点:支持批量操作、操作状态管理、权限控制等功能。新增 forwardMessageIDList、isForwardMessageSelectionDone 等响应式数据。
1335
-
1336
- - 业务价值:为用户提供丰富的消息操作能力,提升使用体验。
1337
-
1338
- - 应用场景:消息转发、消息引用、消息管理、批量操作等场景。
1339
-
1340
-
1341
- **响应式数据**
1342
-
1343
- <table>
1344
- <tr>
1345
- <td rowspan="1" colSpan="1" >**数据列表**</td>
1346
-
1347
- <td rowspan="1" colSpan="1" >**描述**</td>
1348
- </tr>
1349
-
1350
- <tr>
1351
- <td rowspan="1" colSpan="1" >[forwardMessageIDList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#forwardMessageIDList)</td>
1352
-
1353
- <td rowspan="1" colSpan="1" >要转发的消息 ID 列表。</td>
1354
- </tr>
1355
-
1356
- <tr>
1357
- <td rowspan="1" colSpan="1" >[isForwardMessageSelectionDone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isForwardMessageSelectionDone)</td>
1358
-
1359
- <td rowspan="1" colSpan="1" >消息转发选择是否完成。</td>
1360
- </tr>
1361
-
1362
- <tr>
1363
- <td rowspan="1" colSpan="1" >[forwardConversationIDList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#forwardConversationIDList)</td>
1364
-
1365
- <td rowspan="1" colSpan="1" >转发目标会话 ID 列表。</td>
1366
- </tr>
1367
-
1368
- <tr>
1369
- <td rowspan="1" colSpan="1" >[quotedMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#quotedMessage)</td>
1370
-
1371
- <td rowspan="1" colSpan="1" >被引用的消息信息。</td>
1372
- </tr>
1373
- </table>
1374
-
1375
-
1376
- **接口函数**
1377
-
1378
- <table>
1379
- <tr>
1380
- <td rowspan="1" colSpan="1" >**函数列表**</td>
1381
-
1382
- <td rowspan="1" colSpan="1" >**描述**</td>
1383
- </tr>
1384
-
1385
- <tr>
1386
- <td rowspan="1" colSpan="1" >[forwardMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#forwardMessage)</td>
1387
-
1388
- <td rowspan="1" colSpan="1" >转发消息。</td>
1389
- </tr>
1390
-
1391
- <tr>
1392
- <td rowspan="1" colSpan="1" >[setForwardMessageIDList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setForwardMessageIDList)</td>
1393
-
1394
- <td rowspan="1" colSpan="1" >设置转发消息列表。</td>
1395
- </tr>
1396
-
1397
- <tr>
1398
- <td rowspan="1" colSpan="1" >[setIsForwardMessageSelectionDone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setIsForwardMessageSelectionDone)</td>
1399
-
1400
- <td rowspan="1" colSpan="1" >设置转发选择完成。</td>
1401
- </tr>
1402
-
1403
- <tr>
1404
- <td rowspan="1" colSpan="1" >[setForwardConversationIDList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setForwardConversationIDList)</td>
1405
-
1406
- <td rowspan="1" colSpan="1" >设置转发会话列表。</td>
1407
- </tr>
1408
-
1409
- <tr>
1410
- <td rowspan="1" colSpan="1" >[quoteMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#quoteMessage)</td>
1411
-
1412
- <td rowspan="1" colSpan="1" >引用消息。</td>
1413
- </tr>
1414
-
1415
- <tr>
1416
- <td rowspan="1" colSpan="1" >[clearQuotedMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#clearQuotedMessage)</td>
1417
-
1418
- <td rowspan="1" colSpan="1" >清除引用消息。</td>
1419
- </tr>
1420
-
1421
- <tr>
1422
- <td rowspan="1" colSpan="1" >[copyTextMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#copyTextMessage)</td>
1423
-
1424
- <td rowspan="1" colSpan="1" >复制文本消息。</td>
1425
- </tr>
1426
-
1427
- <tr>
1428
- <td rowspan="1" colSpan="1" >[deleteMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#deleteMessage)</td>
1429
-
1430
- <td rowspan="1" colSpan="1" >删除消息。</td>
1431
- </tr>
1432
-
1433
- <tr>
1434
- <td rowspan="1" colSpan="1" >[recallMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#recallMessage)</td>
1435
-
1436
- <td rowspan="1" colSpan="1" >撤回消息。</td>
1437
- </tr>
1438
-
1439
- <tr>
1440
- <td rowspan="1" colSpan="1" >[resetMessageActionState](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#resetMessageActionState)</td>
1441
-
1442
- <td rowspan="1" colSpan="1" >重置消息操作状态。</td>
1443
- </tr>
1444
- </table>
1445
-
1446
-
1447
- ## ConversationListState
1448
-
1449
- 会话列表管理模块
1450
- - 核心功能:管理用户的会话列表,支持会话排序、未读统计、会话操作等完整的会话管理功能。
1451
-
1452
- - 技术特点:支持实时会话更新、智能排序、网络状态监控等功能。新增 conversationList、activeConversation、totalUnRead、netStatus 响应式数据。
1453
-
1454
- - 业务价值:为用户提供清晰的会话管理界面,提升沟通效率。
1455
-
1456
- - 应用场景:会话管理、联系人列表、群组管理、消息中心等场景。
1457
-
1458
-
1459
- **响应式数据**
1460
-
1461
- <table>
1462
- <tr>
1463
- <td rowspan="1" colSpan="1" >**数据列表**</td>
1464
-
1465
- <td rowspan="1" colSpan="1" >**描述**</td>
1466
- </tr>
1467
-
1468
- <tr>
1469
- <td rowspan="1" colSpan="1" >[conversationList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#conversationList)</td>
1470
-
1471
- <td rowspan="1" colSpan="1" >会话列表数据。</td>
1472
- </tr>
1473
-
1474
- <tr>
1475
- <td rowspan="1" colSpan="1" >[activeConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#activeConversation)</td>
1476
-
1477
- <td rowspan="1" colSpan="1" >当前活跃的会话。</td>
1478
- </tr>
1479
-
1480
- <tr>
1481
- <td rowspan="1" colSpan="1" >[totalUnRead](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#totalUnRead)</td>
1482
-
1483
- <td rowspan="1" colSpan="1" >未读消息总数。</td>
1484
- </tr>
1485
-
1486
- <tr>
1487
- <td rowspan="1" colSpan="1" >[netStatus](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#netStatus)</td>
1488
-
1489
- <td rowspan="1" colSpan="1" >网络连接状态。</td>
1490
- </tr>
1491
- </table>
1492
-
1493
-
1494
- **接口函数**
1495
-
1496
- <table>
1497
- <tr>
1498
- <td rowspan="1" colSpan="1" >**函数列表**</td>
1499
-
1500
- <td rowspan="1" colSpan="1" >**描述**</td>
1501
- </tr>
1502
-
1503
- <tr>
1504
- <td rowspan="1" colSpan="1" >[markConversationUnread](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#markConversationUnread)</td>
1505
-
1506
- <td rowspan="1" colSpan="1" >标记会话未读。</td>
1507
- </tr>
1508
-
1509
- <tr>
1510
- <td rowspan="1" colSpan="1" >[setActiveConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setActiveConversation)</td>
1511
-
1512
- <td rowspan="1" colSpan="1" >设置活跃会话。</td>
1513
- </tr>
1514
-
1515
- <tr>
1516
- <td rowspan="1" colSpan="1" >[pinConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#pinConversation)</td>
1517
-
1518
- <td rowspan="1" colSpan="1" >置顶会话。</td>
1519
- </tr>
1520
-
1521
- <tr>
1522
- <td rowspan="1" colSpan="1" >[deleteConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#deleteConversation)</td>
1523
-
1524
- <td rowspan="1" colSpan="1" >删除会话。</td>
1525
- </tr>
1526
-
1527
- <tr>
1528
- <td rowspan="1" colSpan="1" >[muteConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#muteConversation)</td>
1529
-
1530
- <td rowspan="1" colSpan="1" >静音会话。</td>
1531
- </tr>
1532
-
1533
- <tr>
1534
- <td rowspan="1" colSpan="1" >[setConversationDraft](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setConversationDraft)</td>
1535
-
1536
- <td rowspan="1" colSpan="1" >设置会话草稿。</td>
1537
- </tr>
1538
-
1539
- <tr>
1540
- <td rowspan="1" colSpan="1" >[createC2CConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#createC2CConversation)</td>
1541
-
1542
- <td rowspan="1" colSpan="1" >创建单聊会话。</td>
1543
- </tr>
1544
-
1545
- <tr>
1546
- <td rowspan="1" colSpan="1" >[createGroupConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#createGroupConversation)</td>
1547
-
1548
- <td rowspan="1" colSpan="1" >创建群聊会话。</td>
1549
- </tr>
1550
- </table>
1551
-
1552
-
1553
- ## ContactListState
1554
-
1555
- 联系人管理模块
1556
- - 核心功能:管理用户的联系人列表,包括好友管理、群组管理、黑名单管理等完整的联系人功能。
1557
-
1558
- - 技术特点:支持联系人分组、好友申请处理、群组申请管理等功能。新增 friendList、groupList、blackList 等响应式数据和完整的联系人操作接口。
1559
-
1560
- - 业务价值:为用户提供完整的社交关系管理能力,构建社交网络。
1561
-
1562
- - 应用场景:好友管理、群组管理、联系人搜索、社交网络等场景。
1563
-
1564
-
1565
- **响应式数据**
1566
-
1567
- <table>
1568
- <tr>
1569
- <td rowspan="1" colSpan="1" >**数据列表**</td>
1570
-
1571
- <td rowspan="1" colSpan="1" >**描述**</td>
1572
- </tr>
1573
-
1574
- <tr>
1575
- <td rowspan="1" colSpan="1" >[friendList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#friendList)</td>
1576
-
1577
- <td rowspan="1" colSpan="1" >好友列表。</td>
1578
- </tr>
1579
-
1580
- <tr>
1581
- <td rowspan="1" colSpan="1" >[groupList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#groupList)</td>
1582
-
1583
- <td rowspan="1" colSpan="1" >群组列表。</td>
1584
- </tr>
1585
-
1586
- <tr>
1587
- <td rowspan="1" colSpan="1" >[blackList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#blackList)</td>
1588
-
1589
- <td rowspan="1" colSpan="1" >黑名单列表。</td>
1590
- </tr>
1591
-
1592
- <tr>
1593
- <td rowspan="1" colSpan="1" >[friendApplicationUnreadCount](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#friendApplicationUnreadCount)</td>
1594
-
1595
- <td rowspan="1" colSpan="1" >好友申请未读数。</td>
1596
- </tr>
1597
-
1598
- <tr>
1599
- <td rowspan="1" colSpan="1" >[friendGroupList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#friendGroupList)</td>
1600
-
1601
- <td rowspan="1" colSpan="1" >好友分组列表。</td>
1602
- </tr>
1603
-
1604
- <tr>
1605
- <td rowspan="1" colSpan="1" >[friendApplicationList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#friendApplicationList)</td>
1606
-
1607
- <td rowspan="1" colSpan="1" >好友申请列表。</td>
1608
- </tr>
1609
-
1610
- <tr>
1611
- <td rowspan="1" colSpan="1" >[groupApplicationList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#groupApplicationList)</td>
1612
-
1613
- <td rowspan="1" colSpan="1" >群申请列表。</td>
1614
- </tr>
1615
- </table>
1616
-
1617
-
1618
- **接口函数**
1619
-
1620
- <table>
1621
- <tr>
1622
- <td rowspan="1" colSpan="1" >**函数列表**</td>
1623
-
1624
- <td rowspan="1" colSpan="1" >**描述**</td>
1625
- </tr>
1626
-
1627
- <tr>
1628
- <td rowspan="1" colSpan="1" >[setGroupApplicationList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setGroupApplicationList)</td>
1629
-
1630
- <td rowspan="1" colSpan="1" >设置群组申请列表。</td>
1631
- </tr>
1632
-
1633
- <tr>
1634
- <td rowspan="1" colSpan="1" >[setFriendList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setFriendList)</td>
1635
-
1636
- <td rowspan="1" colSpan="1" >设置好友列表。</td>
1637
- </tr>
1638
-
1639
- <tr>
1640
- <td rowspan="1" colSpan="1" >[setGroupList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setGroupList)</td>
1641
-
1642
- <td rowspan="1" colSpan="1" >设置群组列表。</td>
1643
- </tr>
1644
-
1645
- <tr>
1646
- <td rowspan="1" colSpan="1" >[setBlackList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setBlackList)</td>
1647
-
1648
- <td rowspan="1" colSpan="1" >设置黑名单列表。</td>
1649
- </tr>
1650
-
1651
- <tr>
1652
- <td rowspan="1" colSpan="1" >[setFriendApplicationUnreadCount](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setFriendApplicationUnreadCount)</td>
1653
-
1654
- <td rowspan="1" colSpan="1" >设置好友申请未读数。</td>
1655
- </tr>
1656
-
1657
- <tr>
1658
- <td rowspan="1" colSpan="1" >[setFriendGroupList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setFriendGroupList)</td>
1659
-
1660
- <td rowspan="1" colSpan="1" >设置好友分组列表。</td>
1661
- </tr>
1662
-
1663
- <tr>
1664
- <td rowspan="1" colSpan="1" >[setFriendApplicationList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setFriendApplicationList)</td>
1665
-
1666
- <td rowspan="1" colSpan="1" >设置好友申请列表。</td>
1667
- </tr>
1668
-
1669
- <tr>
1670
- <td rowspan="1" colSpan="1" >[initContactListWatcher](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#initContactListWatcher)</td>
1671
-
1672
- <td rowspan="1" colSpan="1" >初始化联系人监听器。</td>
1673
- </tr>
1674
-
1675
- <tr>
1676
- <td rowspan="1" colSpan="1" >[addFriend](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#addFriend)</td>
1677
-
1678
- <td rowspan="1" colSpan="1" >添加好友。</td>
1679
- </tr>
1680
-
1681
- <tr>
1682
- <td rowspan="1" colSpan="1" >[markFriendApplicationAsRead](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#markFriendApplicationAsRead)</td>
1683
-
1684
- <td rowspan="1" colSpan="1" >标记好友申请为已读。</td>
1685
- </tr>
1686
-
1687
- <tr>
1688
- <td rowspan="1" colSpan="1" >[acceptFriendApplication](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#acceptFriendApplication)</td>
1689
-
1690
- <td rowspan="1" colSpan="1" >接受好友申请。</td>
1691
- </tr>
1692
-
1693
- <tr>
1694
- <td rowspan="1" colSpan="1" >[refuseFriendApplication](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#refuseFriendApplication)</td>
1695
-
1696
- <td rowspan="1" colSpan="1" >拒绝好友申请。</td>
1697
- </tr>
1698
-
1699
- <tr>
1700
- <td rowspan="1" colSpan="1" >[addToBlacklist](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#addToBlacklist)</td>
1701
-
1702
- <td rowspan="1" colSpan="1" >添加到黑名单。</td>
1703
- </tr>
1704
-
1705
- <tr>
1706
- <td rowspan="1" colSpan="1" >[removeFromBlacklist](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#removeFromBlacklist)</td>
1707
-
1708
- <td rowspan="1" colSpan="1" >从黑名单移除。</td>
1709
- </tr>
1710
-
1711
- <tr>
1712
- <td rowspan="1" colSpan="1" >[deleteFriend](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#deleteFriend)</td>
1713
-
1714
- <td rowspan="1" colSpan="1" >删除好友。</td>
1715
- </tr>
1716
-
1717
- <tr>
1718
- <td rowspan="1" colSpan="1" >[setFriendRemark](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setFriendRemark)</td>
1719
-
1720
- <td rowspan="1" colSpan="1" >设置好友备注。</td>
1721
- </tr>
1722
-
1723
- <tr>
1724
- <td rowspan="1" colSpan="1" >[createFriendGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#createFriendGroup)</td>
1725
-
1726
- <td rowspan="1" colSpan="1" >创建好友分组。</td>
1727
- </tr>
1728
-
1729
- <tr>
1730
- <td rowspan="1" colSpan="1" >[deleteFriendGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#deleteFriendGroup)</td>
1731
-
1732
- <td rowspan="1" colSpan="1" >删除好友分组。</td>
1733
- </tr>
1734
-
1735
- <tr>
1736
- <td rowspan="1" colSpan="1" >[addToFriendGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#addToFriendGroup)</td>
1737
-
1738
- <td rowspan="1" colSpan="1" >添加到好友分组。</td>
1739
- </tr>
1740
-
1741
- <tr>
1742
- <td rowspan="1" colSpan="1" >[removeFromFriendGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#removeFromFriendGroup)</td>
1743
-
1744
- <td rowspan="1" colSpan="1" >从好友分组移除。</td>
1745
- </tr>
1746
-
1747
- <tr>
1748
- <td rowspan="1" colSpan="1" >[renameFriendGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#renameFriendGroup)</td>
1749
-
1750
- <td rowspan="1" colSpan="1" >重命名好友分组。</td>
1751
- </tr>
1752
-
1753
- <tr>
1754
- <td rowspan="1" colSpan="1" >[joinGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#joinGroup)</td>
1755
-
1756
- <td rowspan="1" colSpan="1" >加入群组。</td>
1757
- </tr>
1758
-
1759
- <tr>
1760
- <td rowspan="1" colSpan="1" >[acceptGroupApplication](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#acceptGroupApplication)</td>
1761
-
1762
- <td rowspan="1" colSpan="1" >接受群组申请。</td>
1763
- </tr>
1764
-
1765
- <tr>
1766
- <td rowspan="1" colSpan="1" >[refuseGroupApplication](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#refuseGroupApplication)</td>
1767
-
1768
- <td rowspan="1" colSpan="1" >拒绝群组申请。</td>
1769
- </tr>
1770
- </table>
1771
-
1772
-
1773
- ## C2CSettingState
1774
-
1775
- 单聊设置管理模块
1776
- - 核心功能:管理单聊会话的各种设置,包括用户信息、聊天设置、权限控制等功能。
1777
-
1778
- - 技术特点:支持实时设置同步、权限管理、个性化配置等功能。更新响应式数据为 userID、avatar、signature 等标准化字段。
1779
-
1780
- - 业务价值:为用户提供个性化的单聊体验,提升沟通质量。
1781
-
1782
- - 应用场景:单聊设置、用户信息管理、聊天权限控制等场景。
1783
-
1784
-
1785
- **响应式数据**
1786
-
1787
- <table>
1788
- <tr>
1789
- <td rowspan="1" colSpan="1" >**数据列表**</td>
1790
-
1791
- <td rowspan="1" colSpan="1" >**描述**</td>
1792
- </tr>
1793
-
1794
- <tr>
1795
- <td rowspan="1" colSpan="1" >[currentConversationRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentConversationRef)</td>
1796
-
1797
- <td rowspan="1" colSpan="1" >当前会话引用。</td>
1798
- </tr>
1799
-
1800
- <tr>
1801
- <td rowspan="1" colSpan="1" >[userIDRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#userIDRef)</td>
1802
-
1803
- <td rowspan="1" colSpan="1" >用户 ID。</td>
1804
- </tr>
1805
-
1806
- <tr>
1807
- <td rowspan="1" colSpan="1" >[nickRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#nickRef)</td>
1808
-
1809
- <td rowspan="1" colSpan="1" >用户昵称。</td>
1810
- </tr>
1811
-
1812
- <tr>
1813
- <td rowspan="1" colSpan="1" >[avatarRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#avatarRef)</td>
1814
-
1815
- <td rowspan="1" colSpan="1" >用户头像。</td>
1816
- </tr>
1817
-
1818
- <tr>
1819
- <td rowspan="1" colSpan="1" >[signatureRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#signatureRef)</td>
1820
-
1821
- <td rowspan="1" colSpan="1" >用户个性签名。</td>
1822
- </tr>
1823
-
1824
- <tr>
1825
- <td rowspan="1" colSpan="1" >[remarkRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#remarkRef)</td>
1826
-
1827
- <td rowspan="1" colSpan="1" >好友备注名。</td>
1828
- </tr>
1829
-
1830
- <tr>
1831
- <td rowspan="1" colSpan="1" >[isMutedRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isMutedRef)</td>
1832
-
1833
- <td rowspan="1" colSpan="1" >会话静音状态。</td>
1834
- </tr>
1835
-
1836
- <tr>
1837
- <td rowspan="1" colSpan="1" >[isPinnedRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isPinnedRef)</td>
1838
-
1839
- <td rowspan="1" colSpan="1" >会话置顶状态。</td>
1840
- </tr>
1841
-
1842
- <tr>
1843
- <td rowspan="1" colSpan="1" >[isContactRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isContactRef)</td>
1844
-
1845
- <td rowspan="1" colSpan="1" >好友关系状态。</td>
1846
- </tr>
1847
-
1848
- <tr>
1849
- <td rowspan="1" colSpan="1" >[userID](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#userID)</td>
1850
-
1851
- <td rowspan="1" colSpan="1" >用户 ID。</td>
1852
- </tr>
1853
-
1854
- <tr>
1855
- <td rowspan="1" colSpan="1" >[avatar](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#avatar)</td>
1856
-
1857
- <td rowspan="1" colSpan="1" >用户头像 URL。</td>
1858
- </tr>
1859
-
1860
- <tr>
1861
- <td rowspan="1" colSpan="1" >[signature](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#signature)</td>
1862
-
1863
- <td rowspan="1" colSpan="1" >用户个性签名。</td>
1864
- </tr>
1865
-
1866
- <tr>
1867
- <td rowspan="1" colSpan="1" >[remark](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#remark)</td>
1868
-
1869
- <td rowspan="1" colSpan="1" >用户备注名。</td>
1870
- </tr>
1871
-
1872
- <tr>
1873
- <td rowspan="1" colSpan="1" >[isMuted](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isMuted)</td>
1874
-
1875
- <td rowspan="1" colSpan="1" >是否已静音。</td>
1876
- </tr>
1877
-
1878
- <tr>
1879
- <td rowspan="1" colSpan="1" >[isPinned](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isPinned)</td>
1880
-
1881
- <td rowspan="1" colSpan="1" >是否已置顶。</td>
1882
- </tr>
1883
-
1884
- <tr>
1885
- <td rowspan="1" colSpan="1" >[isContact](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isContact)</td>
1886
-
1887
- <td rowspan="1" colSpan="1" >是否为联系人。</td>
1888
- </tr>
1889
- </table>
1890
-
1891
-
1892
- **接口函数**
1893
-
1894
- <table>
1895
- <tr>
1896
- <td rowspan="1" colSpan="1" >**函数列表**</td>
1897
-
1898
- <td rowspan="1" colSpan="1" >**描述**</td>
1899
- </tr>
1900
-
1901
- <tr>
1902
- <td rowspan="1" colSpan="1" >[setChatPinned](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setChatPinned)</td>
1903
-
1904
- <td rowspan="1" colSpan="1" >设置聊天置顶。</td>
1905
- </tr>
1906
-
1907
- <tr>
1908
- <td rowspan="1" colSpan="1" >[setChatMuted](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setChatMuted)</td>
1909
-
1910
- <td rowspan="1" colSpan="1" >设置聊天免打扰。</td>
1911
- </tr>
1912
-
1913
- <tr>
1914
- <td rowspan="1" colSpan="1" >[setUserRemark](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setUserRemark)</td>
1915
-
1916
- <td rowspan="1" colSpan="1" >设置用户备注。</td>
1917
- </tr>
1918
- </table>
1919
-
1920
-
1921
- ## GroupSettingState
1922
-
1923
- 群聊设置管理模块
1924
- - 核心功能:管理群聊的各种设置和操作,包括群信息管理、成员管理、权限控制等完整的群管理功能。
1925
-
1926
- - 技术特点:支持群权限管理、成员操作、群设置同步等功能。新增 groupID、groupType、groupName 等完整的群信息响应式数据和管理接口。
1927
-
1928
- - 业务价值:为群主和管理员提供完整的群管理能力,维护群秩序。
1929
-
1930
- - 应用场景:群管理、成员管理、权限控制、群设置等场景。
1931
-
1932
-
1933
- **响应式数据**
1934
-
1935
- <table>
1936
- <tr>
1937
- <td rowspan="1" colSpan="1" >**数据列表**</td>
1938
-
1939
- <td rowspan="1" colSpan="1" >**描述**</td>
1940
- </tr>
1941
-
1942
- <tr>
1943
- <td rowspan="1" colSpan="1" >[groupID](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#groupID)</td>
1944
-
1945
- <td rowspan="1" colSpan="1" >群组 ID。</td>
1946
- </tr>
1947
-
1948
- <tr>
1949
- <td rowspan="1" colSpan="1" >[groupType](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#groupType)</td>
1950
-
1951
- <td rowspan="1" colSpan="1" >群组类型。</td>
1952
- </tr>
1953
-
1954
- <tr>
1955
- <td rowspan="1" colSpan="1" >[groupName](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#groupName)</td>
1956
-
1957
- <td rowspan="1" colSpan="1" >群组名称。</td>
1958
- </tr>
1959
-
1960
- <tr>
1961
- <td rowspan="1" colSpan="1" >[avatar](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#avatar)</td>
1962
-
1963
- <td rowspan="1" colSpan="1" >用户头像 URL。</td>
1964
- </tr>
1965
-
1966
- <tr>
1967
- <td rowspan="1" colSpan="1" >[introduction](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#introduction)</td>
1968
-
1969
- <td rowspan="1" colSpan="1" >群组介绍。</td>
1970
- </tr>
1971
-
1972
- <tr>
1973
- <td rowspan="1" colSpan="1" >[notification](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#notification)</td>
1974
-
1975
- <td rowspan="1" colSpan="1" >群组公告。</td>
1976
- </tr>
1977
-
1978
- <tr>
1979
- <td rowspan="1" colSpan="1" >[isMuted](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isMuted)</td>
1980
-
1981
- <td rowspan="1" colSpan="1" >是否已静音。</td>
1982
- </tr>
1983
-
1984
- <tr>
1985
- <td rowspan="1" colSpan="1" >[isPinned](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isPinned)</td>
1986
-
1987
- <td rowspan="1" colSpan="1" >是否已置顶。</td>
1988
- </tr>
1989
-
1990
- <tr>
1991
- <td rowspan="1" colSpan="1" >[groupOwner](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#groupOwner)</td>
1992
-
1993
- <td rowspan="1" colSpan="1" >群主信息。</td>
1994
- </tr>
1995
-
1996
- <tr>
1997
- <td rowspan="1" colSpan="1" >[adminMembers](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#adminMembers)</td>
1998
-
1999
- <td rowspan="1" colSpan="1" >管理员列表。</td>
2000
- </tr>
2001
-
2002
- <tr>
2003
- <td rowspan="1" colSpan="1" >[allMembers](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#allMembers)</td>
2004
-
2005
- <td rowspan="1" colSpan="1" >所有成员列表。</td>
2006
- </tr>
2007
-
2008
- <tr>
2009
- <td rowspan="1" colSpan="1" >[memberCount](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#memberCount)</td>
2010
-
2011
- <td rowspan="1" colSpan="1" >成员总数。</td>
2012
- </tr>
2013
-
2014
- <tr>
2015
- <td rowspan="1" colSpan="1" >[maxMemberCount](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#maxMemberCount)</td>
2016
-
2017
- <td rowspan="1" colSpan="1" >最大成员数。</td>
2018
- </tr>
2019
-
2020
- <tr>
2021
- <td rowspan="1" colSpan="1" >[currentUserID](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentUserID)</td>
2022
-
2023
- <td rowspan="1" colSpan="1" >当前用户 ID。</td>
2024
- </tr>
2025
-
2026
- <tr>
2027
- <td rowspan="1" colSpan="1" >[currentUserRole](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentUserRole)</td>
2028
-
2029
- <td rowspan="1" colSpan="1" >当前用户角色。</td>
2030
- </tr>
2031
-
2032
- <tr>
2033
- <td rowspan="1" colSpan="1" >[nameCard](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#nameCard)</td>
2034
-
2035
- <td rowspan="1" colSpan="1" >用户名片。</td>
2036
- </tr>
2037
-
2038
- <tr>
2039
- <td rowspan="1" colSpan="1" >[isMuteAllMembers](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isMuteAllMembers)</td>
2040
-
2041
- <td rowspan="1" colSpan="1" >是否禁言所有成员。</td>
2042
- </tr>
2043
-
2044
- <tr>
2045
- <td rowspan="1" colSpan="1" >[isInGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isInGroup)</td>
2046
-
2047
- <td rowspan="1" colSpan="1" >是否在群组中。</td>
2048
- </tr>
2049
-
2050
- <tr>
2051
- <td rowspan="1" colSpan="1" >[inviteOption](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#inviteOption)</td>
2052
-
2053
- <td rowspan="1" colSpan="1" >邀请选项。</td>
2054
- </tr>
2055
- </table>
2056
-
2057
-
2058
- **接口函数**
2059
-
2060
- <table>
2061
- <tr>
2062
- <td rowspan="1" colSpan="1" >**函数列表**</td>
2063
-
2064
- <td rowspan="1" colSpan="1" >**描述**</td>
2065
- </tr>
2066
-
2067
- <tr>
2068
- <td rowspan="1" colSpan="1" >[getGroupMemberList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getGroupMemberList)</td>
2069
-
2070
- <td rowspan="1" colSpan="1" >获取群成员列表。</td>
2071
- </tr>
2072
-
2073
- <tr>
2074
- <td rowspan="1" colSpan="1" >[updateGroupProfile](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#updateGroupProfile)</td>
2075
-
2076
- <td rowspan="1" colSpan="1" >更新群资料。</td>
2077
- </tr>
2078
-
2079
- <tr>
2080
- <td rowspan="1" colSpan="1" >[addGroupMember](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#addGroupMember)</td>
2081
-
2082
- <td rowspan="1" colSpan="1" >添加群成员。</td>
2083
- </tr>
2084
-
2085
- <tr>
2086
- <td rowspan="1" colSpan="1" >[deleteGroupMember](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#deleteGroupMember)</td>
2087
-
2088
- <td rowspan="1" colSpan="1" >删除群成员。</td>
2089
- </tr>
2090
-
2091
- <tr>
2092
- <td rowspan="1" colSpan="1" >[changeGroupOwner](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#changeGroupOwner)</td>
2093
-
2094
- <td rowspan="1" colSpan="1" >转让群主。</td>
2095
- </tr>
2096
-
2097
- <tr>
2098
- <td rowspan="1" colSpan="1" >[setGroupMemberRole](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setGroupMemberRole)</td>
2099
-
2100
- <td rowspan="1" colSpan="1" >设置群成员角色。</td>
2101
- </tr>
2102
-
2103
- <tr>
2104
- <td rowspan="1" colSpan="1" >[setGroupMemberNameCard](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setGroupMemberNameCard)</td>
2105
-
2106
- <td rowspan="1" colSpan="1" >设置群成员名片。</td>
2107
- </tr>
2108
-
2109
- <tr>
2110
- <td rowspan="1" colSpan="1" >[setChatPinned](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setChatPinned)</td>
2111
-
2112
- <td rowspan="1" colSpan="1" >设置聊天置顶。</td>
2113
- </tr>
2114
-
2115
- <tr>
2116
- <td rowspan="1" colSpan="1" >[setChatMuted](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setChatMuted)</td>
2117
-
2118
- <td rowspan="1" colSpan="1" >设置聊天免打扰。</td>
2119
- </tr>
2120
-
2121
- <tr>
2122
- <td rowspan="1" colSpan="1" >[setGroupMemberMuteTime](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setGroupMemberMuteTime)</td>
2123
-
2124
- <td rowspan="1" colSpan="1" >设置群成员禁言。</td>
2125
- </tr>
2126
-
2127
- <tr>
2128
- <td rowspan="1" colSpan="1" >[setMuteAllMember](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setMuteAllMember)</td>
2129
-
2130
- <td rowspan="1" colSpan="1" >设置全员禁言。</td>
2131
- </tr>
2132
-
2133
- <tr>
2134
- <td rowspan="1" colSpan="1" >[dismissGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#dismissGroup)</td>
2135
-
2136
- <td rowspan="1" colSpan="1" >解散群组。</td>
2137
- </tr>
2138
-
2139
- <tr>
2140
- <td rowspan="1" colSpan="1" >[quitGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#quitGroup)</td>
2141
-
2142
- <td rowspan="1" colSpan="1" >退出群组。</td>
2143
- </tr>
2144
-
2145
- <tr>
2146
- <td rowspan="1" colSpan="1" >[hasPermission](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#hasPermission)</td>
2147
-
2148
- <td rowspan="1" colSpan="1" >检查权限。</td>
2149
- </tr>
2150
-
2151
- <tr>
2152
- <td rowspan="1" colSpan="1" >[canOperateOnMember](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#canOperateOnMember)</td>
2153
-
2154
- <td rowspan="1" colSpan="1" >检查成员操作权限。</td>
2155
- </tr>
2156
-
2157
- <tr>
2158
- <td rowspan="1" colSpan="1" >[getAvailablePermissions](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getAvailablePermissions)</td>
2159
-
2160
- <td rowspan="1" colSpan="1" >获取可用权限。</td>
2161
- </tr>
2162
-
2163
- <tr>
2164
- <td rowspan="1" colSpan="1" >[initWatcher](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#initWatcher)</td>
2165
-
2166
- <td rowspan="1" colSpan="1" >初始化监听器。</td>
2167
- </tr>
2168
- </table>
2169
-
2170
-
2171
- ## VideoMixerState
2172
-
2173
- 视频混流管理模块
2174
- - 核心功能:管理视频混流功能,支持多路视频合成、布局管理、媒体源控制等高级视频处理功能。
2175
-
2176
- - 技术特点:支持实时视频混流、动态布局调整、媒体源管理等功能。新增 isVideoMixerEnabled、mediaSourceList、activeMediaSource 响应式数据和完整的混流控制接口。
2177
-
2178
- - 业务价值:为直播平台提供专业的视频制作能力,提升直播质量。
2179
-
2180
- - 应用场景:多人直播、画中画、视频合成、专业制作等场景。
2181
-
2182
-
2183
- **响应式数据**
2184
-
2185
- <table>
2186
- <tr>
2187
- <td rowspan="1" colSpan="1" >**数据列表**</td>
2188
-
2189
- <td rowspan="1" colSpan="1" >**描述**</td>
2190
- </tr>
2191
-
2192
- <tr>
2193
- <td rowspan="1" colSpan="1" >[publishVideoQuality](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#publishVideoQuality)</td>
2194
-
2195
- <td rowspan="1" colSpan="1" >根据分辨率获取尺寸。</td>
2196
- </tr>
2197
-
2198
- <tr>
2199
- <td rowspan="1" colSpan="1" >[isVideoMixerEnabled](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isVideoMixerEnabled)</td>
2200
-
2201
- <td rowspan="1" colSpan="1" >视频混流是否启用。</td>
2202
- </tr>
2203
-
2204
- <tr>
2205
- <td rowspan="1" colSpan="1" >[mediaSourceList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#mediaSourceList)</td>
2206
-
2207
- <td rowspan="1" colSpan="1" >媒体源列表。</td>
2208
- </tr>
2209
-
2210
- <tr>
2211
- <td rowspan="1" colSpan="1" >[activeMediaSource](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#activeMediaSource)</td>
2212
-
2213
- <td rowspan="1" colSpan="1" >当前活跃的媒体源。</td>
2214
- </tr>
2215
- </table>
2216
-
2217
-
2218
- **接口函数**
2219
-
2220
- <table>
2221
- <tr>
2222
- <td rowspan="1" colSpan="1" >**函数列表**</td>
2223
-
2224
- <td rowspan="1" colSpan="1" >**描述**</td>
2225
- </tr>
2226
-
2227
- <tr>
2228
- <td rowspan="1" colSpan="1" >[getVideoDataByQuality](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getVideoDataByQuality)</td>
2229
-
2230
- <td rowspan="1" colSpan="1" >根据质量获取视频数据。</td>
2231
- </tr>
2232
-
2233
- <tr>
2234
- <td rowspan="1" colSpan="1" >[getSizeByQuality](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getSizeByQuality)</td>
2235
-
2236
- <td rowspan="1" colSpan="1" >根据质量获取尺寸。</td>
2237
- </tr>
2238
-
2239
- <tr>
2240
- <td rowspan="1" colSpan="1" >[getSizeByResolution](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getSizeByResolution)</td>
2241
-
2242
- <td rowspan="1" colSpan="1" >根据分辨率获取尺寸。</td>
2243
- </tr>
2244
-
2245
- <tr>
2246
- <td rowspan="1" colSpan="1" >[transformTUIVideoQualityToTRTCVideoResolution](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#transformTUIVideoQualityToTRTCVideoResolution)</td>
2247
-
2248
- <td rowspan="1" colSpan="1" >转换视频质量到 TRTC 分辨率。</td>
2249
- </tr>
2250
-
2251
- <tr>
2252
- <td rowspan="1" colSpan="1" >[transformTRTCVideoResolutionToTUIVideoQuality](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#transformTRTCVideoResolutionToTUIVideoQuality)</td>
2253
-
2254
- <td rowspan="1" colSpan="1" >转换 TRTC 分辨率到视频质量。</td>
2255
- </tr>
2256
-
2257
- <tr>
2258
- <td rowspan="1" colSpan="1" >[transformTRTCVideoResModeToTUIVideoResMode](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#transformTRTCVideoResModeToTUIVideoResMode)</td>
2259
-
2260
- <td rowspan="1" colSpan="1" >转换 TRTC 分辨率模式。</td>
2261
- </tr>
2262
-
2263
- <tr>
2264
- <td rowspan="1" colSpan="1" >[changeActiveMediaSource](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#changeActiveMediaSource)</td>
2265
-
2266
- <td rowspan="1" colSpan="1" >切换活跃媒体源。</td>
2267
- </tr>
2268
-
2269
- <tr>
2270
- <td rowspan="1" colSpan="1" >[updateVideoQuality](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#updateVideoQuality)</td>
2271
-
2272
- <td rowspan="1" colSpan="1" >更新视频质量。</td>
2273
- </tr>
2274
-
2275
- <tr>
2276
- <td rowspan="1" colSpan="1" >[getDefaultLayoutByMediaSource](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getDefaultLayoutByMediaSource)</td>
2277
-
2278
- <td rowspan="1" colSpan="1" >根据媒体源获取默认布局。</td>
2279
- </tr>
2280
-
2281
- <tr>
2282
- <td rowspan="1" colSpan="1" >[addMediaSource](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#addMediaSource)</td>
2283
-
2284
- <td rowspan="1" colSpan="1" >添加媒体源。</td>
2285
- </tr>
2286
-
2287
- <tr>
2288
- <td rowspan="1" colSpan="1" >[updateMediaSource](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#updateMediaSource)</td>
2289
-
2290
- <td rowspan="1" colSpan="1" >更新媒体源。</td>
2291
- </tr>
2292
-
2293
- <tr>
2294
- <td rowspan="1" colSpan="1" >[removeMediaSource](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#removeMediaSource)</td>
2295
-
2296
- <td rowspan="1" colSpan="1" >移除媒体源。</td>
2297
- </tr>
2298
-
2299
- <tr>
2300
- <td rowspan="1" colSpan="1" >[enableLocalVideoMixer](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#enableLocalVideoMixer)</td>
2301
-
2302
- <td rowspan="1" colSpan="1" >启用本地视频混流。</td>
2303
- </tr>
2304
-
2305
- <tr>
2306
- <td rowspan="1" colSpan="1" >[clearMediaSource](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#clearMediaSource)</td>
2307
-
2308
- <td rowspan="1" colSpan="1" >清空所有媒体源。</td>
2309
- </tr>
2310
-
2311
- <tr>
2312
- <td rowspan="1" colSpan="1" >[initMediaSourceManager](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#initMediaSourceManager)</td>
2313
-
2314
- <td rowspan="1" colSpan="1" >初始化媒体源管理器。</td>
2315
- </tr>
2316
-
2317
- <tr>
2318
- <td rowspan="1" colSpan="1" >[initVideoMixerState](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#initVideoMixerState)</td>
2319
-
2320
- <td rowspan="1" colSpan="1" >初始化视频混流状态。</td>
2321
- </tr>
2322
- </table>
2323
-
2324
-
2325
- ## VirtualBackgroundState
2326
-
2327
- 虚拟背景管理模块
2328
- - 核心功能:管理虚拟背景功能,支持背景替换、背景模糊、自定义背景等视频美化功能。
2329
-
2330
- - 技术特点:基于 AI 技术实现实时背景分割和替换。新增 virtualBackgroundConfig 响应式数据和 isSupported、setVirtualBackground 接口函数。
2331
-
2332
- - 业务价值:为用户提供隐私保护和视频美化功能,提升视频通话体验。
2333
-
2334
- - 应用场景:视频通话、在线会议、直播美化、隐私保护等场景。
2335
-
2336
-
2337
- **响应式数据**
2338
-
2339
- <table>
2340
- <tr>
2341
- <td rowspan="1" colSpan="1" >**数据列表**</td>
2342
-
2343
- <td rowspan="1" colSpan="1" >**描述**</td>
2344
- </tr>
2345
-
2346
- <tr>
2347
- <td rowspan="1" colSpan="1" >[virtualBackgroundConfig](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#virtualBackgroundConfig)</td>
2348
-
2349
- <td rowspan="1" colSpan="1" >虚拟背景配置。</td>
2350
- </tr>
2351
- </table>
2352
-
2353
-
2354
- **接口函数**
2355
-
2356
- <table>
2357
- <tr>
2358
- <td rowspan="1" colSpan="1" >**函数列表**</td>
2359
-
2360
- <td rowspan="1" colSpan="1" >**描述**</td>
2361
- </tr>
2362
-
2363
- <tr>
2364
- <td rowspan="1" colSpan="1" >[initVirtualBackground](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#initVirtualBackground)</td>
2365
-
2366
- <td rowspan="1" colSpan="1" >初始化虚拟背景。</td>
2367
- </tr>
2368
-
2369
- <tr>
2370
- <td rowspan="1" colSpan="1" >[saveVirtualBackground](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#saveVirtualBackground)</td>
2371
-
2372
- <td rowspan="1" colSpan="1" >保存虚拟背景。</td>
2373
- </tr>
2374
-
2375
- <tr>
2376
- <td rowspan="1" colSpan="1" >[isSupported](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isSupported)</td>
2377
-
2378
- <td rowspan="1" colSpan="1" >检查是否支持。</td>
2379
- </tr>
2380
-
2381
- <tr>
2382
- <td rowspan="1" colSpan="1" >[setVirtualBackground](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setVirtualBackground)</td>
2383
-
2384
- <td rowspan="1" colSpan="1" >设置虚拟背景。</td>
2385
- </tr>
2386
- </table>
2387
-
2388
-
2389
- ## ASRState
2390
-
2391
- 语音识别管理模块
2392
- - 核心功能:管理语音识别功能,支持实时语音转文字、转录历史管理、转录导出等功能。
2393
-
2394
- - 技术特点:基于先进的 ASR 技术,支持多语言识别、实时转录、历史记录等功能。新增 recentTranscripts、transcriptHistory 响应式数据和 exportTranscripts 接口。
2395
-
2396
- - 业务价值:为用户提供语音转文字服务,提升沟通效率和可访问性。
2397
-
2398
- - 应用场景:会议记录、语音转录、无障碍通信、内容记录等场景。
2399
-
2400
-
2401
- **响应式数据**
2402
-
2403
- <table>
2404
- <tr>
2405
- <td rowspan="1" colSpan="1" >**数据列表**</td>
2406
-
2407
- <td rowspan="1" colSpan="1" >**描述**</td>
2408
- </tr>
2409
-
2410
- <tr>
2411
- <td rowspan="1" colSpan="1" >[recentTranscripts](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#recentTranscripts)</td>
2412
-
2413
- <td rowspan="1" colSpan="1" >最近的语音转录记录。</td>
2414
- </tr>
2415
-
2416
- <tr>
2417
- <td rowspan="1" colSpan="1" >[transcriptHistory](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#transcriptHistory)</td>
2418
-
2419
- <td rowspan="1" colSpan="1" >语音转录历史记录。</td>
2420
- </tr>
2421
- </table>
2422
-
2423
-
2424
- **接口函数**
2425
-
2426
- <table>
2427
- <tr>
2428
- <td rowspan="1" colSpan="1" >**函数列表**</td>
2429
-
2430
- <td rowspan="1" colSpan="1" >**描述**</td>
2431
- </tr>
2432
-
2433
- <tr>
2434
- <td rowspan="1" colSpan="1" >[setRecentTranscriptsDuration](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setRecentTranscriptsDuration)</td>
2435
-
2436
- <td rowspan="1" colSpan="1" >设置最近转录时长。</td>
2437
- </tr>
2438
-
2439
- <tr>
2440
- <td rowspan="1" colSpan="1" >[clearHistory](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#clearHistory)</td>
2441
-
2442
- <td rowspan="1" colSpan="1" >清空转录历史记录。</td>
2443
- </tr>
2444
-
2445
- <tr>
2446
- <td rowspan="1" colSpan="1" >[exportTranscripts](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#exportTranscripts)</td>
2447
-
2448
- <td rowspan="1" colSpan="1" >导出转录内容。</td>
2449
- </tr>
2450
- </table>
2451
-
2452
-
2453
- ## SearchState
2454
-
2455
- 搜索功能管理模块
2456
- - 核心功能:管理全局搜索功能,支持消息搜索、用户搜索、群组搜索等多维度搜索能力。
2457
-
2458
- - 技术特点:支持高级搜索、搜索历史、搜索建议等功能。重构响应式数据为 keyword、results、isLoading 等标准化字段,提供完整的搜索接口。
2459
-
2460
- - 业务价值:为用户提供快速查找信息的能力,提升使用效率。
2461
-
2462
- - 应用场景:消息搜索、联系人搜索、内容查找、历史记录等场景。
2463
-
2464
-
2465
- **响应式数据**
2466
-
2467
- <table>
2468
- <tr>
2469
- <td rowspan="1" colSpan="1" >**数据列表**</td>
2470
-
2471
- <td rowspan="1" colSpan="1" >**描述**</td>
2472
- </tr>
2473
-
2474
- <tr>
2475
- <td rowspan="1" colSpan="1" >[keyword](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#keyword)</td>
2476
-
2477
- <td rowspan="1" colSpan="1" >搜索关键词。</td>
2478
- </tr>
2479
-
2480
- <tr>
2481
- <td rowspan="1" colSpan="1" >[results](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#results)</td>
2482
-
2483
- <td rowspan="1" colSpan="1" >搜索结果。</td>
2484
- </tr>
2485
-
2486
- <tr>
2487
- <td rowspan="1" colSpan="1" >[isLoading](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isLoading)</td>
2488
-
2489
- <td rowspan="1" colSpan="1" >是否正在加载。</td>
2490
- </tr>
2491
-
2492
- <tr>
2493
- <td rowspan="1" colSpan="1" >[error](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#error)</td>
2494
-
2495
- <td rowspan="1" colSpan="1" >错误信息。</td>
2496
- </tr>
2497
-
2498
- <tr>
2499
- <td rowspan="1" colSpan="1" >[searchAdvancedParams](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#searchAdvancedParams)</td>
2500
-
2501
- <td rowspan="1" colSpan="1" >高级搜索参数。</td>
2502
- </tr>
2503
-
2504
- <tr>
2505
- <td rowspan="1" colSpan="1" >[selectedSearchType](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#selectedSearchType)</td>
2506
-
2507
- <td rowspan="1" colSpan="1" >选中的搜索类型。</td>
2508
- </tr>
2509
- </table>
2510
-
2511
-
2512
- **接口函数**
2513
-
2514
- <table>
2515
- <tr>
2516
- <td rowspan="1" colSpan="1" >**函数列表**</td>
2517
-
2518
- <td rowspan="1" colSpan="1" >**描述**</td>
2519
- </tr>
2520
-
2521
- <tr>
2522
- <td rowspan="1" colSpan="1" >[search](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#search)</td>
2523
-
2524
- <td rowspan="1" colSpan="1" >搜索。</td>
2525
- </tr>
2526
-
2527
- <tr>
2528
- <td rowspan="1" colSpan="1" >[setKeyword](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setKeyword)</td>
2529
-
2530
- <td rowspan="1" colSpan="1" >设置关键词。</td>
2531
- </tr>
2532
-
2533
- <tr>
2534
- <td rowspan="1" colSpan="1" >[setSelectedType](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setSelectedType)</td>
2535
-
2536
- <td rowspan="1" colSpan="1" >设置选中类型。</td>
2537
- </tr>
2538
-
2539
- <tr>
2540
- <td rowspan="1" colSpan="1" >[setSearchMessageAdvancedParams](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setSearchMessageAdvancedParams)</td>
2541
-
2542
- <td rowspan="1" colSpan="1" >设置消息搜索高级参数。</td>
2543
- </tr>
2544
-
2545
- <tr>
2546
- <td rowspan="1" colSpan="1" >[setSearchUserAdvancedParams](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setSearchUserAdvancedParams)</td>
2547
-
2548
- <td rowspan="1" colSpan="1" >设置用户搜索高级参数。</td>
2549
- </tr>
2550
-
2551
- <tr>
2552
- <td rowspan="1" colSpan="1" >[setSearchGroupAdvancedParams](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setSearchGroupAdvancedParams)</td>
2553
-
2554
- <td rowspan="1" colSpan="1" >设置群组搜索高级参数。</td>
2555
- </tr>
2556
-
2557
- <tr>
2558
- <td rowspan="1" colSpan="1" >[loadMore](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#loadMore)</td>
2559
-
2560
- <td rowspan="1" colSpan="1" >加载更多。</td>
2561
- </tr>
2562
- </table>
2563
-
2564
-
2565
- ## SeatStore
2566
-
2567
- 座位存储管理模块
2568
- - 核心功能:提供座位状态的底层存储和管理,支持座位信息缓存、用户信息映射、设备请求处理等核心功能。
2569
-
2570
- - 技术特点:采用响应式存储设计,支持实时状态同步、事件驱动更新等功能。新增 liveOwnerUserId、localUserId、seatList 等响应式数据和 getUserInfo、convertUserInfoToAudienceInfo 接口。
2571
-
2572
- - 业务价值:为座位管理提供可靠的数据基础,确保座位状态的一致性。
2573
-
2574
- - 应用场景:座位状态管理、用户信息存储、设备状态跟踪等底层场景。
2575
-
2576
-
2577
- **响应式数据**
2578
-
2579
- <table>
2580
- <tr>
2581
- <td rowspan="1" colSpan="1" >**数据列表**</td>
2582
-
2583
- <td rowspan="1" colSpan="1" >**描述**</td>
2584
- </tr>
2585
-
2586
- <tr>
2587
- <td rowspan="1" colSpan="1" >[liveOwnerUserId](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#liveOwnerUserId)</td>
2588
-
2589
- <td rowspan="1" colSpan="1" >直播间主播用户 ID。</td>
2590
- </tr>
2591
-
2592
- <tr>
2593
- <td rowspan="1" colSpan="1" >[localUserId](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#localUserId)</td>
2594
-
2595
- <td rowspan="1" colSpan="1" >本地用户 ID。</td>
2596
- </tr>
2597
-
2598
- <tr>
2599
- <td rowspan="1" colSpan="1" >[seatList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#seatList)</td>
2600
-
2601
- <td rowspan="1" colSpan="1" >麦位列表,包含所有麦位的状态和用户信息。</td>
2602
- </tr>
2603
-
2604
- <tr>
2605
- <td rowspan="1" colSpan="1" >[coHostUserList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#coHostUserList)</td>
2606
-
2607
- <td rowspan="1" colSpan="1" >连麦主播列表。</td>
2608
- </tr>
2609
-
2610
- <tr>
2611
- <td rowspan="1" colSpan="1" >[sentDeviceRequestMap](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#sentDeviceRequestMap)</td>
2612
-
2613
- <td rowspan="1" colSpan="1" >已发送的设备请求映射。</td>
2614
- </tr>
2615
-
2616
- <tr>
2617
- <td rowspan="1" colSpan="1" >[receivedDeviceRequestMap](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#receivedDeviceRequestMap)</td>
2618
-
2619
- <td rowspan="1" colSpan="1" >已接收的设备请求映射。</td>
2620
- </tr>
2621
-
2622
- <tr>
2623
- <td rowspan="1" colSpan="1" >[userInfoMap](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#userInfoMap)</td>
2624
-
2625
- <td rowspan="1" colSpan="1" >用户信息映射表。</td>
2626
- </tr>
2627
- </table>
2628
-
2629
-
2630
- **接口函数**
2631
-
2632
- <table>
2633
- <tr>
2634
- <td rowspan="1" colSpan="1" >函数列表</td>
2635
-
2636
- <td rowspan="1" colSpan="1" >描述</td>
2637
- </tr>
2638
-
2639
- <tr>
2640
- <td rowspan="1" colSpan="1" >[getUserInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getUserInfo)</td>
2641
-
2642
- <td rowspan="1" colSpan="1" >获取用户信息。</td>
2643
- </tr>
2644
-
2645
- <tr>
2646
- <td rowspan="1" colSpan="1" >[convertUserInfoToAudienceInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#convertUserInfoToAudienceInfo)</td>
2647
-
2648
- <td rowspan="1" colSpan="1" >转换用户信息为观众信息。</td>
2649
- </tr>
2650
- </table>
2651
-
2652
-
2653
-
2654
-
2655
-
2656
-