@tencentcloud/sdk-mcp 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (31) hide show
  1. package/README.md +20 -0
  2. package/index.js +16 -0
  3. package/index.js.map +1 -0
  4. package/package.json +37 -0
  5. package/resource/doc/tuicallkit/android/.gitkeep +0 -0
  6. package/resource/doc/tuicallkit/android/api_TUICallKit.md +663 -0
  7. package/resource/doc/tuicallkit/android/api_TUICallObserver.md +786 -0
  8. package/resource/doc/tuicallkit/android/how_to_integrated_android_callkit.md +302 -0
  9. package/resource/doc/tuicallkit/faq/faq.md +1068 -0
  10. package/resource/doc/tuicallkit/flutter/api_TUICallDefine.md +932 -0
  11. package/resource/doc/tuicallkit/flutter/api_TUICallKit.md +452 -0
  12. package/resource/doc/tuicallkit/flutter/api_TUICallObserver.md +926 -0
  13. package/resource/doc/tuicallkit/flutter/how_to_integrated_flutter_callkit.md +226 -0
  14. package/resource/doc/tuicallkit/flutter/how_to_run_flutter_callkit_demo.md +101 -0
  15. package/resource/doc/tuicallkit/iOS/api_TUICallKit.md +635 -0
  16. package/resource/doc/tuicallkit/iOS/api_TUICallObserver.md +779 -0
  17. package/resource/doc/tuicallkit/iOS/how_to_integrated_iOS_callkit.md +269 -0
  18. package/resource/doc/tuicallkit/iOS/how_to_run_iOS_callkit_demo.md +98 -0
  19. package/resource/doc/tuicallkit/react/.gitkeep +0 -0
  20. package/resource/doc/tuicallkit/react/api_TUICallKit.md +1909 -0
  21. package/resource/doc/tuicallkit/react/how_to_integrated_react_callkit.md +195 -0
  22. package/resource/doc/tuicallkit/react/how_to_run_react_callkit_demo.md +93 -0
  23. package/resource/doc/tuicallkit/vue/.gitkeep +0 -0
  24. package/resource/doc/tuicallkit/vue/api_TUICallKit.md +1909 -0
  25. package/resource/doc/tuicallkit/vue/api_TUICallObserver.md +926 -0
  26. package/resource/doc/tuicallkit/vue/how_to_integrated_vue_callkit.md +415 -0
  27. package/resource/doc/tuicallkit/vue/how_to_run_vue_callkit_demo.md +93 -0
  28. package/server.js +124 -0
  29. package/server.js.map +1 -0
  30. package/streamableHttp.js +74 -0
  31. package/streamableHttp.js.map +1 -0
package/resource/doc/tuicallkit/flutter/api_TUICallKit.md ADDED
@@ -0,0 +1,452 @@
1
+ ## TUICallKit API 简介
2
+
3
+ TUICallKit API 是音视频通话组件的**含 UI 接口**，使用TUICallKit API，您可以通过简单接口快速实现一个类微信的音视频通话场景，更详细的接入步骤，详情请参见 [快速接入（TUICallKit）](https://write.woa.com/document/86735801792671744)。
4
+
5
+ ## API 概览
6
+ <table>
7
+ <tr>
8
+ <td rowspan="1" colSpan="1" >API</td>
9
+
10
+ <td rowspan="1" colSpan="1" >描述</td>
11
+ </tr>
12
+
13
+ <tr>
14
+ <td rowspan="1" colSpan="1" >[login](https://write.woa.com/document/94733520019521536)</td>
15
+
16
+ <td rowspan="1" colSpan="1" >登录</td>
17
+ </tr>
18
+
19
+ <tr>
20
+ <td rowspan="1" colSpan="1" >[logout](https://write.woa.com/#logout)</td>
21
+
22
+ <td rowspan="1" colSpan="1" >登出</td>
23
+ </tr>
24
+
25
+ <tr>
26
+ <td rowspan="1" colSpan="1" >[setSelfInfo](https://write.woa.com/document/94733520019521536)</td>
27
+
28
+ <td rowspan="1" colSpan="1" >设置用户的昵称、头像</td>
29
+ </tr>
30
+
31
+ <tr>
32
+ <td rowspan="1" colSpan="1" >[calls](https://write.woa.com/document/94733520019521536)</td>
33
+
34
+ <td rowspan="1" colSpan="1" >发起通话。</td>
35
+ </tr>
36
+
37
+ <tr>
38
+ <td rowspan="1" colSpan="1" >[join](https://write.woa.com/document/94733520019521536)</td>
39
+
40
+ <td rowspan="1" colSpan="1" >主动加入通话。</td>
41
+ </tr>
42
+
43
+ <tr>
44
+ <td rowspan="1" colSpan="1" >[enableMuteMode](https://write.woa.com/document/94733520019521536)</td>
45
+
46
+ <td rowspan="1" colSpan="1" >开启/关闭静音模式</td>
47
+ </tr>
48
+
49
+ <tr>
50
+ <td rowspan="1" colSpan="1" >[enableFloatWindow](https://write.woa.com/document/94733520019521536)</td>
51
+
52
+ <td rowspan="1" colSpan="1" >开启/关闭悬浮窗功能</td>
53
+ </tr>
54
+
55
+ <tr>
56
+ <td rowspan="1" colSpan="1" >[setCallingBell](https://write.woa.com/document/94733520019521536)</td>
57
+
58
+ <td rowspan="1" colSpan="1" >设置自定义来电铃音</td>
59
+ </tr>
60
+
61
+ <tr>
62
+ <td rowspan="1" colSpan="1" >[enableVirtualBackground](https://write.woa.com/document/94733520019521536)</td>
63
+
64
+ <td rowspan="1" colSpan="1" >开启/关闭虚拟背景功能</td>
65
+ </tr>
66
+ </table>
67
+
68
+
69
+ ## API 详情
70
+
71
+ ### login
72
+
73
+ 登录。
74
+ ``` cpp
75
+ Future<TUIResult> login(int sdkAppId, String userId, String userSig)
76
+ ```
77
+ <table>
78
+ <tr>
79
+ <td rowspan="1" colSpan="1" >参数</td>
80
+
81
+ <td rowspan="1" colSpan="1" >类型</td>
82
+
83
+ <td rowspan="1" colSpan="1" >含义</td>
84
+ </tr>
85
+
86
+ <tr>
87
+ <td rowspan="1" colSpan="1" >sdkAppId</td>
88
+
89
+ <td rowspan="1" colSpan="1" >int</td>
90
+
91
+ <td rowspan="1" colSpan="1" >用户 SDKAppID</td>
92
+ </tr>
93
+
94
+ <tr>
95
+ <td rowspan="1" colSpan="1" >userId</td>
96
+
97
+ <td rowspan="1" colSpan="1" >String</td>
98
+
99
+ <td rowspan="1" colSpan="1" >用户 ID</td>
100
+ </tr>
101
+
102
+ <tr>
103
+ <td rowspan="1" colSpan="1" >userSig</td>
104
+
105
+ <td rowspan="1" colSpan="1" >String</td>
106
+
107
+ <td rowspan="1" colSpan="1" >用户签名 userSig</td>
108
+ </tr>
109
+
110
+ <tr>
111
+ <td rowspan="1" colSpan="1" >返回值</td>
112
+
113
+ <td rowspan="1" colSpan="1" >[TUIResult](https://write.woa.com/document/109226385552285696)</td>
114
+
115
+ <td rowspan="1" colSpan="1" >包含 code 和 message 信息：code 为空 ("") 表示调用成功；code 不为空 ("") 表示调用失败，失败原因见 message</td>
116
+ </tr>
117
+ </table>
118
+
119
+
120
+ ### logout
121
+
122
+ 登出。
123
+ ``` cpp
124
+ Future<void> logout()
125
+ ```
126
+
127
+ ### setSelfInfo
128
+
129
+ 设置用户昵称、头像。用户昵称不能超过500字节，用户头像必须是URL格式。
130
+ ``` cpp
131
+ Future<TUIResult> setSelfInfo(String nickname, String avatar)
132
+ ```
133
+ <table>
134
+ <tr>
135
+ <td rowspan="1" colSpan="1" >参数</td>
136
+
137
+ <td rowspan="1" colSpan="1" >类型</td>
138
+
139
+ <td rowspan="1" colSpan="1" >含义</td>
140
+ </tr>
141
+
142
+ <tr>
143
+ <td rowspan="1" colSpan="1" >nickName</td>
144
+
145
+ <td rowspan="1" colSpan="1" >String</td>
146
+
147
+ <td rowspan="1" colSpan="1" >目标用户的昵称，非必填</td>
148
+ </tr>
149
+
150
+ <tr>
151
+ <td rowspan="1" colSpan="1" >avatar</td>
152
+
153
+ <td rowspan="1" colSpan="1" >String</td>
154
+
155
+ <td rowspan="1" colSpan="1" >目标用户的头像，非必填</td>
156
+ </tr>
157
+
158
+ <tr>
159
+ <td rowspan="1" colSpan="1" >返回值</td>
160
+
161
+ <td rowspan="1" colSpan="1" >[TUIResult](https://write.woa.com/document/109226385552285696)</td>
162
+
163
+ <td rowspan="1" colSpan="1" >包含 code 和 message 信息：code 为空 ("") 表示调用成功；code 不为空 ("") 表示调用失败，失败原因见 message</td>
164
+ </tr>
165
+ </table>
166
+
167
+
168
+ ### calls
169
+
170
+ 发起通话。**v2.9+ 版本支持。**
171
+ ``` java
172
+ Future<TUIResult> calls(List<String> userIdList, TUICallMediaType mediaType, TUICallParams params)
173
+ ```
174
+ <table>
175
+ <tr>
176
+ <td rowspan="1" colSpan="1" >参数</td>
177
+
178
+ <td rowspan="1" colSpan="1" >类型</td>
179
+
180
+ <td rowspan="1" colSpan="1" >含义</td>
181
+ </tr>
182
+
183
+ <tr>
184
+ <td rowspan="1" colSpan="1" >userIdList</td>
185
+
186
+ <td rowspan="1" colSpan="1" >List<String></td>
187
+
188
+ <td rowspan="1" colSpan="1" >目标用户的userId 列表</td>
189
+ </tr>
190
+
191
+ <tr>
192
+ <td rowspan="1" colSpan="1" >callMediaType</td>
193
+
194
+ <td rowspan="1" colSpan="1" >[TUICallMediaType](https://write.woa.com/document/109226385552285696)</td>
195
+
196
+ <td rowspan="1" colSpan="1" >通话的媒体类型，比如：`TUICallMediaType.video `或 `TUICallMediaType.audio`</td>
197
+ </tr>
198
+
199
+ <tr>
200
+ <td rowspan="1" colSpan="1" >params</td>
201
+
202
+ <td rowspan="1" colSpan="1" >[TUICallParams](https://write.woa.com/document/109226385552285696)</td>
203
+
204
+ <td rowspan="1" colSpan="1" >**可选**通话扩展参数，例如：房间号、通话邀请超时时间，离线推送自定义内容等</td>
205
+ </tr>
206
+ </table>
207
+
208
+
209
+ ### join
210
+
211
+ 主动加入通话。**v2.9+ 版本支持。**
212
+ ``` java
213
+ Future<void> join(String callId)
214
+ ```
215
+ <table>
216
+ <tr>
217
+ <td rowspan="1" colSpan="1" >参数</td>
218
+
219
+ <td rowspan="1" colSpan="1" >类型</td>
220
+
221
+ <td rowspan="1" colSpan="1" >含义</td>
222
+ </tr>
223
+
224
+ <tr>
225
+ <td rowspan="1" colSpan="1" >callId</td>
226
+
227
+ <td rowspan="1" colSpan="1" >String</td>
228
+
229
+ <td rowspan="1" colSpan="1" >此次通话的唯一 ID</td>
230
+ </tr>
231
+ </table>
232
+
233
+
234
+ ### enableMuteMode
235
+
236
+ 开启后，收到通话请求，不会播放来电铃声。
237
+ ``` javascript
238
+ Future<void> enableMuteMode(bool enable)
239
+ ```
240
+ <table>
241
+ <tr>
242
+ <td rowspan="1" colSpan="1" >参数</td>
243
+
244
+ <td rowspan="1" colSpan="1" >类型</td>
245
+
246
+ <td rowspan="1" colSpan="1" >含义</td>
247
+ </tr>
248
+
249
+ <tr>
250
+ <td rowspan="1" colSpan="1" >enable</td>
251
+
252
+ <td rowspan="1" colSpan="1" >bool</td>
253
+
254
+ <td rowspan="1" colSpan="1" >开启、关闭静音；true 表示开启静音</td>
255
+ </tr>
256
+ </table>
257
+
258
+
259
+ ### enableFloatWindow
260
+
261
+ 开启/关闭悬浮窗功能，设置为false后，通话界面左上角的悬浮窗按钮会隐藏。
262
+ ``` javascript
263
+ Future<void> enableFloatWindow(bool enable)
264
+ ```
265
+ <table>
266
+ <tr>
267
+ <td rowspan="1" colSpan="1" >参数</td>
268
+
269
+ <td rowspan="1" colSpan="1" >类型</td>
270
+
271
+ <td rowspan="1" colSpan="1" >含义</td>
272
+ </tr>
273
+
274
+ <tr>
275
+ <td rowspan="1" colSpan="1" >enable</td>
276
+
277
+ <td rowspan="1" colSpan="1" >bool</td>
278
+
279
+ <td rowspan="1" colSpan="1" >开启、关闭悬浮窗功能；true 表示开启浮窗</td>
280
+ </tr>
281
+ </table>
282
+
283
+
284
+ ### setCallingBell
285
+
286
+ 自定义来电铃声：将铃声文件添加至主工程的`assets`资源中，传入资源文件名称即可。
287
+ ``` javascript
288
+ Future<void> setCallingBell(String assetName)
289
+ ```
290
+
291
+ ### enableVirtualBackground
292
+
293
+ 开启/关闭虚拟背景功能，开启虚拟背景功能后，您可以在 UI 上显示模糊背景的功能按钮，点击按钮可直接启用模糊背景功能。
294
+ ``` javascript
295
+ Future<void> enableVirtualBackground(bool enable)
296
+ ```
297
+ <table>
298
+ <tr>
299
+ <td rowspan="1" colSpan="1" >参数</td>
300
+
301
+ <td rowspan="1" colSpan="1" >类型</td>
302
+
303
+ <td rowspan="1" colSpan="1" >含义</td>
304
+ </tr>
305
+
306
+ <tr>
307
+ <td rowspan="1" colSpan="1" >enable</td>
308
+
309
+ <td rowspan="1" colSpan="1" >bool</td>
310
+
311
+ <td rowspan="1" colSpan="1" >开启、关闭静音；true 表示开启静音</td>
312
+ </tr>
313
+ </table>
314
+
315
+
316
+ ## 废弃接口
317
+
318
+ ### call
319
+
320
+ 拨打电话（1v1通话）。
321
+
322
+ > **注意：**
323
+ >
324
+
325
+ > 该接口已在 v2.9+ 版本废弃，建议使用 calls 接口替代。
326
+ >
327
+
328
+ ``` cpp
329
+ Future<void> call(String userId, TUICallMediaType callMediaType, [TUICallParams? params])
330
+
331
+ ```
332
+ <table>
333
+ <tr>
334
+ <td rowspan="1" colSpan="1" >参数</td>
335
+
336
+ <td rowspan="1" colSpan="1" >类型</td>
337
+
338
+ <td rowspan="1" colSpan="1" >含义</td>
339
+ </tr>
340
+
341
+ <tr>
342
+ <td rowspan="1" colSpan="1" >userId</td>
343
+
344
+ <td rowspan="1" colSpan="1" >String</td>
345
+
346
+ <td rowspan="1" colSpan="1" >目标用户的 userID</td>
347
+ </tr>
348
+
349
+ <tr>
350
+ <td rowspan="1" colSpan="1" >callMediaType</td>
351
+
352
+ <td rowspan="1" colSpan="1" >[TUICallMediaType](https://write.woa.com/document/109226385552285696)</td>
353
+
354
+ <td rowspan="1" colSpan="1" >通话的媒体类型，比如：`TUICallMediaType.video `或 `TUICallMediaType.audio`</td>
355
+ </tr>
356
+ </table>
357
+
358
+
359
+ ### groupCall
360
+
361
+ 发起群组通话，注意：使用群组通话前需要创建 IM 群组，如果已经创建，请忽略。
362
+
363
+ > **注意：**
364
+ >
365
+
366
+ > 该接口已在 v2.9+ 版本废弃，建议使用 calls 接口替代。
367
+ >
368
+
369
+ ``` javascript
370
+ Future<void> groupCall(String groupId, List<String> userIdList, TUICallMediaType callMediaType,[TUICallParams? params])
371
+ ```
372
+ <table>
373
+ <tr>
374
+ <td rowspan="1" colSpan="1" >参数</td>
375
+
376
+ <td rowspan="1" colSpan="1" >类型</td>
377
+
378
+ <td rowspan="1" colSpan="1" >含义</td>
379
+ </tr>
380
+
381
+ <tr>
382
+ <td rowspan="1" colSpan="1" >groupId</td>
383
+
384
+ <td rowspan="1" colSpan="1" >String</td>
385
+
386
+ <td rowspan="1" colSpan="1" >此次群组通话的群 ID</td>
387
+ </tr>
388
+
389
+ <tr>
390
+ <td rowspan="1" colSpan="1" >userIdList</td>
391
+
392
+ <td rowspan="1" colSpan="1" >List<String></td>
393
+
394
+ <td rowspan="1" colSpan="1" >目标用户的 userId 列表</td>
395
+ </tr>
396
+
397
+ <tr>
398
+ <td rowspan="1" colSpan="1" >callMediaType</td>
399
+
400
+ <td rowspan="1" colSpan="1" >[TUICallMediaType](https://write.woa.com/document/109226385552285696)</td>
401
+
402
+ <td rowspan="1" colSpan="1" >通话的媒体类型，比如：`TUICallMediaType.video `或 `TUICallMediaType.audio`</td>
403
+ </tr>
404
+ </table>
405
+
406
+
407
+ ### joinInGroupCall
408
+
409
+ 加入群组中已有的音视频通话。
410
+
411
+ > **注意：**
412
+ >
413
+
414
+ > 该接口已在 v2.9+ 版本废弃，建议使用 join 接口替代。
415
+ >
416
+
417
+ ``` javascript
418
+ Future<void> joinInGroupCall(TUIRoomId roomId, String groupId, TUICallMediaType callMediaType)
419
+ ```
420
+ <table>
421
+ <tr>
422
+ <td rowspan="1" colSpan="1" >参数</td>
423
+
424
+ <td rowspan="1" colSpan="1" >类型</td>
425
+
426
+ <td rowspan="1" colSpan="1" >含义</td>
427
+ </tr>
428
+
429
+ <tr>
430
+ <td rowspan="1" colSpan="1" >roomId</td>
431
+
432
+ <td rowspan="1" colSpan="1" >[TUIRoomID](https://write.woa.com/document/109226385552285696)</td>
433
+
434
+ <td rowspan="1" colSpan="1" >此次通话的音视频房间 ID</td>
435
+ </tr>
436
+
437
+ <tr>
438
+ <td rowspan="1" colSpan="1" >groupId</td>
439
+
440
+ <td rowspan="1" colSpan="1" >String</td>
441
+
442
+ <td rowspan="1" colSpan="1" >此次群组通话的群 ID</td>
443
+ </tr>
444
+
445
+ <tr>
446
+ <td rowspan="1" colSpan="1" >callMediaType</td>
447
+
448
+ <td rowspan="1" colSpan="1" >[TUICallMediaType](https://write.woa.com/document/109226385552285696)</td>
449
+
450
+ <td rowspan="1" colSpan="1" >通话的媒体类型，比如：`TUICallMediaType.video `或 `TUICallMediaType.audio`</td>
451
+ </tr>
452
+ </table>