tencentcloud-sdk-python-trtc 3.0.1456__py2.py3-none-any.whl → 3.0.1459__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.

Potentially problematic release.


This version of tencentcloud-sdk-python-trtc might be problematic. Click here for more details.

@@ -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.
@@ -74,7 +74,7 @@ class TrtcClient(AbstractClient):
74
74
 
75
75
 
76
76
  def CreateCloudModeration(self, request):
77
- """接口说明:
77
+ r"""接口说明:
78
78
  启动云端审核功能,完成房间内的音视频切片,视频截帧,或者录制音频流,送审到指定的审核商,完成审核。
79
79
 
80
80
  您可以通过此接口实现如下目标:
@@ -102,7 +102,7 @@ class TrtcClient(AbstractClient):
102
102
 
103
103
 
104
104
  def CreateCloudRecording(self, request):
105
- """接口说明:
105
+ r"""接口说明:
106
106
  启动云端录制功能,完成房间内的音视频录制,并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制又或者多路视频画面合流混成一路。
107
107
 
108
108
  您可以通过此接口实现如下目标:
@@ -136,7 +136,7 @@ class TrtcClient(AbstractClient):
136
136
 
137
137
 
138
138
  def CreateCloudSliceTask(self, request):
139
- """接口说明:
139
+ r"""接口说明:
140
140
  启动云端切片功能,完成房间内的音视频切片,并上传到指定的云存储。
141
141
 
142
142
  您可以通过此接口实现如下目标:
@@ -164,7 +164,7 @@ class TrtcClient(AbstractClient):
164
164
 
165
165
 
166
166
  def CreatePicture(self, request):
167
- """如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁新增自定义背景图或水印,可通过此接口上传新的图片素材。无需频繁新增图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
167
+ r"""如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁新增自定义背景图或水印,可通过此接口上传新的图片素材。无需频繁新增图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
168
168
 
169
169
  :param request: Request instance for CreatePicture.
170
170
  :type request: :class:`tencentcloud.trtc.v20190722.models.CreatePictureRequest`
@@ -187,7 +187,7 @@ class TrtcClient(AbstractClient):
187
187
 
188
188
 
189
189
  def DeleteBasicModeration(self, request):
190
- """成功开启审核任务后,可以使用此接口来停止任务。
190
+ r"""成功开启审核任务后,可以使用此接口来停止任务。
191
191
 
192
192
  :param request: Request instance for DeleteBasicModeration.
193
193
  :type request: :class:`tencentcloud.trtc.v20190722.models.DeleteBasicModerationRequest`
@@ -210,7 +210,7 @@ class TrtcClient(AbstractClient):
210
210
 
211
211
 
212
212
  def DeleteCloudModeration(self, request):
213
- """成功开启云端审核任务后,可以使用此接口来停止送审。
213
+ r"""成功开启云端审核任务后,可以使用此接口来停止送审。
214
214
 
215
215
  :param request: Request instance for DeleteCloudModeration.
216
216
  :type request: :class:`tencentcloud.trtc.v20190722.models.DeleteCloudModerationRequest`
@@ -233,7 +233,7 @@ class TrtcClient(AbstractClient):
233
233
 
234
234
 
235
235
  def DeleteCloudRecording(self, request):
236
- """成功开启录制后,可以使用此接口来停止录制任务。停止录制成功后不代表文件全部传输完成,如果未完成后台将会继续上传文件,成功后通过事件回调通知客户文件全部传输完成状态。
236
+ r"""成功开启录制后,可以使用此接口来停止录制任务。停止录制成功后不代表文件全部传输完成,如果未完成后台将会继续上传文件,成功后通过事件回调通知客户文件全部传输完成状态。
237
237
 
238
238
  :param request: Request instance for DeleteCloudRecording.
239
239
  :type request: :class:`tencentcloud.trtc.v20190722.models.DeleteCloudRecordingRequest`
@@ -256,7 +256,7 @@ class TrtcClient(AbstractClient):
256
256
 
257
257
 
258
258
  def DeleteCloudSliceTask(self, request):
259
- """成功开启切片任务后,可以使用此接口来停止任务。停止切片成功后不代表文件全部传输完成,如果未完成后台将会继续上传文件,成功后通过事件回调通知客户文件全部传输完成状态。
259
+ r"""成功开启切片任务后,可以使用此接口来停止任务。停止切片成功后不代表文件全部传输完成,如果未完成后台将会继续上传文件,成功后通过事件回调通知客户文件全部传输完成状态。
260
260
 
261
261
  :param request: Request instance for DeleteCloudSliceTask.
262
262
  :type request: :class:`tencentcloud.trtc.v20190722.models.DeleteCloudSliceTaskRequest`
@@ -279,7 +279,7 @@ class TrtcClient(AbstractClient):
279
279
 
280
280
 
281
281
  def DeletePicture(self, request):
282
- """如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁删除自定义背景图或水印,可通过此接口删除已上传的图片。无需频繁删除图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
282
+ r"""如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁删除自定义背景图或水印,可通过此接口删除已上传的图片。无需频繁删除图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
283
283
 
284
284
  :param request: Request instance for DeletePicture.
285
285
  :type request: :class:`tencentcloud.trtc.v20190722.models.DeletePictureRequest`
@@ -302,7 +302,7 @@ class TrtcClient(AbstractClient):
302
302
 
303
303
 
304
304
  def DeleteVoicePrint(self, request):
305
- """传入声纹ID,删除之前注册的声纹信息
305
+ r"""传入声纹ID,删除之前注册的声纹信息
306
306
 
307
307
  :param request: Request instance for DeleteVoicePrint.
308
308
  :type request: :class:`tencentcloud.trtc.v20190722.models.DeleteVoicePrintRequest`
@@ -325,7 +325,7 @@ class TrtcClient(AbstractClient):
325
325
 
326
326
 
327
327
  def DescribeAIConversation(self, request):
328
- """查询AI对话任务状态。
328
+ r"""查询AI对话任务状态。
329
329
 
330
330
  :param request: Request instance for DescribeAIConversation.
331
331
  :type request: :class:`tencentcloud.trtc.v20190722.models.DescribeAIConversationRequest`
@@ -348,7 +348,7 @@ class TrtcClient(AbstractClient):
348
348
 
349
349
 
350
350
  def DescribeAITranscription(self, request):
351
- """查询AI转录任务状态。
351
+ r"""查询AI转录任务状态。
352
352
 
353
353
  :param request: Request instance for DescribeAITranscription.
354
354
  :type request: :class:`tencentcloud.trtc.v20190722.models.DescribeAITranscriptionRequest`
@@ -371,7 +371,7 @@ class TrtcClient(AbstractClient):
371
371
 
372
372
 
373
373
  def DescribeCallDetailInfo(self, request):
374
- """查询指定时间内的用户列表及用户通话质量数据,最大可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。(同老接口DescribeCallDetail)
374
+ r"""查询指定时间内的用户列表及用户通话质量数据,最大可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。(同老接口DescribeCallDetail)
375
375
  **注意**:
376
376
  1.该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
377
377
  2.该接口自2024年4月1日起正式商业化,需订阅套餐解锁调用能力,提供以下两种解锁方式,可任选其一解锁:
@@ -399,7 +399,7 @@ class TrtcClient(AbstractClient):
399
399
 
400
400
 
401
401
  def DescribeCloudModeration(self, request):
402
- """成功开启审核任务后,可以使用此接口来查询审核任务状态和订阅的黑白名单信息。仅在任务进行时有效,任务退出后查询将会返回错误。
402
+ r"""成功开启审核任务后,可以使用此接口来查询审核任务状态和订阅的黑白名单信息。仅在任务进行时有效,任务退出后查询将会返回错误。
403
403
 
404
404
  :param request: Request instance for DescribeCloudModeration.
405
405
  :type request: :class:`tencentcloud.trtc.v20190722.models.DescribeCloudModerationRequest`
@@ -422,7 +422,7 @@ class TrtcClient(AbstractClient):
422
422
 
423
423
 
424
424
  def DescribeCloudRecording(self, request):
425
- """成功开启录制后,可以使用此接口来查询录制状态。仅在录制任务进行时有效,录制退出后查询将会返回错误。
425
+ r"""成功开启录制后,可以使用此接口来查询录制状态。仅在录制任务进行时有效,录制退出后查询将会返回错误。
426
426
  录制文件上传到云点播VOD时,StorageFileList中不会返回录制文件信息,请订阅相关录制文件回调事件,获取录制文件信息。
427
427
 
428
428
  :param request: Request instance for DescribeCloudRecording.
@@ -446,7 +446,7 @@ class TrtcClient(AbstractClient):
446
446
 
447
447
 
448
448
  def DescribeCloudSliceTask(self, request):
449
- """成功开启切片后,可以使用此接口来查询切片任务状态。仅在任务进行时有效,任务退出后查询将会返回错误。
449
+ r"""成功开启切片后,可以使用此接口来查询切片任务状态。仅在任务进行时有效,任务退出后查询将会返回错误。
450
450
 
451
451
  :param request: Request instance for DescribeCloudSliceTask.
452
452
  :type request: :class:`tencentcloud.trtc.v20190722.models.DescribeCloudSliceTaskRequest`
@@ -469,7 +469,7 @@ class TrtcClient(AbstractClient):
469
469
 
470
470
 
471
471
  def DescribeMixTranscodingUsage(self, request):
472
- """获取TRTC混流转码的用量明细。
472
+ r"""获取TRTC混流转码的用量明细。
473
473
  - 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
474
474
  - 单次查询统计区间最多不能超过31天。
475
475
  - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
@@ -497,7 +497,7 @@ class TrtcClient(AbstractClient):
497
497
 
498
498
 
499
499
  def DescribePicture(self, request):
500
- """如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁查找自定义背景图或水印信息,可通过此接口查找已上传的图片信息。无需频繁查找图片信息的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中查看。
500
+ r"""如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁查找自定义背景图或水印信息,可通过此接口查找已上传的图片信息。无需频繁查找图片信息的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中查看。
501
501
 
502
502
  :param request: Request instance for DescribePicture.
503
503
  :type request: :class:`tencentcloud.trtc.v20190722.models.DescribePictureRequest`
@@ -520,7 +520,7 @@ class TrtcClient(AbstractClient):
520
520
 
521
521
 
522
522
  def DescribeRecordStatistic(self, request):
523
- """查询云端录制计费时长。
523
+ r"""查询云端录制计费时长。
524
524
 
525
525
  - 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
526
526
  - 单次查询统计区间最多不能超过31天。
@@ -548,7 +548,7 @@ class TrtcClient(AbstractClient):
548
548
 
549
549
 
550
550
  def DescribeRecordingUsage(self, request):
551
- """获取TRTC录制的用量明细。
551
+ r"""获取TRTC录制的用量明细。
552
552
  - 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
553
553
  - 单次查询统计区间最多不能超过31天。
554
554
  - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
@@ -576,7 +576,7 @@ class TrtcClient(AbstractClient):
576
576
 
577
577
 
578
578
  def DescribeRelayUsage(self, request):
579
- """获取TRTC旁路转推的用量明细。
579
+ r"""获取TRTC旁路转推的用量明细。
580
580
  - 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
581
581
  - 单次查询统计区间最多不能超过31天。
582
582
  - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
@@ -604,7 +604,7 @@ class TrtcClient(AbstractClient):
604
604
 
605
605
 
606
606
  def DescribeRoomInfo(self, request):
607
- """查询SdkAppId下的房间列表。默认返回10条通话,一次最多返回100条通话。最大可查询14天内的数据。(同老接口DescribeRoomInformation)
607
+ r"""查询SdkAppId下的房间列表。默认返回10条通话,一次最多返回100条通话。最大可查询14天内的数据。(同老接口DescribeRoomInformation)
608
608
  **注意**:
609
609
  1.该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
610
610
  2.该接口自2024年4月1日起正式商业化,需订阅套餐解锁调用能力,提供以下两种解锁方式,可任意其一解锁:
@@ -632,7 +632,7 @@ class TrtcClient(AbstractClient):
632
632
 
633
633
 
634
634
  def DescribeScaleInfo(self, request):
635
- """可查询SdkAppId每天的房间数和用户数,按天统计,可查询最近14天的数据。当天未结束,数据未统计完成,无法查到当天的房间数与用户数。(同老接口DescribeHistoryScale)
635
+ r"""可查询SdkAppId每天的房间数和用户数,按天统计,可查询最近14天的数据。当天未结束,数据未统计完成,无法查到当天的房间数与用户数。(同老接口DescribeHistoryScale)
636
636
 
637
637
  :param request: Request instance for DescribeScaleInfo.
638
638
  :type request: :class:`tencentcloud.trtc.v20190722.models.DescribeScaleInfoRequest`
@@ -655,7 +655,7 @@ class TrtcClient(AbstractClient):
655
655
 
656
656
 
657
657
  def DescribeStreamIngest(self, request):
658
- """您可以查询输入在线媒体流任务的状态。
658
+ r"""您可以查询输入在线媒体流任务的状态。
659
659
 
660
660
  :param request: Request instance for DescribeStreamIngest.
661
661
  :type request: :class:`tencentcloud.trtc.v20190722.models.DescribeStreamIngestRequest`
@@ -678,7 +678,7 @@ class TrtcClient(AbstractClient):
678
678
 
679
679
 
680
680
  def DescribeTRTCMarketQualityData(self, request):
681
- """查询TRTC监控仪表盘-数据大盘质量指标(包括下列指标)
681
+ r"""查询TRTC监控仪表盘-数据大盘质量指标(包括下列指标)
682
682
  joinSuccessRate:加入频道成功率。
683
683
  joinSuccessIn5sRate:5s内加入频道成功率。
684
684
  audioFreezeRate:音频卡顿率。
@@ -709,7 +709,7 @@ class TrtcClient(AbstractClient):
709
709
 
710
710
 
711
711
  def DescribeTRTCMarketQualityMetricData(self, request):
712
- """云监控monitor接口已下线,trtc同步下线接口
712
+ r"""云监控monitor接口已下线,trtc同步下线接口
713
713
 
714
714
  查询TRTC监控仪表盘-数据大盘质量指标(包括下列指标)
715
715
  joinSuccessRate:加入频道成功率。
@@ -742,7 +742,7 @@ class TrtcClient(AbstractClient):
742
742
 
743
743
 
744
744
  def DescribeTRTCMarketScaleData(self, request):
745
- """查询TRTC监控仪表盘-数据大盘规模指标(会返回通话人数,通话房间数,峰值同时在线人数,峰值同时在线频道数)
745
+ r"""查询TRTC监控仪表盘-数据大盘规模指标(会返回通话人数,通话房间数,峰值同时在线人数,峰值同时在线频道数)
746
746
  userCount:通话人数,
747
747
  roomCount:通话房间数,从有用户加入频道到所有用户离开频道计为一个通话频道。
748
748
  peakCurrentChannels:峰值同时在线频道数。
@@ -772,7 +772,7 @@ class TrtcClient(AbstractClient):
772
772
 
773
773
 
774
774
  def DescribeTRTCMarketScaleMetricData(self, request):
775
- """云监控monitor接口已下线,trtc同步下线接口
775
+ r"""云监控monitor接口已下线,trtc同步下线接口
776
776
 
777
777
  查询TRTC监控仪表盘-数据大盘规模指标(会返回通话人数,通话房间数,峰值同时在线人数,峰值同时在线频道数)
778
778
  userCount:通话人数,
@@ -804,7 +804,7 @@ class TrtcClient(AbstractClient):
804
804
 
805
805
 
806
806
  def DescribeTRTCRealTimeQualityData(self, request):
807
- """查询TRTC监控仪表盘-实时监控质量指标(会返回下列指标)
807
+ r"""查询TRTC监控仪表盘-实时监控质量指标(会返回下列指标)
808
808
  -视频卡顿率
809
809
  -音频卡顿率
810
810
  注意:
@@ -832,7 +832,7 @@ class TrtcClient(AbstractClient):
832
832
 
833
833
 
834
834
  def DescribeTRTCRealTimeQualityMetricData(self, request):
835
- """云监控monitor接口已下线,trtc同步下线接口
835
+ r"""云监控monitor接口已下线,trtc同步下线接口
836
836
 
837
837
  查询TRTC监控仪表盘-实时监控质量指标(会返回下列指标)
838
838
  -视频卡顿率
@@ -862,7 +862,7 @@ class TrtcClient(AbstractClient):
862
862
 
863
863
 
864
864
  def DescribeTRTCRealTimeScaleData(self, request):
865
- """查询TRTC监控仪表盘-实时监控规模指标(会返回下列指标)
865
+ r"""查询TRTC监控仪表盘-实时监控规模指标(会返回下列指标)
866
866
  -userCount(在线用户数)
867
867
  -roomCount(在线房间数)
868
868
  注意:
@@ -890,7 +890,7 @@ class TrtcClient(AbstractClient):
890
890
 
891
891
 
892
892
  def DescribeTRTCRealTimeScaleMetricData(self, request):
893
- """查询TRTC监控仪表盘-实时监控规模指标(会返回下列指标)
893
+ r"""查询TRTC监控仪表盘-实时监控规模指标(会返回下列指标)
894
894
  -userCount(在线用户数)
895
895
  -roomCount(在线房间数)
896
896
  注意:
@@ -920,7 +920,7 @@ class TrtcClient(AbstractClient):
920
920
 
921
921
 
922
922
  def DescribeTrtcMcuTranscodeTime(self, request):
923
- """查询旁路转码计费时长。
923
+ r"""查询旁路转码计费时长。
924
924
  - 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
925
925
  - 单次查询统计区间最多不能超过31天。
926
926
  - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
@@ -947,7 +947,7 @@ class TrtcClient(AbstractClient):
947
947
 
948
948
 
949
949
  def DescribeTrtcRoomUsage(self, request):
950
- """查询TRTC音视频房间维度用量。
950
+ r"""查询TRTC音视频房间维度用量。
951
951
  - 单次只能查询一天数据,返回查询时间段内的汇总数据;通过多次查询可以查不同天数据。若查询跨天用量,由于统计延迟等原因,返回数据可能不够准确。
952
952
  - 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用,不可用于账单核对,如需对账请使用账号/应用维度用量API:DescribeTrtcUsage。
953
953
  - 默认接口请求频率限制:1次/15秒。
@@ -974,7 +974,7 @@ class TrtcClient(AbstractClient):
974
974
 
975
975
 
976
976
  def DescribeTrtcUsage(self, request):
977
- """获取TRTC音视频互动的用量明细,单位:分钟。
977
+ r"""获取TRTC音视频互动的用量明细,单位:分钟。
978
978
  - 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
979
979
  - 单次查询统计区间最多不能超过31天。
980
980
  - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。
@@ -1002,7 +1002,7 @@ class TrtcClient(AbstractClient):
1002
1002
 
1003
1003
 
1004
1004
  def DescribeUnusualEvent(self, request):
1005
- """查询SdkAppId下任意20条异常体验事件,返回异常体验ID与可能产生异常体验的原因。可查询14天内数据,查询起止时间不超过1个小时。支持跨天查询。(同老接口DescribeAbnormalEvent)
1005
+ r"""查询SdkAppId下任意20条异常体验事件,返回异常体验ID与可能产生异常体验的原因。可查询14天内数据,查询起止时间不超过1个小时。支持跨天查询。(同老接口DescribeAbnormalEvent)
1006
1006
  异常体验ID映射见:https://cloud.tencent.com/document/product/647/44916
1007
1007
 
1008
1008
  :param request: Request instance for DescribeUnusualEvent.
@@ -1026,7 +1026,7 @@ class TrtcClient(AbstractClient):
1026
1026
 
1027
1027
 
1028
1028
  def DescribeUserEvent(self, request):
1029
- """查询用户某次通话内的进退房,视频开关等详细事件。可查询14天内数据。(同接口DescribeDetailEvent)
1029
+ r"""查询用户某次通话内的进退房,视频开关等详细事件。可查询14天内数据。(同接口DescribeDetailEvent)
1030
1030
 
1031
1031
  :param request: Request instance for DescribeUserEvent.
1032
1032
  :type request: :class:`tencentcloud.trtc.v20190722.models.DescribeUserEventRequest`
@@ -1049,7 +1049,7 @@ class TrtcClient(AbstractClient):
1049
1049
 
1050
1050
 
1051
1051
  def DescribeUserInfo(self, request):
1052
- """查询指定时间内的用户列表,最大可查询14天内数据,查询起止时间不超过4小时。默认每页查询6个用户,支持每页最大查询100个用户PageSize不超过100)。(同老接口DescribeUserInformation)
1052
+ r"""查询指定时间内的用户列表,最大可查询14天内数据,查询起止时间不超过4小时。默认每页查询6个用户,支持每页最大查询100个用户PageSize不超过100)。(同老接口DescribeUserInformation)
1053
1053
  **注意**:
1054
1054
  1.该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
1055
1055
  2.该接口自2024年4月1日起正式商业化,需订阅套餐解锁调用能力,提供以下两种解锁方式,可任选其一解锁:
@@ -1077,7 +1077,7 @@ class TrtcClient(AbstractClient):
1077
1077
 
1078
1078
 
1079
1079
  def DescribeVoicePrint(self, request):
1080
- """查询先前注册的声纹信息
1080
+ r"""查询先前注册的声纹信息
1081
1081
 
1082
1082
  :param request: Request instance for DescribeVoicePrint.
1083
1083
  :type request: :class:`tencentcloud.trtc.v20190722.models.DescribeVoicePrintRequest`
@@ -1100,7 +1100,7 @@ class TrtcClient(AbstractClient):
1100
1100
 
1101
1101
 
1102
1102
  def DescribeWebRecord(self, request):
1103
- """查询页面录制任务
1103
+ r"""查询页面录制任务
1104
1104
 
1105
1105
  :param request: Request instance for DescribeWebRecord.
1106
1106
  :type request: :class:`tencentcloud.trtc.v20190722.models.DescribeWebRecordRequest`
@@ -1123,7 +1123,7 @@ class TrtcClient(AbstractClient):
1123
1123
 
1124
1124
 
1125
1125
  def DismissRoom(self, request):
1126
- """接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
1126
+ r"""接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
1127
1127
 
1128
1128
  :param request: Request instance for DismissRoom.
1129
1129
  :type request: :class:`tencentcloud.trtc.v20190722.models.DismissRoomRequest`
@@ -1146,7 +1146,7 @@ class TrtcClient(AbstractClient):
1146
1146
 
1147
1147
 
1148
1148
  def DismissRoomByStrRoomId(self, request):
1149
- """接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
1149
+ r"""接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
1150
1150
 
1151
1151
  :param request: Request instance for DismissRoomByStrRoomId.
1152
1152
  :type request: :class:`tencentcloud.trtc.v20190722.models.DismissRoomByStrRoomIdRequest`
@@ -1169,7 +1169,7 @@ class TrtcClient(AbstractClient):
1169
1169
 
1170
1170
 
1171
1171
  def ModifyCloudModeration(self, request):
1172
- """成功开启云端审核任务后,可以使用此接口来更新订阅黑白名单。
1172
+ r"""成功开启云端审核任务后,可以使用此接口来更新订阅黑白名单。
1173
1173
 
1174
1174
  :param request: Request instance for ModifyCloudModeration.
1175
1175
  :type request: :class:`tencentcloud.trtc.v20190722.models.ModifyCloudModerationRequest`
@@ -1192,7 +1192,7 @@ class TrtcClient(AbstractClient):
1192
1192
 
1193
1193
 
1194
1194
  def ModifyCloudRecording(self, request):
1195
- """成功开启录制后,可以使用此接口来更新录制任务。仅在录制任务进行时有效,录制退出后更新将会返回错误。更新操作是全量覆盖,并不是增量更新的模式,也就是说每次更新都需要携带全量的信息。
1195
+ r"""成功开启录制后,可以使用此接口来更新录制任务。仅在录制任务进行时有效,录制退出后更新将会返回错误。更新操作是全量覆盖,并不是增量更新的模式,也就是说每次更新都需要携带全量的信息。
1196
1196
 
1197
1197
  :param request: Request instance for ModifyCloudRecording.
1198
1198
  :type request: :class:`tencentcloud.trtc.v20190722.models.ModifyCloudRecordingRequest`
@@ -1215,7 +1215,7 @@ class TrtcClient(AbstractClient):
1215
1215
 
1216
1216
 
1217
1217
  def ModifyCloudSliceTask(self, request):
1218
- """成功开启切片任务后,可以使用此接口来更新任务。用于更新指定订阅流白名单或者黑名单。
1218
+ r"""成功开启切片任务后,可以使用此接口来更新任务。用于更新指定订阅流白名单或者黑名单。
1219
1219
 
1220
1220
  :param request: Request instance for ModifyCloudSliceTask.
1221
1221
  :type request: :class:`tencentcloud.trtc.v20190722.models.ModifyCloudSliceTaskRequest`
@@ -1238,7 +1238,7 @@ class TrtcClient(AbstractClient):
1238
1238
 
1239
1239
 
1240
1240
  def ModifyPicture(self, request):
1241
- """如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁修改自定义背景图或水印素材,可通过此接口修改已上传的图片。无需频繁修改图片素材的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
1241
+ r"""如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁修改自定义背景图或水印素材,可通过此接口修改已上传的图片。无需频繁修改图片素材的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。
1242
1242
 
1243
1243
  :param request: Request instance for ModifyPicture.
1244
1244
  :type request: :class:`tencentcloud.trtc.v20190722.models.ModifyPictureRequest`
@@ -1261,7 +1261,7 @@ class TrtcClient(AbstractClient):
1261
1261
 
1262
1262
 
1263
1263
  def RegisterVoicePrint(self, request):
1264
- """传入音频base64串,注册声纹信息,返回声纹ID
1264
+ r"""传入音频base64串,注册声纹信息,返回声纹ID
1265
1265
 
1266
1266
  :param request: Request instance for RegisterVoicePrint.
1267
1267
  :type request: :class:`tencentcloud.trtc.v20190722.models.RegisterVoicePrintRequest`
@@ -1284,7 +1284,7 @@ class TrtcClient(AbstractClient):
1284
1284
 
1285
1285
 
1286
1286
  def RemoveUser(self, request):
1287
- """接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
1287
+ r"""接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
1288
1288
 
1289
1289
  :param request: Request instance for RemoveUser.
1290
1290
  :type request: :class:`tencentcloud.trtc.v20190722.models.RemoveUserRequest`
@@ -1307,7 +1307,7 @@ class TrtcClient(AbstractClient):
1307
1307
 
1308
1308
 
1309
1309
  def RemoveUserByStrRoomId(self, request):
1310
- """接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
1310
+ r"""接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
1311
1311
 
1312
1312
  :param request: Request instance for RemoveUserByStrRoomId.
1313
1313
  :type request: :class:`tencentcloud.trtc.v20190722.models.RemoveUserByStrRoomIdRequest`
@@ -1330,7 +1330,7 @@ class TrtcClient(AbstractClient):
1330
1330
 
1331
1331
 
1332
1332
  def StartAIConversation(self, request):
1333
- """启动AI对话任务,AI通道机器人进入TRTC房间,与房间内指定的成员进行AI对话,适用于智能客服,AI口语教师等场景
1333
+ r"""启动AI对话任务,AI通道机器人进入TRTC房间,与房间内指定的成员进行AI对话,适用于智能客服,AI口语教师等场景
1334
1334
 
1335
1335
  TRTC AI对话功能内置语音转文本能力,同时提供通道服务,即客户可灵活指定第三方AI模型(LLM)服务和文本转音频(TTS)服务,更多[功能说明](https://cloud.tencent.com/document/product/647/108901)。
1336
1336
 
@@ -1355,7 +1355,7 @@ class TrtcClient(AbstractClient):
1355
1355
 
1356
1356
 
1357
1357
  def StartAITranscription(self, request):
1358
- """启动转录机器人,后台会通过机器人拉流进行实时进行语音识别并下发字幕和转录消息。
1358
+ r"""启动转录机器人,后台会通过机器人拉流进行实时进行语音识别并下发字幕和转录消息。
1359
1359
  转录机器人支持两种拉流方式,通过TranscriptionMode字段控制:
1360
1360
  - 拉取全房间的流。
1361
1361
  - 拉取特定用户的流。
@@ -1387,7 +1387,7 @@ class TrtcClient(AbstractClient):
1387
1387
 
1388
1388
 
1389
1389
  def StartMCUMixTranscode(self, request):
1390
- """接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
1390
+ r"""接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
1391
1391
 
1392
1392
  TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。房间销毁后混流自动结束。
1393
1393
 
@@ -1430,7 +1430,7 @@ class TrtcClient(AbstractClient):
1430
1430
 
1431
1431
 
1432
1432
  def StartMCUMixTranscodeByStrRoomId(self, request):
1433
- """接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
1433
+ r"""接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。
1434
1434
 
1435
1435
  TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。
1436
1436
 
@@ -1473,7 +1473,7 @@ class TrtcClient(AbstractClient):
1473
1473
 
1474
1474
 
1475
1475
  def StartPublishCdnStream(self, request):
1476
- """接口说明:
1476
+ r"""接口说明:
1477
1477
  启动一个混流转推任务,将 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)
1478
1478
 
1479
1479
  注意:
@@ -1503,7 +1503,7 @@ class TrtcClient(AbstractClient):
1503
1503
 
1504
1504
 
1505
1505
  def StartStreamIngest(self, request):
1506
- """将一个在线媒体流推到TRTC房间,更多功能说明见[输入媒体流进房](https://cloud.tencent.com/document/product/647/102957#50940aad-d90f-4473-9f46-d5dd46917653)。
1506
+ r"""将一个在线媒体流推到TRTC房间,更多功能说明见[输入媒体流进房](https://cloud.tencent.com/document/product/647/102957#50940aad-d90f-4473-9f46-d5dd46917653)。
1507
1507
  使用输入在线媒体流功能需先订阅 [尊享版或旗舰版套餐包](https://cloud.tencent.com/document/product/647/85386) 解锁能力位。
1508
1508
 
1509
1509
  :param request: Request instance for StartStreamIngest.
@@ -1527,7 +1527,7 @@ class TrtcClient(AbstractClient):
1527
1527
 
1528
1528
 
1529
1529
  def StartWebRecord(self, request):
1530
- """通过此接口可以发起 WEB 页面录制任务,在接口参数中指定录制 URL,录制分辨率,录制结果存储等参数。
1530
+ r"""通过此接口可以发起 WEB 页面录制任务,在接口参数中指定录制 URL,录制分辨率,录制结果存储等参数。
1531
1531
  因为参数或API逻辑问题会立即返回结果。而因为页面问题,如页面无法访问,会在回调中返回结果,请关注。
1532
1532
 
1533
1533
  :param request: Request instance for StartWebRecord.
@@ -1551,7 +1551,7 @@ class TrtcClient(AbstractClient):
1551
1551
 
1552
1552
 
1553
1553
  def StopAIConversation(self, request):
1554
- """停止AI对话任务
1554
+ r"""停止AI对话任务
1555
1555
 
1556
1556
  :param request: Request instance for StopAIConversation.
1557
1557
  :type request: :class:`tencentcloud.trtc.v20190722.models.StopAIConversationRequest`
@@ -1574,7 +1574,7 @@ class TrtcClient(AbstractClient):
1574
1574
 
1575
1575
 
1576
1576
  def StopAITranscription(self, request):
1577
- """停止AI转录任务。
1577
+ r"""停止AI转录任务。
1578
1578
 
1579
1579
  :param request: Request instance for StopAITranscription.
1580
1580
  :type request: :class:`tencentcloud.trtc.v20190722.models.StopAITranscriptionRequest`
@@ -1597,7 +1597,7 @@ class TrtcClient(AbstractClient):
1597
1597
 
1598
1598
 
1599
1599
  def StopMCUMixTranscode(self, request):
1600
- """接口说明:结束云端混流
1600
+ r"""接口说明:结束云端混流
1601
1601
 
1602
1602
  :param request: Request instance for StopMCUMixTranscode.
1603
1603
  :type request: :class:`tencentcloud.trtc.v20190722.models.StopMCUMixTranscodeRequest`
@@ -1620,7 +1620,7 @@ class TrtcClient(AbstractClient):
1620
1620
 
1621
1621
 
1622
1622
  def StopMCUMixTranscodeByStrRoomId(self, request):
1623
- """接口说明:结束云端混流
1623
+ r"""接口说明:结束云端混流
1624
1624
 
1625
1625
  :param request: Request instance for StopMCUMixTranscodeByStrRoomId.
1626
1626
  :type request: :class:`tencentcloud.trtc.v20190722.models.StopMCUMixTranscodeByStrRoomIdRequest`
@@ -1643,7 +1643,7 @@ class TrtcClient(AbstractClient):
1643
1643
 
1644
1644
 
1645
1645
  def StopPublishCdnStream(self, request):
1646
- """接口说明:
1646
+ r"""接口说明:
1647
1647
  停止指定的混流转推任务。如果没有调用 Stop 接口停止任务,所有参与混流转推的主播离开 TRTC 房间超过 AgentParams.MaxIdleTime 设置的时间后,任务也会自动停止。
1648
1648
 
1649
1649
  :param request: Request instance for StopPublishCdnStream.
@@ -1667,7 +1667,7 @@ class TrtcClient(AbstractClient):
1667
1667
 
1668
1668
 
1669
1669
  def StopStreamIngest(self, request):
1670
- """停止一个输入在线媒体流任务。
1670
+ r"""停止一个输入在线媒体流任务。
1671
1671
 
1672
1672
  :param request: Request instance for StopStreamIngest.
1673
1673
  :type request: :class:`tencentcloud.trtc.v20190722.models.StopStreamIngestRequest`
@@ -1690,7 +1690,7 @@ class TrtcClient(AbstractClient):
1690
1690
 
1691
1691
 
1692
1692
  def StopWebRecord(self, request):
1693
- """停止页面录制任务
1693
+ r"""停止页面录制任务
1694
1694
 
1695
1695
  :param request: Request instance for StopWebRecord.
1696
1696
  :type request: :class:`tencentcloud.trtc.v20190722.models.StopWebRecordRequest`
@@ -1713,7 +1713,7 @@ class TrtcClient(AbstractClient):
1713
1713
 
1714
1714
 
1715
1715
  def TextToSpeech(self, request):
1716
- """语音合成接口
1716
+ r"""语音合成接口
1717
1717
 
1718
1718
  :param request: Request instance for TextToSpeech.
1719
1719
  :type request: :class:`tencentcloud.trtc.v20190722.models.TextToSpeechRequest`
@@ -1736,7 +1736,7 @@ class TrtcClient(AbstractClient):
1736
1736
 
1737
1737
 
1738
1738
  def TextToSpeechSSE(self, request):
1739
- """SSE流式文本转语音
1739
+ r"""SSE流式文本转语音
1740
1740
 
1741
1741
  :param request: Request instance for TextToSpeechSSE.
1742
1742
  :type request: :class:`tencentcloud.trtc.v20190722.models.TextToSpeechSSERequest`
@@ -1754,7 +1754,7 @@ class TrtcClient(AbstractClient):
1754
1754
 
1755
1755
 
1756
1756
  def UpdateAIConversation(self, request):
1757
- """更新AIConversation参数
1757
+ r"""更新AIConversation参数
1758
1758
 
1759
1759
  :param request: Request instance for UpdateAIConversation.
1760
1760
  :type request: :class:`tencentcloud.trtc.v20190722.models.UpdateAIConversationRequest`
@@ -1777,7 +1777,7 @@ class TrtcClient(AbstractClient):
1777
1777
 
1778
1778
 
1779
1779
  def UpdatePublishCdnStream(self, request):
1780
- """接口说明:
1780
+ r"""接口说明:
1781
1781
  成功发起混流转推后,可以使用此接口来更新任务。仅在任务进行时有效,任务退出后更新将会返回错误。更新操作为增量更新模式。
1782
1782
  注意:为了保障推流的稳定性,更新不支持任务在纯音频、音视频、纯视频之间进行切换。
1783
1783
 
@@ -1802,7 +1802,7 @@ class TrtcClient(AbstractClient):
1802
1802
 
1803
1803
 
1804
1804
  def UpdateStreamIngest(self, request):
1805
- """更新输入在线媒体流任务的StreamUrl
1805
+ r"""更新输入在线媒体流任务的StreamUrl
1806
1806
 
1807
1807
  :param request: Request instance for UpdateStreamIngest.
1808
1808
  :type request: :class:`tencentcloud.trtc.v20190722.models.UpdateStreamIngestRequest`
@@ -1825,7 +1825,7 @@ class TrtcClient(AbstractClient):
1825
1825
 
1826
1826
 
1827
1827
  def UpdateVoicePrint(self, request):
1828
- """传入声纹ID以及对应音频信息,更新对应声纹信息
1828
+ r"""传入声纹ID以及对应音频信息,更新对应声纹信息
1829
1829
 
1830
1830
  :param request: Request instance for UpdateVoicePrint.
1831
1831
  :type request: :class:`tencentcloud.trtc.v20190722.models.UpdateVoicePrintRequest`
@@ -1848,7 +1848,7 @@ class TrtcClient(AbstractClient):
1848
1848
 
1849
1849
 
1850
1850
  def VoiceClone(self, request):
1851
- """声音克隆
1851
+ r"""声音克隆
1852
1852
 
1853
1853
  :param request: Request instance for VoiceClone.
1854
1854
  :type request: :class:`tencentcloud.trtc.v20190722.models.VoiceCloneRequest`
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: tencentcloud-sdk-python-trtc
3
- Version: 3.0.1456
3
+ Version: 3.0.1459
4
4
  Summary: Tencent Cloud Trtc SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 2.7
15
15
  Classifier: Programming Language :: Python :: 3
16
16
  Classifier: Programming Language :: Python :: 3.6
17
17
  Classifier: Programming Language :: Python :: 3.7
18
- Requires-Dist: tencentcloud-sdk-python-common (<4.0.0,>=3.0.1456)
18
+ Requires-Dist: tencentcloud-sdk-python-common (<4.0.0,>=3.0.1459)
19
19
 
20
20
  ============================
21
21
  Tencent Cloud SDK for Python