tencentcloud-sdk-python-trtc 3.0.1345__py2.py3-none-any.whl → 3.1.13__py2.py3-none-any.whl
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.
- tencentcloud/__init__.py +1 -1
- tencentcloud/trtc/v20190722/errorcodes.py +70 -1
- tencentcloud/trtc/v20190722/models.py +5560 -1685
- tencentcloud/trtc/v20190722/trtc_client.py +421 -61
- tencentcloud/trtc/v20190722/trtc_client_async.py +1516 -0
- {tencentcloud_sdk_python_trtc-3.0.1345.dist-info → tencentcloud_sdk_python_trtc-3.1.13.dist-info}/METADATA +2 -4
- tencentcloud_sdk_python_trtc-3.1.13.dist-info/RECORD +11 -0
- {tencentcloud_sdk_python_trtc-3.0.1345.dist-info → tencentcloud_sdk_python_trtc-3.1.13.dist-info}/WHEEL +1 -1
- tencentcloud_sdk_python_trtc-3.0.1345.dist-info/RECORD +0 -10
- {tencentcloud_sdk_python_trtc-3.0.1345.dist-info → tencentcloud_sdk_python_trtc-3.1.13.dist-info}/top_level.txt +0 -0
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
# -*- coding: utf8 -*-
|
|
2
|
-
# Copyright (c) 2017-
|
|
2
|
+
# Copyright (c) 2017-2025 Tencent. All Rights Reserved.
|
|
3
3
|
#
|
|
4
4
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
5
|
# you may not use this file except in compliance with the License.
|
|
@@ -27,7 +27,7 @@ class TrtcClient(AbstractClient):
|
|
|
27
27
|
|
|
28
28
|
|
|
29
29
|
def ControlAIConversation(self, request):
|
|
30
|
-
"""提供服务端控制机器人的功能
|
|
30
|
+
r"""提供服务端控制机器人的功能
|
|
31
31
|
|
|
32
32
|
:param request: Request instance for ControlAIConversation.
|
|
33
33
|
:type request: :class:`tencentcloud.trtc.v20190722.models.ControlAIConversationRequest`
|
|
@@ -50,7 +50,7 @@ class TrtcClient(AbstractClient):
|
|
|
50
50
|
|
|
51
51
|
|
|
52
52
|
def CreateBasicModeration(self, request):
|
|
53
|
-
"""接口说明:
|
|
53
|
+
r"""接口说明:
|
|
54
54
|
启动终端审核功能,完成房间内的音频审核。
|
|
55
55
|
|
|
56
56
|
:param request: Request instance for CreateBasicModeration.
|
|
@@ -73,9 +73,38 @@ class TrtcClient(AbstractClient):
|
|
|
73
73
|
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
74
74
|
|
|
75
75
|
|
|
76
|
+
def CreateCloudModeration(self, request):
|
|
77
|
+
r"""接口说明:
|
|
78
|
+
启动云端审核功能,完成房间内的音视频切片,视频截帧,或者录制音频流,送审到指定的审核商,完成审核。
|
|
79
|
+
|
|
80
|
+
您可以通过此接口实现如下目标:
|
|
81
|
+
* 指定审核参数(ModerationParams)来指定审核需要的详细参数。
|
|
82
|
+
* 指定存储参数(ModerationStorageParams)将命中的审核文件指定上传到您希望的云存储,目前支持腾讯云(对象存储COS)和第三方AWS
|
|
83
|
+
|
|
84
|
+
:param request: Request instance for CreateCloudModeration.
|
|
85
|
+
:type request: :class:`tencentcloud.trtc.v20190722.models.CreateCloudModerationRequest`
|
|
86
|
+
:rtype: :class:`tencentcloud.trtc.v20190722.models.CreateCloudModerationResponse`
|
|
87
|
+
|
|
88
|
+
"""
|
|
89
|
+
try:
|
|
90
|
+
params = request._serialize()
|
|
91
|
+
headers = request.headers
|
|
92
|
+
body = self.call("CreateCloudModeration", params, headers=headers)
|
|
93
|
+
response = json.loads(body)
|
|
94
|
+
model = models.CreateCloudModerationResponse()
|
|
95
|
+
model._deserialize(response["Response"])
|
|
96
|
+
return model
|
|
97
|
+
except Exception as e:
|
|
98
|
+
if isinstance(e, TencentCloudSDKException):
|
|
99
|
+
raise
|
|
100
|
+
else:
|
|
101
|
+
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
102
|
+
|
|
103
|
+
|
|
76
104
|
def CreateCloudRecording(self, request):
|
|
77
|
-
"""接口说明:
|
|
105
|
+
r"""接口说明:
|
|
78
106
|
启动云端录制功能,完成房间内的音视频录制,并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制又或者多路视频画面合流混成一路。
|
|
107
|
+
在线上正式运营之前,请关注录制的最佳实践 [录制最佳实践](https://cloud.tencent.com/document/product/647/76497#e7e2f04c-6cde-43c9-9cd0-0f8d22dee68c),配合最佳实践,可大大提高接口录制的可用性。
|
|
79
108
|
|
|
80
109
|
您可以通过此接口实现如下目标:
|
|
81
110
|
* 指定订阅流参数(RecordParams)来指定需要录制的主播的黑名单或者白名单。
|
|
@@ -107,8 +136,36 @@ class TrtcClient(AbstractClient):
|
|
|
107
136
|
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
108
137
|
|
|
109
138
|
|
|
139
|
+
def CreateCloudSliceTask(self, request):
|
|
140
|
+
r"""接口说明:
|
|
141
|
+
启动云端切片功能,完成房间内的音视频切片,并上传到指定的云存储。
|
|
142
|
+
|
|
143
|
+
您可以通过此接口实现如下目标:
|
|
144
|
+
* 指定切片参数(SliceParams)来指定需要切片的主播的黑名单或者白名单。
|
|
145
|
+
* 指定存储参数(SliceStorageParams)来指定上传到您希望的云存储,目前支持腾讯云(对象存储COS)和第三方AWS
|
|
146
|
+
|
|
147
|
+
:param request: Request instance for CreateCloudSliceTask.
|
|
148
|
+
:type request: :class:`tencentcloud.trtc.v20190722.models.CreateCloudSliceTaskRequest`
|
|
149
|
+
:rtype: :class:`tencentcloud.trtc.v20190722.models.CreateCloudSliceTaskResponse`
|
|
150
|
+
|
|
151
|
+
"""
|
|
152
|
+
try:
|
|
153
|
+
params = request._serialize()
|
|
154
|
+
headers = request.headers
|
|
155
|
+
body = self.call("CreateCloudSliceTask", params, headers=headers)
|
|
156
|
+
response = json.loads(body)
|
|
157
|
+
model = models.CreateCloudSliceTaskResponse()
|
|
158
|
+
model._deserialize(response["Response"])
|
|
159
|
+
return model
|
|
160
|
+
except Exception as e:
|
|
161
|
+
if isinstance(e, TencentCloudSDKException):
|
|
162
|
+
raise
|
|
163
|
+
else:
|
|
164
|
+
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
165
|
+
|
|
166
|
+
|
|
110
167
|
def CreatePicture(self, request):
|
|
111
|
-
"""如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁新增自定义背景图或水印,可通过此接口上传新的图片素材。无需频繁新增图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
|
|
168
|
+
r"""如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁新增自定义背景图或水印,可通过此接口上传新的图片素材。无需频繁新增图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
|
|
112
169
|
|
|
113
170
|
:param request: Request instance for CreatePicture.
|
|
114
171
|
:type request: :class:`tencentcloud.trtc.v20190722.models.CreatePictureRequest`
|
|
@@ -131,7 +188,7 @@ class TrtcClient(AbstractClient):
|
|
|
131
188
|
|
|
132
189
|
|
|
133
190
|
def DeleteBasicModeration(self, request):
|
|
134
|
-
"""成功开启审核任务后,可以使用此接口来停止任务。
|
|
191
|
+
r"""成功开启审核任务后,可以使用此接口来停止任务。
|
|
135
192
|
|
|
136
193
|
:param request: Request instance for DeleteBasicModeration.
|
|
137
194
|
:type request: :class:`tencentcloud.trtc.v20190722.models.DeleteBasicModerationRequest`
|
|
@@ -153,8 +210,31 @@ class TrtcClient(AbstractClient):
|
|
|
153
210
|
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
154
211
|
|
|
155
212
|
|
|
213
|
+
def DeleteCloudModeration(self, request):
|
|
214
|
+
r"""成功开启云端审核任务后,可以使用此接口来停止送审。
|
|
215
|
+
|
|
216
|
+
:param request: Request instance for DeleteCloudModeration.
|
|
217
|
+
:type request: :class:`tencentcloud.trtc.v20190722.models.DeleteCloudModerationRequest`
|
|
218
|
+
:rtype: :class:`tencentcloud.trtc.v20190722.models.DeleteCloudModerationResponse`
|
|
219
|
+
|
|
220
|
+
"""
|
|
221
|
+
try:
|
|
222
|
+
params = request._serialize()
|
|
223
|
+
headers = request.headers
|
|
224
|
+
body = self.call("DeleteCloudModeration", params, headers=headers)
|
|
225
|
+
response = json.loads(body)
|
|
226
|
+
model = models.DeleteCloudModerationResponse()
|
|
227
|
+
model._deserialize(response["Response"])
|
|
228
|
+
return model
|
|
229
|
+
except Exception as e:
|
|
230
|
+
if isinstance(e, TencentCloudSDKException):
|
|
231
|
+
raise
|
|
232
|
+
else:
|
|
233
|
+
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
234
|
+
|
|
235
|
+
|
|
156
236
|
def DeleteCloudRecording(self, request):
|
|
157
|
-
"""成功开启录制后,可以使用此接口来停止录制任务。停止录制成功后不代表文件全部传输完成,如果未完成后台将会继续上传文件,成功后通过事件回调通知客户文件全部传输完成状态。
|
|
237
|
+
r"""成功开启录制后,可以使用此接口来停止录制任务。停止录制成功后不代表文件全部传输完成,如果未完成后台将会继续上传文件,成功后通过事件回调通知客户文件全部传输完成状态。
|
|
158
238
|
|
|
159
239
|
:param request: Request instance for DeleteCloudRecording.
|
|
160
240
|
:type request: :class:`tencentcloud.trtc.v20190722.models.DeleteCloudRecordingRequest`
|
|
@@ -176,8 +256,31 @@ class TrtcClient(AbstractClient):
|
|
|
176
256
|
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
177
257
|
|
|
178
258
|
|
|
259
|
+
def DeleteCloudSliceTask(self, request):
|
|
260
|
+
r"""成功开启切片任务后,可以使用此接口来停止任务。停止切片成功后不代表文件全部传输完成,如果未完成后台将会继续上传文件,成功后通过事件回调通知客户文件全部传输完成状态。
|
|
261
|
+
|
|
262
|
+
:param request: Request instance for DeleteCloudSliceTask.
|
|
263
|
+
:type request: :class:`tencentcloud.trtc.v20190722.models.DeleteCloudSliceTaskRequest`
|
|
264
|
+
:rtype: :class:`tencentcloud.trtc.v20190722.models.DeleteCloudSliceTaskResponse`
|
|
265
|
+
|
|
266
|
+
"""
|
|
267
|
+
try:
|
|
268
|
+
params = request._serialize()
|
|
269
|
+
headers = request.headers
|
|
270
|
+
body = self.call("DeleteCloudSliceTask", params, headers=headers)
|
|
271
|
+
response = json.loads(body)
|
|
272
|
+
model = models.DeleteCloudSliceTaskResponse()
|
|
273
|
+
model._deserialize(response["Response"])
|
|
274
|
+
return model
|
|
275
|
+
except Exception as e:
|
|
276
|
+
if isinstance(e, TencentCloudSDKException):
|
|
277
|
+
raise
|
|
278
|
+
else:
|
|
279
|
+
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
280
|
+
|
|
281
|
+
|
|
179
282
|
def DeletePicture(self, request):
|
|
180
|
-
"""如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁删除自定义背景图或水印,可通过此接口删除已上传的图片。无需频繁删除图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
|
|
283
|
+
r"""如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁删除自定义背景图或水印,可通过此接口删除已上传的图片。无需频繁删除图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
|
|
181
284
|
|
|
182
285
|
:param request: Request instance for DeletePicture.
|
|
183
286
|
:type request: :class:`tencentcloud.trtc.v20190722.models.DeletePictureRequest`
|
|
@@ -199,8 +302,31 @@ class TrtcClient(AbstractClient):
|
|
|
199
302
|
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
200
303
|
|
|
201
304
|
|
|
305
|
+
def DeleteVoicePrint(self, request):
|
|
306
|
+
r"""传入声纹ID,删除之前注册的声纹信息
|
|
307
|
+
|
|
308
|
+
:param request: Request instance for DeleteVoicePrint.
|
|
309
|
+
:type request: :class:`tencentcloud.trtc.v20190722.models.DeleteVoicePrintRequest`
|
|
310
|
+
:rtype: :class:`tencentcloud.trtc.v20190722.models.DeleteVoicePrintResponse`
|
|
311
|
+
|
|
312
|
+
"""
|
|
313
|
+
try:
|
|
314
|
+
params = request._serialize()
|
|
315
|
+
headers = request.headers
|
|
316
|
+
body = self.call("DeleteVoicePrint", params, headers=headers)
|
|
317
|
+
response = json.loads(body)
|
|
318
|
+
model = models.DeleteVoicePrintResponse()
|
|
319
|
+
model._deserialize(response["Response"])
|
|
320
|
+
return model
|
|
321
|
+
except Exception as e:
|
|
322
|
+
if isinstance(e, TencentCloudSDKException):
|
|
323
|
+
raise
|
|
324
|
+
else:
|
|
325
|
+
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
326
|
+
|
|
327
|
+
|
|
202
328
|
def DescribeAIConversation(self, request):
|
|
203
|
-
"""查询AI对话任务状态。
|
|
329
|
+
r"""查询AI对话任务状态。
|
|
204
330
|
|
|
205
331
|
:param request: Request instance for DescribeAIConversation.
|
|
206
332
|
:type request: :class:`tencentcloud.trtc.v20190722.models.DescribeAIConversationRequest`
|
|
@@ -223,7 +349,7 @@ class TrtcClient(AbstractClient):
|
|
|
223
349
|
|
|
224
350
|
|
|
225
351
|
def DescribeAITranscription(self, request):
|
|
226
|
-
"""查询AI转录任务状态。
|
|
352
|
+
r"""查询AI转录任务状态。
|
|
227
353
|
|
|
228
354
|
:param request: Request instance for DescribeAITranscription.
|
|
229
355
|
:type request: :class:`tencentcloud.trtc.v20190722.models.DescribeAITranscriptionRequest`
|
|
@@ -246,7 +372,7 @@ class TrtcClient(AbstractClient):
|
|
|
246
372
|
|
|
247
373
|
|
|
248
374
|
def DescribeCallDetailInfo(self, request):
|
|
249
|
-
"""查询指定时间内的用户列表及用户通话质量数据,最大可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。(同老接口DescribeCallDetail)
|
|
375
|
+
r"""查询指定时间内的用户列表及用户通话质量数据,最大可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。(同老接口DescribeCallDetail)
|
|
250
376
|
**注意**:
|
|
251
377
|
1.该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
|
|
252
378
|
2.该接口自2024年4月1日起正式商业化,需订阅套餐解锁调用能力,提供以下两种解锁方式,可任选其一解锁:
|
|
@@ -273,8 +399,31 @@ class TrtcClient(AbstractClient):
|
|
|
273
399
|
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
274
400
|
|
|
275
401
|
|
|
402
|
+
def DescribeCloudModeration(self, request):
|
|
403
|
+
r"""成功开启审核任务后,可以使用此接口来查询审核任务状态和订阅的黑白名单信息。仅在任务进行时有效,任务退出后查询将会返回错误。
|
|
404
|
+
|
|
405
|
+
:param request: Request instance for DescribeCloudModeration.
|
|
406
|
+
:type request: :class:`tencentcloud.trtc.v20190722.models.DescribeCloudModerationRequest`
|
|
407
|
+
:rtype: :class:`tencentcloud.trtc.v20190722.models.DescribeCloudModerationResponse`
|
|
408
|
+
|
|
409
|
+
"""
|
|
410
|
+
try:
|
|
411
|
+
params = request._serialize()
|
|
412
|
+
headers = request.headers
|
|
413
|
+
body = self.call("DescribeCloudModeration", params, headers=headers)
|
|
414
|
+
response = json.loads(body)
|
|
415
|
+
model = models.DescribeCloudModerationResponse()
|
|
416
|
+
model._deserialize(response["Response"])
|
|
417
|
+
return model
|
|
418
|
+
except Exception as e:
|
|
419
|
+
if isinstance(e, TencentCloudSDKException):
|
|
420
|
+
raise
|
|
421
|
+
else:
|
|
422
|
+
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
423
|
+
|
|
424
|
+
|
|
276
425
|
def DescribeCloudRecording(self, request):
|
|
277
|
-
"""成功开启录制后,可以使用此接口来查询录制状态。仅在录制任务进行时有效,录制退出后查询将会返回错误。
|
|
426
|
+
r"""成功开启录制后,可以使用此接口来查询录制状态。仅在录制任务进行时有效,录制退出后查询将会返回错误。
|
|
278
427
|
录制文件上传到云点播VOD时,StorageFileList中不会返回录制文件信息,请订阅相关录制文件回调事件,获取录制文件信息。
|
|
279
428
|
|
|
280
429
|
:param request: Request instance for DescribeCloudRecording.
|
|
@@ -297,8 +446,31 @@ class TrtcClient(AbstractClient):
|
|
|
297
446
|
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
298
447
|
|
|
299
448
|
|
|
449
|
+
def DescribeCloudSliceTask(self, request):
|
|
450
|
+
r"""成功开启切片后,可以使用此接口来查询切片任务状态。仅在任务进行时有效,任务退出后查询将会返回错误。
|
|
451
|
+
|
|
452
|
+
:param request: Request instance for DescribeCloudSliceTask.
|
|
453
|
+
:type request: :class:`tencentcloud.trtc.v20190722.models.DescribeCloudSliceTaskRequest`
|
|
454
|
+
:rtype: :class:`tencentcloud.trtc.v20190722.models.DescribeCloudSliceTaskResponse`
|
|
455
|
+
|
|
456
|
+
"""
|
|
457
|
+
try:
|
|
458
|
+
params = request._serialize()
|
|
459
|
+
headers = request.headers
|
|
460
|
+
body = self.call("DescribeCloudSliceTask", params, headers=headers)
|
|
461
|
+
response = json.loads(body)
|
|
462
|
+
model = models.DescribeCloudSliceTaskResponse()
|
|
463
|
+
model._deserialize(response["Response"])
|
|
464
|
+
return model
|
|
465
|
+
except Exception as e:
|
|
466
|
+
if isinstance(e, TencentCloudSDKException):
|
|
467
|
+
raise
|
|
468
|
+
else:
|
|
469
|
+
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
470
|
+
|
|
471
|
+
|
|
300
472
|
def DescribeMixTranscodingUsage(self, request):
|
|
301
|
-
"""获取TRTC混流转码的用量明细。
|
|
473
|
+
r"""获取TRTC混流转码的用量明细。
|
|
302
474
|
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
|
|
303
475
|
- 单次查询统计区间最多不能超过31天。
|
|
304
476
|
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
|
|
@@ -326,7 +498,7 @@ class TrtcClient(AbstractClient):
|
|
|
326
498
|
|
|
327
499
|
|
|
328
500
|
def DescribePicture(self, request):
|
|
329
|
-
"""如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁查找自定义背景图或水印信息,可通过此接口查找已上传的图片信息。无需频繁查找图片信息的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中查看。
|
|
501
|
+
r"""如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁查找自定义背景图或水印信息,可通过此接口查找已上传的图片信息。无需频繁查找图片信息的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中查看。
|
|
330
502
|
|
|
331
503
|
:param request: Request instance for DescribePicture.
|
|
332
504
|
:type request: :class:`tencentcloud.trtc.v20190722.models.DescribePictureRequest`
|
|
@@ -349,7 +521,7 @@ class TrtcClient(AbstractClient):
|
|
|
349
521
|
|
|
350
522
|
|
|
351
523
|
def DescribeRecordStatistic(self, request):
|
|
352
|
-
"""查询云端录制计费时长。
|
|
524
|
+
r"""查询云端录制计费时长。
|
|
353
525
|
|
|
354
526
|
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
|
|
355
527
|
- 单次查询统计区间最多不能超过31天。
|
|
@@ -377,7 +549,7 @@ class TrtcClient(AbstractClient):
|
|
|
377
549
|
|
|
378
550
|
|
|
379
551
|
def DescribeRecordingUsage(self, request):
|
|
380
|
-
"""获取TRTC录制的用量明细。
|
|
552
|
+
r"""获取TRTC录制的用量明细。
|
|
381
553
|
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
|
|
382
554
|
- 单次查询统计区间最多不能超过31天。
|
|
383
555
|
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
|
|
@@ -405,7 +577,7 @@ class TrtcClient(AbstractClient):
|
|
|
405
577
|
|
|
406
578
|
|
|
407
579
|
def DescribeRelayUsage(self, request):
|
|
408
|
-
"""获取TRTC旁路转推的用量明细。
|
|
580
|
+
r"""获取TRTC旁路转推的用量明细。
|
|
409
581
|
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
|
|
410
582
|
- 单次查询统计区间最多不能超过31天。
|
|
411
583
|
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
|
|
@@ -433,7 +605,7 @@ class TrtcClient(AbstractClient):
|
|
|
433
605
|
|
|
434
606
|
|
|
435
607
|
def DescribeRoomInfo(self, request):
|
|
436
|
-
"""查询SdkAppId下的房间列表。默认返回10条通话,一次最多返回100条通话。最大可查询14天内的数据。(同老接口DescribeRoomInformation)
|
|
608
|
+
r"""查询SdkAppId下的房间列表。默认返回10条通话,一次最多返回100条通话。最大可查询14天内的数据。(同老接口DescribeRoomInformation)
|
|
437
609
|
**注意**:
|
|
438
610
|
1.该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
|
|
439
611
|
2.该接口自2024年4月1日起正式商业化,需订阅套餐解锁调用能力,提供以下两种解锁方式,可任意其一解锁:
|
|
@@ -461,7 +633,7 @@ class TrtcClient(AbstractClient):
|
|
|
461
633
|
|
|
462
634
|
|
|
463
635
|
def DescribeScaleInfo(self, request):
|
|
464
|
-
"""可查询SdkAppId每天的房间数和用户数,按天统计,可查询最近14天的数据。当天未结束,数据未统计完成,无法查到当天的房间数与用户数。(同老接口DescribeHistoryScale)
|
|
636
|
+
r"""可查询SdkAppId每天的房间数和用户数,按天统计,可查询最近14天的数据。当天未结束,数据未统计完成,无法查到当天的房间数与用户数。(同老接口DescribeHistoryScale)
|
|
465
637
|
|
|
466
638
|
:param request: Request instance for DescribeScaleInfo.
|
|
467
639
|
:type request: :class:`tencentcloud.trtc.v20190722.models.DescribeScaleInfoRequest`
|
|
@@ -484,7 +656,7 @@ class TrtcClient(AbstractClient):
|
|
|
484
656
|
|
|
485
657
|
|
|
486
658
|
def DescribeStreamIngest(self, request):
|
|
487
|
-
"""您可以查询输入在线媒体流任务的状态。
|
|
659
|
+
r"""您可以查询输入在线媒体流任务的状态。
|
|
488
660
|
|
|
489
661
|
:param request: Request instance for DescribeStreamIngest.
|
|
490
662
|
:type request: :class:`tencentcloud.trtc.v20190722.models.DescribeStreamIngestRequest`
|
|
@@ -507,7 +679,7 @@ class TrtcClient(AbstractClient):
|
|
|
507
679
|
|
|
508
680
|
|
|
509
681
|
def DescribeTRTCMarketQualityData(self, request):
|
|
510
|
-
"""查询TRTC监控仪表盘-数据大盘质量指标(包括下列指标)
|
|
682
|
+
r"""查询TRTC监控仪表盘-数据大盘质量指标(包括下列指标)
|
|
511
683
|
joinSuccessRate:加入频道成功率。
|
|
512
684
|
joinSuccessIn5sRate:5s内加入频道成功率。
|
|
513
685
|
audioFreezeRate:音频卡顿率。
|
|
@@ -538,7 +710,9 @@ class TrtcClient(AbstractClient):
|
|
|
538
710
|
|
|
539
711
|
|
|
540
712
|
def DescribeTRTCMarketQualityMetricData(self, request):
|
|
541
|
-
"""
|
|
713
|
+
r"""云监控monitor接口已下线,trtc同步下线接口
|
|
714
|
+
|
|
715
|
+
查询TRTC监控仪表盘-数据大盘质量指标(包括下列指标)
|
|
542
716
|
joinSuccessRate:加入频道成功率。
|
|
543
717
|
joinSuccessIn5sRate:5s内加入频道成功率。
|
|
544
718
|
audioFreezeRate:音频卡顿率。
|
|
@@ -569,7 +743,7 @@ class TrtcClient(AbstractClient):
|
|
|
569
743
|
|
|
570
744
|
|
|
571
745
|
def DescribeTRTCMarketScaleData(self, request):
|
|
572
|
-
"""查询TRTC监控仪表盘-数据大盘规模指标(会返回通话人数,通话房间数,峰值同时在线人数,峰值同时在线频道数)
|
|
746
|
+
r"""查询TRTC监控仪表盘-数据大盘规模指标(会返回通话人数,通话房间数,峰值同时在线人数,峰值同时在线频道数)
|
|
573
747
|
userCount:通话人数,
|
|
574
748
|
roomCount:通话房间数,从有用户加入频道到所有用户离开频道计为一个通话频道。
|
|
575
749
|
peakCurrentChannels:峰值同时在线频道数。
|
|
@@ -599,7 +773,9 @@ class TrtcClient(AbstractClient):
|
|
|
599
773
|
|
|
600
774
|
|
|
601
775
|
def DescribeTRTCMarketScaleMetricData(self, request):
|
|
602
|
-
"""
|
|
776
|
+
r"""云监控monitor接口已下线,trtc同步下线接口
|
|
777
|
+
|
|
778
|
+
查询TRTC监控仪表盘-数据大盘规模指标(会返回通话人数,通话房间数,峰值同时在线人数,峰值同时在线频道数)
|
|
603
779
|
userCount:通话人数,
|
|
604
780
|
roomCount:通话房间数,从有用户加入频道到所有用户离开频道计为一个通话频道。
|
|
605
781
|
peakCurrentChannels:峰值同时在线频道数。
|
|
@@ -629,11 +805,11 @@ class TrtcClient(AbstractClient):
|
|
|
629
805
|
|
|
630
806
|
|
|
631
807
|
def DescribeTRTCRealTimeQualityData(self, request):
|
|
632
|
-
"""查询TRTC监控仪表盘-实时监控质量指标(会返回下列指标)
|
|
808
|
+
r"""查询TRTC监控仪表盘-实时监控质量指标(会返回下列指标)
|
|
633
809
|
-视频卡顿率
|
|
634
810
|
-音频卡顿率
|
|
635
811
|
注意:
|
|
636
|
-
1
|
|
812
|
+
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,详情参考[监控仪表盘](https://cloud.tencent.com/document/product/647/81331)。
|
|
637
813
|
2.查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时。
|
|
638
814
|
|
|
639
815
|
:param request: Request instance for DescribeTRTCRealTimeQualityData.
|
|
@@ -657,7 +833,9 @@ class TrtcClient(AbstractClient):
|
|
|
657
833
|
|
|
658
834
|
|
|
659
835
|
def DescribeTRTCRealTimeQualityMetricData(self, request):
|
|
660
|
-
"""
|
|
836
|
+
r"""云监控monitor接口已下线,trtc同步下线接口
|
|
837
|
+
|
|
838
|
+
查询TRTC监控仪表盘-实时监控质量指标(会返回下列指标)
|
|
661
839
|
-视频卡顿率
|
|
662
840
|
-音频卡顿率
|
|
663
841
|
注意:
|
|
@@ -685,13 +863,12 @@ class TrtcClient(AbstractClient):
|
|
|
685
863
|
|
|
686
864
|
|
|
687
865
|
def DescribeTRTCRealTimeScaleData(self, request):
|
|
688
|
-
"""查询TRTC监控仪表盘-实时监控规模指标(会返回下列指标)
|
|
866
|
+
r"""查询TRTC监控仪表盘-实时监控规模指标(会返回下列指标)
|
|
689
867
|
-userCount(在线用户数)
|
|
690
868
|
-roomCount(在线房间数)
|
|
691
869
|
注意:
|
|
692
|
-
1
|
|
870
|
+
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,详情参考[监控仪表盘](https://cloud.tencent.com/document/product/647/81331)。
|
|
693
871
|
2.查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时。
|
|
694
|
-
3.除此之外您也可以通过[订阅TRTC包月套餐](https://buy.cloud.tencent.com/trtc)尊享版或旗舰版解锁此接口的调用能力,请在开通包月套餐后,请[提交工单](https://console.cloud.tencent.com/workorder/category)联系售后解锁调用能力
|
|
695
872
|
|
|
696
873
|
:param request: Request instance for DescribeTRTCRealTimeScaleData.
|
|
697
874
|
:type request: :class:`tencentcloud.trtc.v20190722.models.DescribeTRTCRealTimeScaleDataRequest`
|
|
@@ -714,7 +891,7 @@ class TrtcClient(AbstractClient):
|
|
|
714
891
|
|
|
715
892
|
|
|
716
893
|
def DescribeTRTCRealTimeScaleMetricData(self, request):
|
|
717
|
-
"""查询TRTC监控仪表盘-实时监控规模指标(会返回下列指标)
|
|
894
|
+
r"""查询TRTC监控仪表盘-实时监控规模指标(会返回下列指标)
|
|
718
895
|
-userCount(在线用户数)
|
|
719
896
|
-roomCount(在线房间数)
|
|
720
897
|
注意:
|
|
@@ -744,7 +921,7 @@ class TrtcClient(AbstractClient):
|
|
|
744
921
|
|
|
745
922
|
|
|
746
923
|
def DescribeTrtcMcuTranscodeTime(self, request):
|
|
747
|
-
"""查询旁路转码计费时长。
|
|
924
|
+
r"""查询旁路转码计费时长。
|
|
748
925
|
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
|
|
749
926
|
- 单次查询统计区间最多不能超过31天。
|
|
750
927
|
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
|
|
@@ -771,7 +948,7 @@ class TrtcClient(AbstractClient):
|
|
|
771
948
|
|
|
772
949
|
|
|
773
950
|
def DescribeTrtcRoomUsage(self, request):
|
|
774
|
-
"""查询TRTC音视频房间维度用量。
|
|
951
|
+
r"""查询TRTC音视频房间维度用量。
|
|
775
952
|
- 单次只能查询一天数据,返回查询时间段内的汇总数据;通过多次查询可以查不同天数据。若查询跨天用量,由于统计延迟等原因,返回数据可能不够准确。
|
|
776
953
|
- 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用,不可用于账单核对,如需对账请使用账号/应用维度用量API:DescribeTrtcUsage。
|
|
777
954
|
- 默认接口请求频率限制:1次/15秒。
|
|
@@ -798,7 +975,7 @@ class TrtcClient(AbstractClient):
|
|
|
798
975
|
|
|
799
976
|
|
|
800
977
|
def DescribeTrtcUsage(self, request):
|
|
801
|
-
"""获取TRTC音视频互动的用量明细,单位:分钟。
|
|
978
|
+
r"""获取TRTC音视频互动的用量明细,单位:分钟。
|
|
802
979
|
- 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
|
|
803
980
|
- 单次查询统计区间最多不能超过31天。
|
|
804
981
|
- 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
|
|
@@ -826,7 +1003,7 @@ class TrtcClient(AbstractClient):
|
|
|
826
1003
|
|
|
827
1004
|
|
|
828
1005
|
def DescribeUnusualEvent(self, request):
|
|
829
|
-
"""查询SdkAppId下任意20条异常体验事件,返回异常体验ID与可能产生异常体验的原因。可查询14天内数据,查询起止时间不超过1个小时。支持跨天查询。(同老接口DescribeAbnormalEvent)
|
|
1006
|
+
r"""查询SdkAppId下任意20条异常体验事件,返回异常体验ID与可能产生异常体验的原因。可查询14天内数据,查询起止时间不超过1个小时。支持跨天查询。(同老接口DescribeAbnormalEvent)
|
|
830
1007
|
异常体验ID映射见:https://cloud.tencent.com/document/product/647/44916
|
|
831
1008
|
|
|
832
1009
|
:param request: Request instance for DescribeUnusualEvent.
|
|
@@ -850,7 +1027,7 @@ class TrtcClient(AbstractClient):
|
|
|
850
1027
|
|
|
851
1028
|
|
|
852
1029
|
def DescribeUserEvent(self, request):
|
|
853
|
-
"""查询用户某次通话内的进退房,视频开关等详细事件。可查询14天内数据。(同接口DescribeDetailEvent)
|
|
1030
|
+
r"""查询用户某次通话内的进退房,视频开关等详细事件。可查询14天内数据。(同接口DescribeDetailEvent)
|
|
854
1031
|
|
|
855
1032
|
:param request: Request instance for DescribeUserEvent.
|
|
856
1033
|
:type request: :class:`tencentcloud.trtc.v20190722.models.DescribeUserEventRequest`
|
|
@@ -873,7 +1050,7 @@ class TrtcClient(AbstractClient):
|
|
|
873
1050
|
|
|
874
1051
|
|
|
875
1052
|
def DescribeUserInfo(self, request):
|
|
876
|
-
"""查询指定时间内的用户列表,最大可查询14天内数据,查询起止时间不超过4小时。默认每页查询6个用户,支持每页最大查询100个用户PageSize不超过100)。(同老接口DescribeUserInformation)
|
|
1053
|
+
r"""查询指定时间内的用户列表,最大可查询14天内数据,查询起止时间不超过4小时。默认每页查询6个用户,支持每页最大查询100个用户PageSize不超过100)。(同老接口DescribeUserInformation)
|
|
877
1054
|
**注意**:
|
|
878
1055
|
1.该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
|
|
879
1056
|
2.该接口自2024年4月1日起正式商业化,需订阅套餐解锁调用能力,提供以下两种解锁方式,可任选其一解锁:
|
|
@@ -900,8 +1077,31 @@ class TrtcClient(AbstractClient):
|
|
|
900
1077
|
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
901
1078
|
|
|
902
1079
|
|
|
1080
|
+
def DescribeVoicePrint(self, request):
|
|
1081
|
+
r"""查询先前注册的声纹信息
|
|
1082
|
+
|
|
1083
|
+
:param request: Request instance for DescribeVoicePrint.
|
|
1084
|
+
:type request: :class:`tencentcloud.trtc.v20190722.models.DescribeVoicePrintRequest`
|
|
1085
|
+
:rtype: :class:`tencentcloud.trtc.v20190722.models.DescribeVoicePrintResponse`
|
|
1086
|
+
|
|
1087
|
+
"""
|
|
1088
|
+
try:
|
|
1089
|
+
params = request._serialize()
|
|
1090
|
+
headers = request.headers
|
|
1091
|
+
body = self.call("DescribeVoicePrint", params, headers=headers)
|
|
1092
|
+
response = json.loads(body)
|
|
1093
|
+
model = models.DescribeVoicePrintResponse()
|
|
1094
|
+
model._deserialize(response["Response"])
|
|
1095
|
+
return model
|
|
1096
|
+
except Exception as e:
|
|
1097
|
+
if isinstance(e, TencentCloudSDKException):
|
|
1098
|
+
raise
|
|
1099
|
+
else:
|
|
1100
|
+
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
1101
|
+
|
|
1102
|
+
|
|
903
1103
|
def DescribeWebRecord(self, request):
|
|
904
|
-
"""查询页面录制任务
|
|
1104
|
+
r"""查询页面录制任务
|
|
905
1105
|
|
|
906
1106
|
:param request: Request instance for DescribeWebRecord.
|
|
907
1107
|
:type request: :class:`tencentcloud.trtc.v20190722.models.DescribeWebRecordRequest`
|
|
@@ -924,7 +1124,7 @@ class TrtcClient(AbstractClient):
|
|
|
924
1124
|
|
|
925
1125
|
|
|
926
1126
|
def DismissRoom(self, request):
|
|
927
|
-
"""接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
|
|
1127
|
+
r"""接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
|
|
928
1128
|
|
|
929
1129
|
:param request: Request instance for DismissRoom.
|
|
930
1130
|
:type request: :class:`tencentcloud.trtc.v20190722.models.DismissRoomRequest`
|
|
@@ -947,7 +1147,7 @@ class TrtcClient(AbstractClient):
|
|
|
947
1147
|
|
|
948
1148
|
|
|
949
1149
|
def DismissRoomByStrRoomId(self, request):
|
|
950
|
-
"""接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
|
|
1150
|
+
r"""接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
|
|
951
1151
|
|
|
952
1152
|
:param request: Request instance for DismissRoomByStrRoomId.
|
|
953
1153
|
:type request: :class:`tencentcloud.trtc.v20190722.models.DismissRoomByStrRoomIdRequest`
|
|
@@ -969,8 +1169,31 @@ class TrtcClient(AbstractClient):
|
|
|
969
1169
|
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
970
1170
|
|
|
971
1171
|
|
|
1172
|
+
def ModifyCloudModeration(self, request):
|
|
1173
|
+
r"""成功开启云端审核任务后,可以使用此接口来更新订阅黑白名单。
|
|
1174
|
+
|
|
1175
|
+
:param request: Request instance for ModifyCloudModeration.
|
|
1176
|
+
:type request: :class:`tencentcloud.trtc.v20190722.models.ModifyCloudModerationRequest`
|
|
1177
|
+
:rtype: :class:`tencentcloud.trtc.v20190722.models.ModifyCloudModerationResponse`
|
|
1178
|
+
|
|
1179
|
+
"""
|
|
1180
|
+
try:
|
|
1181
|
+
params = request._serialize()
|
|
1182
|
+
headers = request.headers
|
|
1183
|
+
body = self.call("ModifyCloudModeration", params, headers=headers)
|
|
1184
|
+
response = json.loads(body)
|
|
1185
|
+
model = models.ModifyCloudModerationResponse()
|
|
1186
|
+
model._deserialize(response["Response"])
|
|
1187
|
+
return model
|
|
1188
|
+
except Exception as e:
|
|
1189
|
+
if isinstance(e, TencentCloudSDKException):
|
|
1190
|
+
raise
|
|
1191
|
+
else:
|
|
1192
|
+
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
1193
|
+
|
|
1194
|
+
|
|
972
1195
|
def ModifyCloudRecording(self, request):
|
|
973
|
-
"""成功开启录制后,可以使用此接口来更新录制任务。仅在录制任务进行时有效,录制退出后更新将会返回错误。更新操作是全量覆盖,并不是增量更新的模式,也就是说每次更新都需要携带全量的信息。
|
|
1196
|
+
r"""成功开启录制后,可以使用此接口来更新录制任务。仅在录制任务进行时有效,录制退出后更新将会返回错误。更新操作是全量覆盖,并不是增量更新的模式,也就是说每次更新都需要携带全量的信息。
|
|
974
1197
|
|
|
975
1198
|
:param request: Request instance for ModifyCloudRecording.
|
|
976
1199
|
:type request: :class:`tencentcloud.trtc.v20190722.models.ModifyCloudRecordingRequest`
|
|
@@ -992,8 +1215,31 @@ class TrtcClient(AbstractClient):
|
|
|
992
1215
|
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
993
1216
|
|
|
994
1217
|
|
|
1218
|
+
def ModifyCloudSliceTask(self, request):
|
|
1219
|
+
r"""成功开启切片任务后,可以使用此接口来更新任务。用于更新指定订阅流白名单或者黑名单。
|
|
1220
|
+
|
|
1221
|
+
:param request: Request instance for ModifyCloudSliceTask.
|
|
1222
|
+
:type request: :class:`tencentcloud.trtc.v20190722.models.ModifyCloudSliceTaskRequest`
|
|
1223
|
+
:rtype: :class:`tencentcloud.trtc.v20190722.models.ModifyCloudSliceTaskResponse`
|
|
1224
|
+
|
|
1225
|
+
"""
|
|
1226
|
+
try:
|
|
1227
|
+
params = request._serialize()
|
|
1228
|
+
headers = request.headers
|
|
1229
|
+
body = self.call("ModifyCloudSliceTask", params, headers=headers)
|
|
1230
|
+
response = json.loads(body)
|
|
1231
|
+
model = models.ModifyCloudSliceTaskResponse()
|
|
1232
|
+
model._deserialize(response["Response"])
|
|
1233
|
+
return model
|
|
1234
|
+
except Exception as e:
|
|
1235
|
+
if isinstance(e, TencentCloudSDKException):
|
|
1236
|
+
raise
|
|
1237
|
+
else:
|
|
1238
|
+
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
1239
|
+
|
|
1240
|
+
|
|
995
1241
|
def ModifyPicture(self, request):
|
|
996
|
-
"""如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁修改自定义背景图或水印素材,可通过此接口修改已上传的图片。无需频繁修改图片素材的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
|
|
1242
|
+
r"""如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁修改自定义背景图或水印素材,可通过此接口修改已上传的图片。无需频繁修改图片素材的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
|
|
997
1243
|
|
|
998
1244
|
:param request: Request instance for ModifyPicture.
|
|
999
1245
|
:type request: :class:`tencentcloud.trtc.v20190722.models.ModifyPictureRequest`
|
|
@@ -1015,8 +1261,31 @@ class TrtcClient(AbstractClient):
|
|
|
1015
1261
|
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
1016
1262
|
|
|
1017
1263
|
|
|
1264
|
+
def RegisterVoicePrint(self, request):
|
|
1265
|
+
r"""传入音频base64串,注册声纹信息,返回声纹ID
|
|
1266
|
+
|
|
1267
|
+
:param request: Request instance for RegisterVoicePrint.
|
|
1268
|
+
:type request: :class:`tencentcloud.trtc.v20190722.models.RegisterVoicePrintRequest`
|
|
1269
|
+
:rtype: :class:`tencentcloud.trtc.v20190722.models.RegisterVoicePrintResponse`
|
|
1270
|
+
|
|
1271
|
+
"""
|
|
1272
|
+
try:
|
|
1273
|
+
params = request._serialize()
|
|
1274
|
+
headers = request.headers
|
|
1275
|
+
body = self.call("RegisterVoicePrint", params, headers=headers)
|
|
1276
|
+
response = json.loads(body)
|
|
1277
|
+
model = models.RegisterVoicePrintResponse()
|
|
1278
|
+
model._deserialize(response["Response"])
|
|
1279
|
+
return model
|
|
1280
|
+
except Exception as e:
|
|
1281
|
+
if isinstance(e, TencentCloudSDKException):
|
|
1282
|
+
raise
|
|
1283
|
+
else:
|
|
1284
|
+
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
1285
|
+
|
|
1286
|
+
|
|
1018
1287
|
def RemoveUser(self, request):
|
|
1019
|
-
"""接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
|
|
1288
|
+
r"""接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
|
|
1020
1289
|
|
|
1021
1290
|
:param request: Request instance for RemoveUser.
|
|
1022
1291
|
:type request: :class:`tencentcloud.trtc.v20190722.models.RemoveUserRequest`
|
|
@@ -1039,7 +1308,7 @@ class TrtcClient(AbstractClient):
|
|
|
1039
1308
|
|
|
1040
1309
|
|
|
1041
1310
|
def RemoveUserByStrRoomId(self, request):
|
|
1042
|
-
"""接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
|
|
1311
|
+
r"""接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
|
|
1043
1312
|
|
|
1044
1313
|
:param request: Request instance for RemoveUserByStrRoomId.
|
|
1045
1314
|
:type request: :class:`tencentcloud.trtc.v20190722.models.RemoveUserByStrRoomIdRequest`
|
|
@@ -1062,7 +1331,7 @@ class TrtcClient(AbstractClient):
|
|
|
1062
1331
|
|
|
1063
1332
|
|
|
1064
1333
|
def StartAIConversation(self, request):
|
|
1065
|
-
"""启动AI对话任务,AI通道机器人进入TRTC房间,与房间内指定的成员进行AI对话,适用于智能客服,AI口语教师等场景
|
|
1334
|
+
r"""启动AI对话任务,AI通道机器人进入TRTC房间,与房间内指定的成员进行AI对话,适用于智能客服,AI口语教师等场景
|
|
1066
1335
|
|
|
1067
1336
|
TRTC AI对话功能内置语音转文本能力,同时提供通道服务,即客户可灵活指定第三方AI模型(LLM)服务和文本转音频(TTS)服务,更多[功能说明](https://cloud.tencent.com/document/product/647/108901)。
|
|
1068
1337
|
|
|
@@ -1087,13 +1356,17 @@ class TrtcClient(AbstractClient):
|
|
|
1087
1356
|
|
|
1088
1357
|
|
|
1089
1358
|
def StartAITranscription(self, request):
|
|
1090
|
-
"""启动转录机器人,后台会通过机器人拉流进行实时进行语音识别并下发字幕和转录消息。
|
|
1359
|
+
r"""启动转录机器人,后台会通过机器人拉流进行实时进行语音识别并下发字幕和转录消息。
|
|
1091
1360
|
转录机器人支持两种拉流方式,通过TranscriptionMode字段控制:
|
|
1092
1361
|
- 拉取全房间的流。
|
|
1093
1362
|
- 拉取特定用户的流。
|
|
1094
1363
|
|
|
1095
1364
|
服务端通过TRTC的自定义消息实时下发字幕以及转录消息,CmdId固定是1。客户端只需监听自定义消息的回调即可,比如[c++回调](https://cloud.tencent.com/document/product/647/79637#4cd82f4edb24992a15a25187089e1565)。其他客户端比如安卓、Web等同样可在该链接处找到。
|
|
1096
1365
|
|
|
1366
|
+
|
|
1367
|
+
**注意:**
|
|
1368
|
+
TranscriptionMode为0时,需要保证一个房间内只发起一个任务,如果发起多个任务,则机器人之间会相互订阅,除非主动停止任务,否则只有10小时后任务才会超时退出,这种情况下建议填写SessionId,保证后续重复发起的任务失败。
|
|
1369
|
+
|
|
1097
1370
|
:param request: Request instance for StartAITranscription.
|
|
1098
1371
|
:type request: :class:`tencentcloud.trtc.v20190722.models.StartAITranscriptionRequest`
|
|
1099
1372
|
:rtype: :class:`tencentcloud.trtc.v20190722.models.StartAITranscriptionResponse`
|
|
@@ -1115,7 +1388,7 @@ class TrtcClient(AbstractClient):
|
|
|
1115
1388
|
|
|
1116
1389
|
|
|
1117
1390
|
def StartMCUMixTranscode(self, request):
|
|
1118
|
-
"""接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
|
|
1391
|
+
r"""接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
|
|
1119
1392
|
|
|
1120
1393
|
TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。房间销毁后混流自动结束。
|
|
1121
1394
|
|
|
@@ -1158,7 +1431,7 @@ class TrtcClient(AbstractClient):
|
|
|
1158
1431
|
|
|
1159
1432
|
|
|
1160
1433
|
def StartMCUMixTranscodeByStrRoomId(self, request):
|
|
1161
|
-
"""接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
|
|
1434
|
+
r"""接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
|
|
1162
1435
|
|
|
1163
1436
|
TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。
|
|
1164
1437
|
|
|
@@ -1201,7 +1474,7 @@ class TrtcClient(AbstractClient):
|
|
|
1201
1474
|
|
|
1202
1475
|
|
|
1203
1476
|
def StartPublishCdnStream(self, request):
|
|
1204
|
-
"""接口说明:
|
|
1477
|
+
r"""接口说明:
|
|
1205
1478
|
启动一个混流转推任务,将 TRTC 房间的多路音视频流混成一路音视频流,编码后推到直播 CDN 或者回推到 TRTC 房间。也支持不转码直接转推 TRTC 房间的单路流。启动成功后,会返回一个 SdkAppid 维度唯一的任务 Id(TaskId)。您需要保存该 TaskId,后续需要依赖此 TaskId 更新和结束任务。可以参考文档: [功能说明](https://cloud.tencent.com/document/product/647/84721#b9a855f4-e38c-4616-9b07-fc44e0e8282a) 和 [常见问题](https://cloud.tencent.com/document/product/647/62620)
|
|
1206
1479
|
|
|
1207
1480
|
注意:
|
|
@@ -1231,7 +1504,7 @@ class TrtcClient(AbstractClient):
|
|
|
1231
1504
|
|
|
1232
1505
|
|
|
1233
1506
|
def StartStreamIngest(self, request):
|
|
1234
|
-
"""将一个在线媒体流推到TRTC房间,更多功能说明见[输入媒体流进房](https://cloud.tencent.com/document/product/647/102957#50940aad-d90f-4473-9f46-d5dd46917653)。
|
|
1507
|
+
r"""将一个在线媒体流推到TRTC房间,更多功能说明见[输入媒体流进房](https://cloud.tencent.com/document/product/647/102957#50940aad-d90f-4473-9f46-d5dd46917653)。
|
|
1235
1508
|
使用输入在线媒体流功能需先订阅 [尊享版或旗舰版套餐包](https://cloud.tencent.com/document/product/647/85386) 解锁能力位。
|
|
1236
1509
|
|
|
1237
1510
|
:param request: Request instance for StartStreamIngest.
|
|
@@ -1255,7 +1528,7 @@ class TrtcClient(AbstractClient):
|
|
|
1255
1528
|
|
|
1256
1529
|
|
|
1257
1530
|
def StartWebRecord(self, request):
|
|
1258
|
-
"""通过此接口可以发起 WEB 页面录制任务,在接口参数中指定录制 URL,录制分辨率,录制结果存储等参数。
|
|
1531
|
+
r"""通过此接口可以发起 WEB 页面录制任务,在接口参数中指定录制 URL,录制分辨率,录制结果存储等参数。
|
|
1259
1532
|
因为参数或API逻辑问题会立即返回结果。而因为页面问题,如页面无法访问,会在回调中返回结果,请关注。
|
|
1260
1533
|
|
|
1261
1534
|
:param request: Request instance for StartWebRecord.
|
|
@@ -1279,7 +1552,7 @@ class TrtcClient(AbstractClient):
|
|
|
1279
1552
|
|
|
1280
1553
|
|
|
1281
1554
|
def StopAIConversation(self, request):
|
|
1282
|
-
"""停止AI对话任务
|
|
1555
|
+
r"""停止AI对话任务
|
|
1283
1556
|
|
|
1284
1557
|
:param request: Request instance for StopAIConversation.
|
|
1285
1558
|
:type request: :class:`tencentcloud.trtc.v20190722.models.StopAIConversationRequest`
|
|
@@ -1302,7 +1575,7 @@ class TrtcClient(AbstractClient):
|
|
|
1302
1575
|
|
|
1303
1576
|
|
|
1304
1577
|
def StopAITranscription(self, request):
|
|
1305
|
-
"""停止AI转录任务。
|
|
1578
|
+
r"""停止AI转录任务。
|
|
1306
1579
|
|
|
1307
1580
|
:param request: Request instance for StopAITranscription.
|
|
1308
1581
|
:type request: :class:`tencentcloud.trtc.v20190722.models.StopAITranscriptionRequest`
|
|
@@ -1325,7 +1598,7 @@ class TrtcClient(AbstractClient):
|
|
|
1325
1598
|
|
|
1326
1599
|
|
|
1327
1600
|
def StopMCUMixTranscode(self, request):
|
|
1328
|
-
"""接口说明:结束云端混流
|
|
1601
|
+
r"""接口说明:结束云端混流
|
|
1329
1602
|
|
|
1330
1603
|
:param request: Request instance for StopMCUMixTranscode.
|
|
1331
1604
|
:type request: :class:`tencentcloud.trtc.v20190722.models.StopMCUMixTranscodeRequest`
|
|
@@ -1348,7 +1621,7 @@ class TrtcClient(AbstractClient):
|
|
|
1348
1621
|
|
|
1349
1622
|
|
|
1350
1623
|
def StopMCUMixTranscodeByStrRoomId(self, request):
|
|
1351
|
-
"""接口说明:结束云端混流
|
|
1624
|
+
r"""接口说明:结束云端混流
|
|
1352
1625
|
|
|
1353
1626
|
:param request: Request instance for StopMCUMixTranscodeByStrRoomId.
|
|
1354
1627
|
:type request: :class:`tencentcloud.trtc.v20190722.models.StopMCUMixTranscodeByStrRoomIdRequest`
|
|
@@ -1371,7 +1644,7 @@ class TrtcClient(AbstractClient):
|
|
|
1371
1644
|
|
|
1372
1645
|
|
|
1373
1646
|
def StopPublishCdnStream(self, request):
|
|
1374
|
-
"""接口说明:
|
|
1647
|
+
r"""接口说明:
|
|
1375
1648
|
停止指定的混流转推任务。如果没有调用 Stop 接口停止任务,所有参与混流转推的主播离开 TRTC 房间超过 AgentParams.MaxIdleTime 设置的时间后,任务也会自动停止。
|
|
1376
1649
|
|
|
1377
1650
|
:param request: Request instance for StopPublishCdnStream.
|
|
@@ -1395,7 +1668,7 @@ class TrtcClient(AbstractClient):
|
|
|
1395
1668
|
|
|
1396
1669
|
|
|
1397
1670
|
def StopStreamIngest(self, request):
|
|
1398
|
-
"""停止一个输入在线媒体流任务。
|
|
1671
|
+
r"""停止一个输入在线媒体流任务。
|
|
1399
1672
|
|
|
1400
1673
|
:param request: Request instance for StopStreamIngest.
|
|
1401
1674
|
:type request: :class:`tencentcloud.trtc.v20190722.models.StopStreamIngestRequest`
|
|
@@ -1418,7 +1691,7 @@ class TrtcClient(AbstractClient):
|
|
|
1418
1691
|
|
|
1419
1692
|
|
|
1420
1693
|
def StopWebRecord(self, request):
|
|
1421
|
-
"""停止页面录制任务
|
|
1694
|
+
r"""停止页面录制任务
|
|
1422
1695
|
|
|
1423
1696
|
:param request: Request instance for StopWebRecord.
|
|
1424
1697
|
:type request: :class:`tencentcloud.trtc.v20190722.models.StopWebRecordRequest`
|
|
@@ -1440,8 +1713,49 @@ class TrtcClient(AbstractClient):
|
|
|
1440
1713
|
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
1441
1714
|
|
|
1442
1715
|
|
|
1716
|
+
def TextToSpeech(self, request):
|
|
1717
|
+
r"""语音合成接口
|
|
1718
|
+
|
|
1719
|
+
:param request: Request instance for TextToSpeech.
|
|
1720
|
+
:type request: :class:`tencentcloud.trtc.v20190722.models.TextToSpeechRequest`
|
|
1721
|
+
:rtype: :class:`tencentcloud.trtc.v20190722.models.TextToSpeechResponse`
|
|
1722
|
+
|
|
1723
|
+
"""
|
|
1724
|
+
try:
|
|
1725
|
+
params = request._serialize()
|
|
1726
|
+
headers = request.headers
|
|
1727
|
+
body = self.call("TextToSpeech", params, headers=headers)
|
|
1728
|
+
response = json.loads(body)
|
|
1729
|
+
model = models.TextToSpeechResponse()
|
|
1730
|
+
model._deserialize(response["Response"])
|
|
1731
|
+
return model
|
|
1732
|
+
except Exception as e:
|
|
1733
|
+
if isinstance(e, TencentCloudSDKException):
|
|
1734
|
+
raise
|
|
1735
|
+
else:
|
|
1736
|
+
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
1737
|
+
|
|
1738
|
+
|
|
1739
|
+
def TextToSpeechSSE(self, request):
|
|
1740
|
+
r"""SSE流式文本转语音
|
|
1741
|
+
|
|
1742
|
+
:param request: Request instance for TextToSpeechSSE.
|
|
1743
|
+
:type request: :class:`tencentcloud.trtc.v20190722.models.TextToSpeechSSERequest`
|
|
1744
|
+
:rtype: :class:`tencentcloud.trtc.v20190722.models.TextToSpeechSSEResponse`
|
|
1745
|
+
|
|
1746
|
+
"""
|
|
1747
|
+
try:
|
|
1748
|
+
params = request._serialize()
|
|
1749
|
+
return self._call_and_deserialize("TextToSpeechSSE", params, models.TextToSpeechSSEResponse, headers=request.headers)
|
|
1750
|
+
except Exception as e:
|
|
1751
|
+
if isinstance(e, TencentCloudSDKException):
|
|
1752
|
+
raise
|
|
1753
|
+
else:
|
|
1754
|
+
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
1755
|
+
|
|
1756
|
+
|
|
1443
1757
|
def UpdateAIConversation(self, request):
|
|
1444
|
-
"""更新AIConversation参数
|
|
1758
|
+
r"""更新AIConversation参数
|
|
1445
1759
|
|
|
1446
1760
|
:param request: Request instance for UpdateAIConversation.
|
|
1447
1761
|
:type request: :class:`tencentcloud.trtc.v20190722.models.UpdateAIConversationRequest`
|
|
@@ -1464,7 +1778,7 @@ class TrtcClient(AbstractClient):
|
|
|
1464
1778
|
|
|
1465
1779
|
|
|
1466
1780
|
def UpdatePublishCdnStream(self, request):
|
|
1467
|
-
"""接口说明:
|
|
1781
|
+
r"""接口说明:
|
|
1468
1782
|
成功发起混流转推后,可以使用此接口来更新任务。仅在任务进行时有效,任务退出后更新将会返回错误。更新操作为增量更新模式。
|
|
1469
1783
|
注意:为了保障推流的稳定性,更新不支持任务在纯音频、音视频、纯视频之间进行切换。
|
|
1470
1784
|
|
|
@@ -1489,7 +1803,7 @@ class TrtcClient(AbstractClient):
|
|
|
1489
1803
|
|
|
1490
1804
|
|
|
1491
1805
|
def UpdateStreamIngest(self, request):
|
|
1492
|
-
"""更新输入在线媒体流任务的StreamUrl
|
|
1806
|
+
r"""更新输入在线媒体流任务的StreamUrl
|
|
1493
1807
|
|
|
1494
1808
|
:param request: Request instance for UpdateStreamIngest.
|
|
1495
1809
|
:type request: :class:`tencentcloud.trtc.v20190722.models.UpdateStreamIngestRequest`
|
|
@@ -1504,6 +1818,52 @@ class TrtcClient(AbstractClient):
|
|
|
1504
1818
|
model = models.UpdateStreamIngestResponse()
|
|
1505
1819
|
model._deserialize(response["Response"])
|
|
1506
1820
|
return model
|
|
1821
|
+
except Exception as e:
|
|
1822
|
+
if isinstance(e, TencentCloudSDKException):
|
|
1823
|
+
raise
|
|
1824
|
+
else:
|
|
1825
|
+
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
1826
|
+
|
|
1827
|
+
|
|
1828
|
+
def UpdateVoicePrint(self, request):
|
|
1829
|
+
r"""传入声纹ID以及对应音频信息,更新对应声纹信息
|
|
1830
|
+
|
|
1831
|
+
:param request: Request instance for UpdateVoicePrint.
|
|
1832
|
+
:type request: :class:`tencentcloud.trtc.v20190722.models.UpdateVoicePrintRequest`
|
|
1833
|
+
:rtype: :class:`tencentcloud.trtc.v20190722.models.UpdateVoicePrintResponse`
|
|
1834
|
+
|
|
1835
|
+
"""
|
|
1836
|
+
try:
|
|
1837
|
+
params = request._serialize()
|
|
1838
|
+
headers = request.headers
|
|
1839
|
+
body = self.call("UpdateVoicePrint", params, headers=headers)
|
|
1840
|
+
response = json.loads(body)
|
|
1841
|
+
model = models.UpdateVoicePrintResponse()
|
|
1842
|
+
model._deserialize(response["Response"])
|
|
1843
|
+
return model
|
|
1844
|
+
except Exception as e:
|
|
1845
|
+
if isinstance(e, TencentCloudSDKException):
|
|
1846
|
+
raise
|
|
1847
|
+
else:
|
|
1848
|
+
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
1849
|
+
|
|
1850
|
+
|
|
1851
|
+
def VoiceClone(self, request):
|
|
1852
|
+
r"""声音克隆
|
|
1853
|
+
|
|
1854
|
+
:param request: Request instance for VoiceClone.
|
|
1855
|
+
:type request: :class:`tencentcloud.trtc.v20190722.models.VoiceCloneRequest`
|
|
1856
|
+
:rtype: :class:`tencentcloud.trtc.v20190722.models.VoiceCloneResponse`
|
|
1857
|
+
|
|
1858
|
+
"""
|
|
1859
|
+
try:
|
|
1860
|
+
params = request._serialize()
|
|
1861
|
+
headers = request.headers
|
|
1862
|
+
body = self.call("VoiceClone", params, headers=headers)
|
|
1863
|
+
response = json.loads(body)
|
|
1864
|
+
model = models.VoiceCloneResponse()
|
|
1865
|
+
model._deserialize(response["Response"])
|
|
1866
|
+
return model
|
|
1507
1867
|
except Exception as e:
|
|
1508
1868
|
if isinstance(e, TencentCloudSDKException):
|
|
1509
1869
|
raise
|