tccli-intl-en 3.0.1168.1__py2.py3-none-any.whl → 3.1.16.1__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.
- tccli/__init__.py +1 -1
- tccli/argument.py +1 -1
- tccli/plugins/sso/__init__.py +14 -0
- tccli/plugins/sso/login.py +23 -6
- tccli/plugins/sso/texts.py +4 -0
- tccli/services/__init__.py +49 -2
- tccli/services/advisor/advisor_client.py +10 -4
- tccli/services/ai3d/__init__.py +4 -0
- tccli/services/ai3d/ai3d_client.py +266 -0
- tccli/services/ai3d/v20250513/api.json +264 -0
- tccli/services/ai3d/v20250513/examples.json +20 -0
- tccli/services/aiart/aiart_client.py +5 -2
- tccli/services/ams/ams_client.py +20 -8
- tccli/services/antiddos/antiddos_client.py +350 -140
- tccli/services/apigateway/apigateway_client.py +465 -186
- tccli/services/apm/apm_client.py +835 -68
- tccli/services/apm/v20210622/api.json +3936 -1145
- tccli/services/apm/v20210622/examples.json +133 -23
- tccli/services/asr/asr_client.py +10 -4
- tccli/services/autoscaling/autoscaling_client.py +341 -114
- tccli/services/autoscaling/v20180419/api.json +514 -333
- tccli/services/autoscaling/v20180419/examples.json +46 -38
- tccli/services/batch/batch_client.py +140 -56
- tccli/services/bi/__init__.py +4 -0
- tccli/services/bi/bi_client.py +1498 -0
- tccli/services/bi/v20220105/api.json +5769 -0
- tccli/services/bi/v20220105/examples.json +215 -0
- tccli/services/billing/billing_client.py +1055 -134
- tccli/services/billing/v20180709/api.json +1654 -243
- tccli/services/billing/v20180709/examples.json +169 -25
- tccli/services/cam/cam_client.py +405 -162
- tccli/services/captcha/captcha_client.py +5 -2
- tccli/services/captcha/v20190722/api.json +16 -6
- tccli/services/captcha/v20190722/examples.json +3 -3
- tccli/services/car/car_client.py +165 -66
- tccli/services/cbs/cbs_client.py +190 -76
- tccli/services/ccc/ccc_client.py +1167 -268
- tccli/services/ccc/v20200210/api.json +2263 -202
- tccli/services/ccc/v20200210/examples.json +116 -12
- tccli/services/cdb/cdb_client.py +665 -266
- tccli/services/cdb/v20170320/api.json +426 -173
- tccli/services/cdb/v20170320/examples.json +6 -6
- tccli/services/cdc/cdc_client.py +100 -40
- tccli/services/cdc/v20201214/api.json +2 -2
- tccli/services/cdc/v20201214/examples.json +4 -4
- tccli/services/cdn/cdn_client.py +220 -88
- tccli/services/cdwdoris/cdwdoris_client.py +385 -154
- tccli/services/cdwpg/cdwpg_client.py +120 -48
- tccli/services/cdz/__init__.py +4 -0
- tccli/services/cdz/cdz_client.py +210 -0
- tccli/services/cdz/v20221123/api.json +233 -0
- tccli/services/cdz/v20221123/examples.json +12 -0
- tccli/services/cfg/cfg_client.py +80 -32
- tccli/services/cfg/v20210820/api.json +30 -10
- tccli/services/cfg/v20210820/examples.json +1 -1
- tccli/services/cfs/cfs_client.py +195 -78
- tccli/services/cfw/cfw_client.py +330 -132
- tccli/services/chdfs/chdfs_client.py +145 -58
- tccli/services/ciam/ciam_client.py +80 -32
- tccli/services/ckafka/ckafka_client.py +1033 -255
- tccli/services/ckafka/v20190819/api.json +3378 -1681
- tccli/services/ckafka/v20190819/examples.json +254 -160
- tccli/services/clb/clb_client.py +1054 -469
- tccli/services/clb/v20180317/api.json +2307 -1024
- tccli/services/clb/v20180317/examples.json +186 -126
- tccli/services/cloudaudit/cloudaudit_client.py +90 -36
- tccli/services/cls/cls_client.py +434 -173
- tccli/services/cmq/cmq_client.py +14 -803
- tccli/services/cmq/v20190304/api.json +173 -1367
- tccli/services/cmq/v20190304/examples.json +0 -120
- tccli/services/config/config_client.py +30 -12
- tccli/services/controlcenter/controlcenter_client.py +229 -2
- tccli/services/controlcenter/v20230110/api.json +528 -5
- tccli/services/controlcenter/v20230110/examples.json +32 -0
- tccli/services/csip/csip_client.py +339 -78
- tccli/services/csip/v20221121/api.json +1011 -38
- tccli/services/csip/v20221121/examples.json +24 -0
- tccli/services/ctsdb/__init__.py +4 -0
- tccli/services/ctsdb/ctsdb_client.py +266 -0
- tccli/services/ctsdb/v20230202/api.json +677 -0
- tccli/services/ctsdb/v20230202/examples.json +20 -0
- tccli/services/cvm/cvm_client.py +706 -189
- tccli/services/cvm/v20170312/api.json +1141 -510
- tccli/services/cvm/v20170312/examples.json +174 -128
- tccli/services/cwp/cwp_client.py +2325 -930
- tccli/services/cynosdb/cynosdb_client.py +3051 -575
- tccli/services/cynosdb/v20190107/api.json +14074 -7139
- tccli/services/cynosdb/v20190107/examples.json +597 -287
- tccli/services/dataintegration/dataintegration_client.py +5 -2
- tccli/services/dayu/dayu_client.py +515 -206
- tccli/services/dbbrain/dbbrain_client.py +210 -84
- tccli/services/dc/dc_client.py +90 -36
- tccli/services/dcdb/dcdb_client.py +310 -124
- tccli/services/dlc/dlc_client.py +859 -214
- tccli/services/dlc/v20210125/api.json +637 -13
- tccli/services/dlc/v20210125/examples.json +48 -0
- tccli/services/dms/dms_client.py +10 -4
- tccli/services/dnspod/dnspod_client.py +390 -111
- tccli/services/dnspod/v20210323/api.json +196 -0
- tccli/services/dnspod/v20210323/examples.json +24 -0
- tccli/services/domain/domain_client.py +120 -48
- tccli/services/dts/dts_client.py +415 -166
- tccli/services/eb/eb_client.py +130 -52
- tccli/services/ecdn/ecdn_client.py +75 -30
- tccli/services/ecm/ecm_client.py +620 -248
- tccli/services/eiam/eiam_client.py +200 -80
- tccli/services/emr/emr_client.py +3104 -117
- tccli/services/emr/v20190103/api.json +15311 -4361
- tccli/services/emr/v20190103/examples.json +452 -42
- tccli/services/es/es_client.py +105 -42
- tccli/services/facefusion/facefusion_client.py +15 -6
- tccli/services/faceid/faceid_client.py +95 -38
- tccli/services/faceid/v20180301/api.json +172 -45
- tccli/services/faceid/v20180301/examples.json +3 -3
- tccli/services/gaap/gaap_client.py +440 -176
- tccli/services/gme/gme_client.py +50 -20
- tccli/services/gpm/gpm_client.py +90 -36
- tccli/services/gse/gse_client.py +110 -44
- tccli/services/gwlb/gwlb_client.py +90 -36
- tccli/services/hunyuan/__init__.py +4 -0
- tccli/services/hunyuan/hunyuan_client.py +266 -0
- tccli/services/hunyuan/v20230901/api.json +270 -0
- tccli/services/hunyuan/v20230901/examples.json +20 -0
- tccli/services/iai/iai_client.py +145 -58
- tccli/services/iai/v20200303/api.json +187 -51
- tccli/services/iai/v20200303/examples.json +30 -12
- tccli/services/iap/iap_client.py +30 -12
- tccli/services/ims/ims_client.py +5 -2
- tccli/services/ims/v20201229/api.json +133 -141
- tccli/services/ims/v20201229/examples.json +3 -3
- tccli/services/intlpartnersmgt/intlpartnersmgt_client.py +516 -72
- tccli/services/intlpartnersmgt/v20220928/api.json +976 -60
- tccli/services/intlpartnersmgt/v20220928/examples.json +50 -2
- tccli/services/iotcloud/iotcloud_client.py +100 -40
- tccli/services/iotcloud/v20210408/api.json +216 -107
- tccli/services/iotcloud/v20210408/examples.json +9 -9
- tccli/services/ip/ip_client.py +30 -12
- tccli/services/kms/kms_client.py +1226 -227
- tccli/services/kms/v20190118/api.json +1562 -144
- tccli/services/kms/v20190118/examples.json +204 -78
- tccli/services/lcic/lcic_client.py +265 -106
- tccli/services/lighthouse/lighthouse_client.py +370 -148
- tccli/services/lighthouse/v20200324/api.json +14 -14
- tccli/services/lighthouse/v20200324/examples.json +5 -5
- tccli/services/live/live_client.py +804 -232
- tccli/services/live/v20180801/api.json +272 -0
- tccli/services/live/v20180801/examples.json +32 -0
- tccli/services/lke/__init__.py +4 -0
- tccli/services/lke/lke_client.py +5194 -0
- tccli/services/lke/v20231130/api.json +14803 -0
- tccli/services/lke/v20231130/examples.json +736 -0
- tccli/services/lkeap/__init__.py +4 -0
- tccli/services/lkeap/lkeap_client.py +602 -0
- tccli/services/lkeap/v20240522/api.json +953 -0
- tccli/services/lkeap/v20240522/examples.json +92 -0
- tccli/services/mariadb/mariadb_client.py +250 -100
- tccli/services/mdc/mdc_client.py +90 -36
- tccli/services/mdl/mdl_client.py +402 -82
- tccli/services/mdl/v20200326/api.json +1144 -58
- tccli/services/mdl/v20200326/examples.json +48 -16
- tccli/services/mdp/mdp_client.py +785 -122
- tccli/services/mdp/v20200527/api.json +1168 -44
- tccli/services/mdp/v20200527/examples.json +151 -79
- tccli/services/message/__init__.py +4 -0
- tccli/services/message/message_client.py +210 -0
- tccli/services/message/v20181225/api.json +72 -0
- tccli/services/message/v20181225/examples.json +13 -0
- tccli/services/mongodb/mongodb_client.py +1452 -136
- tccli/services/mongodb/v20190725/api.json +4393 -1462
- tccli/services/mongodb/v20190725/examples.json +265 -71
- tccli/services/monitor/monitor_client.py +1008 -296
- tccli/services/monitor/v20180724/api.json +660 -11
- tccli/services/monitor/v20180724/examples.json +152 -4
- tccli/services/mps/mps_client.py +1573 -354
- tccli/services/mps/v20190612/api.json +12394 -7243
- tccli/services/mps/v20190612/examples.json +244 -84
- tccli/services/msp/msp_client.py +35 -14
- tccli/services/ocr/ocr_client.py +596 -102
- tccli/services/ocr/v20181119/api.json +2271 -181
- tccli/services/ocr/v20181119/examples.json +70 -8
- tccli/services/omics/omics_client.py +100 -40
- tccli/services/organization/organization_client.py +580 -232
- tccli/services/postgres/postgres_client.py +455 -182
- tccli/services/postgres/v20170312/api.json +134 -109
- tccli/services/postgres/v20170312/examples.json +14 -14
- tccli/services/privatedns/privatedns_client.py +206 -60
- tccli/services/privatedns/v20201028/api.json +179 -0
- tccli/services/privatedns/v20201028/examples.json +8 -0
- tccli/services/pts/pts_client.py +240 -96
- tccli/services/quota/__init__.py +4 -0
- tccli/services/quota/quota_client.py +434 -0
- tccli/services/quota/v20241204/api.json +548 -0
- tccli/services/quota/v20241204/examples.json +51 -0
- tccli/services/rce/rce_client.py +5 -2
- tccli/services/redis/redis_client.py +698 -212
- tccli/services/redis/v20180412/api.json +968 -563
- tccli/services/redis/v20180412/examples.json +98 -56
- tccli/services/region/__init__.py +4 -0
- tccli/services/region/region_client.py +322 -0
- tccli/services/region/v20220627/api.json +399 -0
- tccli/services/region/v20220627/examples.json +29 -0
- tccli/services/rum/rum_client.py +300 -120
- tccli/services/scf/scf_client.py +210 -84
- tccli/services/ses/ses_client.py +368 -69
- tccli/services/ses/v20201002/api.json +240 -0
- tccli/services/ses/v20201002/examples.json +32 -0
- tccli/services/smh/__init__.py +4 -0
- tccli/services/smh/smh_client.py +714 -0
- tccli/services/smh/v20210712/api.json +1287 -0
- tccli/services/smh/v20210712/examples.json +85 -0
- tccli/services/sms/sms_client.py +90 -36
- tccli/services/sqlserver/sqlserver_client.py +3855 -470
- tccli/services/sqlserver/v20180328/api.json +9757 -3347
- tccli/services/sqlserver/v20180328/examples.json +480 -20
- tccli/services/ssl/ssl_client.py +504 -72
- tccli/services/ssl/v20191205/api.json +789 -21
- tccli/services/ssl/v20191205/examples.json +54 -0
- tccli/services/ssm/ssm_client.py +120 -48
- tccli/services/sts/sts_client.py +25 -10
- tccli/services/tag/tag_client.py +150 -60
- tccli/services/tat/tat_client.py +95 -38
- tccli/services/tbaas/__init__.py +4 -0
- tccli/services/tbaas/tbaas_client.py +378 -0
- tccli/services/tbaas/v20180416/api.json +551 -0
- tccli/services/tbaas/v20180416/examples.json +37 -0
- tccli/services/tcaplusdb/tcaplusdb_client.py +260 -104
- tccli/services/tcaplusdb/v20190823/api.json +836 -760
- tccli/services/tcaplusdb/v20190823/examples.json +3 -3
- tccli/services/tchd/tchd_client.py +5 -2
- tccli/services/tcmpp/tcmpp_client.py +520 -208
- tccli/services/tcr/tcr_client.py +380 -152
- tccli/services/tcsas/tcsas_client.py +295 -118
- tccli/services/tcsas/v20250106/api.json +155 -79
- tccli/services/tcsas/v20250106/examples.json +3 -3
- tccli/services/tcss/tcss_client.py +1650 -660
- tccli/services/tdid/tdid_client.py +240 -96
- tccli/services/tdmq/tdmq_client.py +2876 -466
- tccli/services/tdmq/v20200217/api.json +11607 -3958
- tccli/services/tdmq/v20200217/examples.json +562 -264
- tccli/services/tem/tem_client.py +280 -112
- tccli/services/teo/teo_client.py +4507 -966
- tccli/services/teo/v20220901/api.json +7341 -1405
- tccli/services/teo/v20220901/examples.json +679 -99
- tccli/services/tione/__init__.py +4 -0
- tccli/services/tione/tione_client.py +210 -0
- tccli/services/tione/v20211111/api.json +3074 -0
- tccli/services/tione/v20211111/examples.json +12 -0
- tccli/services/tiw/tiw_client.py +255 -102
- tccli/services/tke/tke_client.py +741 -274
- tccli/services/tke/v20180525/api.json +132 -7
- tccli/services/tke/v20180525/examples.json +42 -16
- tccli/services/tms/tms_client.py +5 -2
- tccli/services/tms/v20201229/api.json +91 -100
- tccli/services/tmt/tmt_client.py +5 -2
- tccli/services/trabbit/__init__.py +4 -0
- tccli/services/trabbit/trabbit_client.py +1778 -0
- tccli/services/trabbit/v20230418/api.json +4772 -0
- tccli/services/trabbit/v20230418/examples.json +237 -0
- tccli/services/trocket/__init__.py +4 -0
- tccli/services/trocket/trocket_client.py +2450 -0
- tccli/services/trocket/v20230308/api.json +6062 -0
- tccli/services/trocket/v20230308/examples.json +339 -0
- tccli/services/trro/trro_client.py +95 -38
- tccli/services/trtc/trtc_client.py +928 -192
- tccli/services/trtc/v20190722/api.json +1810 -256
- tccli/services/trtc/v20190722/examples.json +100 -6
- tccli/services/tts/tts_client.py +5 -2
- tccli/services/vclm/vclm_client.py +10 -4
- tccli/services/vm/v20210922/api.json +61 -30
- tccli/services/vm/v20210922/examples.json +0 -12
- tccli/services/vm/vm_client.py +20 -8
- tccli/services/vod/v20180717/api.json +332 -52
- tccli/services/vod/v20180717/examples.json +9 -1
- tccli/services/vod/v20240718/api.json +1105 -0
- tccli/services/vod/v20240718/examples.json +97 -0
- tccli/services/vod/vod_client.py +1316 -350
- tccli/services/vpc/v20170312/api.json +1166 -106
- tccli/services/vpc/v20170312/examples.json +197 -23
- tccli/services/vpc/vpc_client.py +2413 -739
- tccli/services/waf/v20180125/api.json +1372 -194
- tccli/services/waf/v20180125/examples.json +89 -1
- tccli/services/waf/waf_client.py +1149 -245
- tccli/services/wedata/v20210820/api.json +1577 -231
- tccli/services/wedata/v20210820/examples.json +74 -12
- tccli/services/wedata/v20250806/api.json +13644 -0
- tccli/services/wedata/v20250806/examples.json +621 -0
- tccli/services/wedata/wedata_client.py +6366 -1191
- tccli/services/yunjing/yunjing_client.py +355 -142
- {tccli_intl_en-3.0.1168.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/METADATA +4 -7
- {tccli_intl_en-3.0.1168.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/RECORD +294 -230
- {tccli_intl_en-3.0.1168.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/WHEEL +1 -1
- {tccli_intl_en-3.0.1168.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/entry_points.txt +0 -1
- {tccli_intl_en-3.0.1168.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/LICENSE +0 -0
- {tccli_intl_en-3.0.1168.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/top_level.txt +0 -0
|
@@ -7,6 +7,13 @@
|
|
|
7
7
|
"output": "ControlAIConversationResponse",
|
|
8
8
|
"status": "online"
|
|
9
9
|
},
|
|
10
|
+
"CreateCloudModeration": {
|
|
11
|
+
"document": "API description:\nThis API is used to enable the cloud moderation feature to complete audio and video slicing, video frame extraction, and audio stream recording in the room, and submit them to the specified moderation supplier for completing the moderation.\n\nThis API is used to achieve the following goals:\n* This API is used to specify the moderation parameters (ModerationParams) to specify the detailed parameters required for moderation.\n* This API is used to specify the storage parameter (SliceStorageParams) to specify the cloud storage you want to upload the file complying with the moderation policy to. Currently, Tencent Cloud Object Storage (COS) and third-party AWS are supported.",
|
|
12
|
+
"input": "CreateCloudModerationRequest",
|
|
13
|
+
"name": "Creates cloud moderation tasks",
|
|
14
|
+
"output": "CreateCloudModerationResponse",
|
|
15
|
+
"status": "online"
|
|
16
|
+
},
|
|
10
17
|
"CreateCloudRecording": {
|
|
11
18
|
"document": "API description:\nThis API is used to start an on-cloud recording task. It records the audio and video streams in a room and saves them to the specified cloud storage. You can use this API to record the streams in a room separately, or you can mix the streams first and then record the mixed stream.\n\nYou can use this API to perform the following operations:\n* Specify the anchors whose streams you want or do not want to record by using the `RecordParams` parameter\n* Specify the storage service you want to save recording files to by using the `StorageParams` parameter. Currently, you can save recording files to Tencent Cloud VOD or COS.\n* Specify transcoding settings for mixed-stream recording, including video resolution, video bitrate, frame rate, and audio quality, by using `MixTranscodeParams`\n* Specify the layout of different videos in mixed-stream recording mode or select an auto-arranged layout template\n\nKey concepts:\n* Single-stream recording: Record the audio and video of each subscribed user (`UserId`) in a room and save the recording files to the storage you specify.\nMixed-stream recording: Mix the audios and videos of subscribed users (`UserId`) in a room, record the mixed stream, and save the recording files to the storage you specify. After a recording task ends, you can go to the VOD console (https://console.tencentcloud.com/vod/media) or [COS console](https://console.cloud.tencent.com/cos/bucket) to view the recording files.",
|
|
12
19
|
"input": "CreateCloudRecordingRequest",
|
|
@@ -14,6 +21,20 @@
|
|
|
14
21
|
"output": "CreateCloudRecordingResponse",
|
|
15
22
|
"status": "online"
|
|
16
23
|
},
|
|
24
|
+
"CreateCloudSliceTask": {
|
|
25
|
+
"document": "API description:\nThis API is used to enable the cloud slicing feature, completing audio and video slicing tasks in the room, and uploading them to the specified cloud storage.\nThis API is used to achieve the following goals:\n* This API is used to specify the slicing parameter (SliceParams) to define the blocklist or allowlist of the anchors that require slicing.\n* This API is used to specify the storage parameter (SliceStorageParams) to specify the cloud storage you want to upload to. Currently, Tencent Cloud Object Storage (COS) and third-party AWS are supported.",
|
|
26
|
+
"input": "CreateCloudSliceTaskRequest",
|
|
27
|
+
"name": "Creates a cloud slicing task",
|
|
28
|
+
"output": "CreateCloudSliceTaskResponse",
|
|
29
|
+
"status": "online"
|
|
30
|
+
},
|
|
31
|
+
"DeleteCloudModeration": {
|
|
32
|
+
"document": "This API is used to stop submission for moderation after the cloud moderation task is successfully started.",
|
|
33
|
+
"input": "DeleteCloudModerationRequest",
|
|
34
|
+
"name": "Stops cloud moderation",
|
|
35
|
+
"output": "DeleteCloudModerationResponse",
|
|
36
|
+
"status": "online"
|
|
37
|
+
},
|
|
17
38
|
"DeleteCloudRecording": {
|
|
18
39
|
"document": "This API is used to stop a recording task. If a task is stopped successfully, but the uploading of recording files has not completed, the backend will continue to upload the files and will notify you via a callback when the upload is completed.",
|
|
19
40
|
"input": "DeleteCloudRecordingRequest",
|
|
@@ -21,6 +42,13 @@
|
|
|
21
42
|
"output": "DeleteCloudRecordingResponse",
|
|
22
43
|
"status": "online"
|
|
23
44
|
},
|
|
45
|
+
"DeleteCloudSliceTask": {
|
|
46
|
+
"document": "This API is used to stop the slicing task after it is started. Successfully stopping the slicing does not mean that all files are fully transmitted; if the transmission is not completed, the backend will continue to upload files. After the upload is successful, a notification is sent to the customer, prompting that all files have been transmitted, through the event callback.",
|
|
47
|
+
"input": "DeleteCloudSliceTaskRequest",
|
|
48
|
+
"name": "Stops a cloud slicing task",
|
|
49
|
+
"output": "DeleteCloudSliceTaskResponse",
|
|
50
|
+
"status": "online"
|
|
51
|
+
},
|
|
24
52
|
"DescribeAIConversation": {
|
|
25
53
|
"document": "Describe the AI conversation task status",
|
|
26
54
|
"input": "DescribeAIConversationRequest",
|
|
@@ -42,6 +70,13 @@
|
|
|
42
70
|
"output": "DescribeCallDetailInfoResponse",
|
|
43
71
|
"status": "online"
|
|
44
72
|
},
|
|
73
|
+
"DescribeCloudModeration": {
|
|
74
|
+
"document": "This API is used to query the status of the moderation task and information about the subscription blocklist and allowlist after the task is started, which is valid only when the task is in progress. An error will be returned if the task is exited.",
|
|
75
|
+
"input": "DescribeCloudModerationRequest",
|
|
76
|
+
"name": "Queries cloud moderation information",
|
|
77
|
+
"output": "DescribeCloudModerationResponse",
|
|
78
|
+
"status": "online"
|
|
79
|
+
},
|
|
45
80
|
"DescribeCloudRecording": {
|
|
46
81
|
"document": "This API is used to query the status of a recording task after it starts. It works only when a task is in progress. If the task has already ended when this API is called, an error will be returned.\nIf a recording file is being uploaded to VOD, the response parameter `StorageFileList` will not contain the information of the recording file. Please listen for the recording file callback to get the information.",
|
|
47
82
|
"input": "DescribeCloudRecordingRequest",
|
|
@@ -49,6 +84,13 @@
|
|
|
49
84
|
"output": "DescribeCloudRecordingResponse",
|
|
50
85
|
"status": "online"
|
|
51
86
|
},
|
|
87
|
+
"DescribeCloudSliceTask": {
|
|
88
|
+
"document": "This API is used to query the status of the slicing task after it is started, which is valid only when the task is in progress. An error will be returned if the task is exited.",
|
|
89
|
+
"input": "DescribeCloudSliceTaskRequest",
|
|
90
|
+
"name": "Queries information about cloud slicing tasks",
|
|
91
|
+
"output": "DescribeCloudSliceTaskResponse",
|
|
92
|
+
"status": "online"
|
|
93
|
+
},
|
|
52
94
|
"DescribeMixTranscodingUsage": {
|
|
53
95
|
"document": "This API is used to query your usage of TRTC’s On-Cloud MixTranscoding service.\n- If the period queried is one day or shorter, the statistics returned are on a five-minute basis. If the period queried is longer than one day, the statistics returned are on a daily basis.\n- The period queried per request cannot be longer than 31 days.\n- If you query the statistics of the current day, the statistics returned may be inaccurate due to the delay in data collection.\n- You can use this API to query your historical usage or to reconcile data, but we do not recommend you use it for crucial business logic.\n- The rate limit of this API is five calls per second.",
|
|
54
96
|
"input": "DescribeMixTranscodingUsageRequest",
|
|
@@ -154,6 +196,13 @@
|
|
|
154
196
|
"output": "DescribeUserInfoResponse",
|
|
155
197
|
"status": "online"
|
|
156
198
|
},
|
|
199
|
+
"DescribeWebRecord": {
|
|
200
|
+
"document": "Queries the status of a web-page recording task",
|
|
201
|
+
"input": "DescribeWebRecordRequest",
|
|
202
|
+
"name": "Queries the status of a web-page recording task",
|
|
203
|
+
"output": "DescribeWebRecordResponse",
|
|
204
|
+
"status": "online"
|
|
205
|
+
},
|
|
157
206
|
"DismissRoom": {
|
|
158
207
|
"document": "This API is used to remove all users from a room and dismiss the room. It supports all platforms. For Android, iOS, Windows, and macOS, the TRTC SDK needs to be upgraded to v6.6 or above.",
|
|
159
208
|
"input": "DismissRoomRequest",
|
|
@@ -168,6 +217,13 @@
|
|
|
168
217
|
"output": "DismissRoomByStrRoomIdResponse",
|
|
169
218
|
"status": "online"
|
|
170
219
|
},
|
|
220
|
+
"ModifyCloudModeration": {
|
|
221
|
+
"document": "This API is used to update the subscription blocklist and allowlist after the cloud moderation task is successfully started.",
|
|
222
|
+
"input": "ModifyCloudModerationRequest",
|
|
223
|
+
"name": "Modifies cloud moderation tasks",
|
|
224
|
+
"output": "ModifyCloudModerationResponse",
|
|
225
|
+
"status": "online"
|
|
226
|
+
},
|
|
171
227
|
"ModifyCloudRecording": {
|
|
172
228
|
"document": "This API is used to modify a recording task. It works only when a task is in progress. If the task has already ended when this API is called, an error will be returned. You need to specify all the parameters for each request instead of just the ones you want to modify.",
|
|
173
229
|
"input": "ModifyCloudRecordingRequest",
|
|
@@ -175,6 +231,13 @@
|
|
|
175
231
|
"output": "ModifyCloudRecordingResponse",
|
|
176
232
|
"status": "online"
|
|
177
233
|
},
|
|
234
|
+
"ModifyCloudSliceTask": {
|
|
235
|
+
"document": "This API is used to update the slicing task after it is started. It can be used to update the allowlist or blocklist for the specified subscription stream.",
|
|
236
|
+
"input": "ModifyCloudSliceTaskRequest",
|
|
237
|
+
"name": "Modifies a cloud slicing task",
|
|
238
|
+
"output": "ModifyCloudSliceTaskResponse",
|
|
239
|
+
"status": "online"
|
|
240
|
+
},
|
|
178
241
|
"RemoveUser": {
|
|
179
242
|
"document": "This API is used to remove a user from a room. It is applicable to scenarios where the anchor, room owner, or admin wants to kick out a user. It supports all platforms. For Android, iOS, Windows, and macOS, the TRTC SDK needs to be upgraded to v6.6 or above.",
|
|
180
243
|
"input": "RemoveUserRequest",
|
|
@@ -218,7 +281,7 @@
|
|
|
218
281
|
"status": "online"
|
|
219
282
|
},
|
|
220
283
|
"StartPublishCdnStream": {
|
|
221
|
-
"document": "In a TRTC room, there may be multiple audio and video streams concurrently active. You can use the MixTranscoding API to notify Tencent Cloud server to mix multiple video screens from the same room or multiple rooms together, and specify the position of each screen, while mixing multiple audio streams together. The final result is a single audio and video stream, which can be used for recording and live viewing. It also supports pushing this mixed audio and video stream back to the TRTC room.\n\nThe Cloud API MixTranscoding feature includes three interfaces:\n1. StartPublishCdnStream: Start a MixTranscoding task. This interface will initiate a new MixTranscoding task. After the task is successfully started, a unique TaskId will be returned under the sdkappid dimension. You need to save this TaskId, as it will be required for updating and stopping the task later.\n2. UpdatePublishCdnStream: Update the specified MixTranscoding task, including updating the video screen layout, updating the mixing list, updating the list of CDN addresses to be relayed, and updating the list of rooms to be pushed back.\n3. StopPublishCdnStream: Stop the specified MixTranscoding task.\n\nYou can achieve the following goals through this set of interfaces:\n1. Set the final video and audio quality, including video resolution, video frame rate, video bitrate, and audio quality.\n2. Set the layout position of each screen. You only need to set it once. When you specify the MixTranscoding user to enter the room and send audio and video, the layout engine will automatically mix the user's screen to the specified layout position. You can also use the update interface to adjust the layout position.\n3. Set multiple CDN relay target addresses. A single relay task can support up to 10 CDN relay addresses at the same time.\n4. Set multiple room pushback lists. A single relay task can support up to 10 TRTC rooms for mixed stream pushback.\n\nThe following layout templates are currently supported. Dynamic layout templates (floating template, grid template, screen sharing template) only support a single TRTC room, while custom templates support mixing audio and video streams from multiple TRTC rooms. The specific descriptions are as follows:\n1. Floating template: The video screen of the first user entering the room will fill the entire screen, and the video screens of other users will be arranged horizontally from the bottom left corner, displaying as small screens, with up to 4 rows and 4 screens per row. The small screens float above the large screen. It supports up to 1 large screen and 15 small screens. If the user only sends audio, it does not occupy the layout configuration by default, but it can also be set. Each sub-screen is rendered by default using the center cropping method, and the rendering method of the sub-screen can also be set uniformly.\n2. Grid template: The video screens of all users are of the same size, evenly dividing the entire screen. The more people there are, the smaller the size of each user's screen. It supports up to 16 screens. If the user only sends audio, it does not occupy the layout configuration by default, but it can also be set. Each sub-screen is rendered by default using the center cropping method, and the rendering method of the sub-screen can also be set uniformly.\n3. Screen sharing template: Suitable for video conference and online education scenarios. The screen sharing (or the main speaker's camera) always occupies the large screen position on the left side of the screen. You need to explicitly set the MixTranscoding user information that occupies the large screen. Other users are arranged vertically on the right side, with up to two columns and 8 small screens per column. It supports up to 1 large screen and 15 small screens. If the uplink resolution aspect ratio is different from the screen output aspect ratio, the large screen on the left side will be scaled to maintain content integrity, while the small screens on the right side will be cropped. The rendering method of the sub-screen can also be set uniformly.\n4. Custom layout template: Allows you to actively set the layout position according to your business needs. Each preset layout position supports named settings (named settings require specifying the room number and username) and unnamed settings. When a sub-screen is named, the position is reserved for the user, and the user will automatically occupy the position when entering the room and sending audio and video data. Other users will not occupy this position. When the preset layout position is not named, the layout engine will automatically fill in the order of entering the room. When the preset positions are full, no other users' screens and sounds will be mixed. Each sub-screen position supports setting placeholder images (BackgroundImageUrl). When the user does not enter the room or only sends audio data, the screen at this position can display the corresponding placeholder image.\n\nWhen using the relay API, you may incur the following costs depending on the usage characteristics:\nFor MCU MixTranscoding fees, please refer to the documentation: Billing of MixTranscoding and Relay to CDN | Tencent Cloud.\nFor non-Tencent Cloud CDN relay fees, please refer to the documentation: Billing of MixTranscoding and Relay to CDN | Tencent Cloud.\n\nInstructions for using parameters:\n1. AgentParams: Each relay task will pull a robot user into the TRTC room to pull the stream. You need to set this robot user through the AgentParams.UserId parameter. This robot ID cannot conflict with the normal user ID in the room, otherwise, the relay task will be abnormally terminated due to the robot user being kicked out of the TRTC room. You can avoid this by adding a special prefix. You can control the automatic termination of the relay task by setting AgentParams.MaxIdleTime. When this parameter is set, the relay task will automatically stop when all participating MixTranscoding anchors continuously leave the TRTC room for more than MaxIdleTime duration. Note: The relay task will not automatically stop when the participating MixTranscoding anchor only stops sending audio and video.\n2. WithTranscoding: If you need to mix multiple audio and video streams into one, WithTranscoding must be set to 1.\n3. AudioParams: The audio parameters and video parameters of the relay task are set separately. If you want to mix the audio of specified users, you need to explicitly set AudioParams.SubscribeAudioList. If you do not set AudioParams.SubscribeAudioList, the mixing engine will automatically mix the audio of all users in the TRTC room. If you want to mix the audio of all users in the TRTC room except for specified users, you can set the audio blacklist list through AudioParams.UnSubscribeAudioList.\n4. VideoParams: If you want to mix user videos, you can set it through VideoParams. If you only want to mix audio, you do not need to set VideoParams. You can set the screen layout mode through VideoParams.LayoutParams.MixLayoutMode, including dynamic layout (1: floating layout (default), 2: screen sharing layout, 3: grid layout) and custom layout. The dynamic layout mode is automatically mixed by the layout engine according to a fixed layout, and there is no need to set VideoParams.LayoutParams.MixLayoutList. When using the floating layout and screen sharing layout, you can specify the large screen user by setting VideoParams.LayoutParams.MaxVideoUser. The custom layout mode provides you with the ability to layout screens independently, and you can specify the layout position of each user through VideoParams.LayoutParams.MixLayoutList. In each layout parameter, you can specify the layout position for the specified user by setting the UserMediaStream parameter, or you can not set the UserMediaStream, and the layout engine will automatically fill in the order of users entering the TRTC room. In addition, you can set the rendering method (RenderMode) and cropping method (CustomCrop) for each layout position.\n5. VideoParams.WaterMarkList: If you want to overlay a watermark on the mixed screen, you can set it through VideoParams.WaterMarkList. It supports image watermarks and text watermarks and supports transparent channels.\n6. SingleSubscribeParams: If you want to push a single stream from the TRTC room to the CDN, you can set it using the SingleSubscribeParams parameter. In this case, you need to set the WithTranscoding parameter to 0.\n7. PublishCdnParams.N: If you want to push the stream to the CDN, you can set it using the PublishCdnParams.N parameter. It supports pushing to up to 10 CDN addresses at the same time. If the relay address is Tencent Cloud CDN, please set IsTencentCdn explicitly to 1; if you need to relay to a non-Tencent Cloud CDN, please contact Tencent Cloud Technical Support to enable it. Relaying to non-Tencent Cloud will incur relay fees. For fee information, please refer to the official documentation: On-Cloud Relay Billing Overview.\n8. FeedBackRoomParams.N: If you want to push the mixed audio and video stream back to the TRTC room, you can set it using the FeedBackRoomParams.N parameter. It supports pushing up to 10 streams back to the TRTC room at the same time. You need to specify the TRTC room number and robot ID (UserId) for the pushback. The robot ID cannot conflict with the normal user ID, otherwise, the relay task will be abnormally terminated due to the robot user being kicked out of the TRTC room. You can avoid this by adding a special prefix.\n9. SeiParams: If you want to add SEI information to the mixed audio and video stream, you can set it using the SeiParams parameter. It supports volume layout SEI and overlay relay request SEI. The content of the volume layout SEI is a fixed JSON structure, please see the SEI description in the following section of this chapter. You can set the SEI to follow the keyframe by setting the FollowIdr parameter. The description of the volume layout SEI is as follows:\nIf your CDN audience needs to recognize the position of the participating MixTranscoding anchors and the volume information of the participating MixTranscoding anchors, you can use the volume layout SEI. The payload content and parameter description of the volume layout SEI are as follows:\n{ \"app_data\":\"\", \"canvas\":{ \"w\":1080, \"h\":960 }, \"regions\":[ { \"uid\":\"65949987242835883c\", \"zorder\":2, \"volume\":45, \"x\":270, \"y\":480, \"w\":540, \"h\":480 }, { \"uid\":\"659c9d8d242b328d31\", \"zorder\":2, \"volume\":0, \"x\":0, \"y\":0, \"w\":540, \"h\":480 }, { \"uid\":\"64989a82272b308c\", \"zorder\":2, \"volume\":91, \"x\":540, \"y\":0, \"w\":540, \"h\":480 } ], \"ver\":\"1.0\", \"ts\":1648544726 }\ncanvas: This is the width and height of the VideoEncode setting in the MixTranscoding signaling, that is, the width and height of the entire canvas of the MixTranscoding output.\nregions: Contains the real mixed user ID and the corresponding sub-screen position. If the participating MixTranscoding user does not enter the TRTC room or does not turn on the video uplink, the regions will not include the user.\nuid: Represents the user ID participating in MixTranscoding.\nzorder: The layer of the participating MixTranscoding userid in the MixTranscoding output.\nx/y: The coordinates of the sub-screen of the participating MixTranscoding userid on the canvas.\nw/h: The size of the sub-screen of the participating MixTranscoding userid.\nvolume: Represents the volume of the MixTranscoding user, with a value range of 0-100. The larger the value, the greater the volume of the user participating in MixTranscoding.\nts: The server local second-level timestamp for outputting SEI. \nver: can be ignored.\n\nUsage Precautions:\n1. When using the Mixed Relay Interface, you need to call the Start Relay Task Interface (StartPublishCdnStream) first to get the Task ID from the response. Then, use the Task ID to update the relay task (UpdatePublishCdnStream) and stop the relay task (StopPublishCdnStream).\n2. The Relay API does not support initiating Automatic Bypass Tasks configured in the TRTC Console, nor does it support Custom Stream ID bypass tasks set in the TRTC SDK room entry interface.\n3. To ensure the stability of the relay link, the same relay task does not support switching between Audio only, Audio and Video, and Video only.\n4. To ensure the stability of the relay link, updating video parameters (codec) and audio parameters (codec, Sample rate, bitrate, and number of channels) is not supported during the Update Video process.\n5. When initiating a single stream bypass task, filling in both Audio Parameters and Video Parameters means Audio and Video bypass. If only Audio Parameters are filled in, it means Audio only bypass, and switching from Audio only to Audio and Video is not supported during the task progress. For Audio and Video bypass, the Width, Height, Fps, BitRate, and Gop in Video Parameters must be filled in according to the real upstream parameters.\n6. The SequenceNumber parameter must be carried in the update request to prevent request disorder. Customers must ensure that the SequenceNumber parameter increases when updating the same task, otherwise, the mix task update will fail.\n7. When calling the API, choose the region according to the following instructions: If the Application ID is 1400xxx, the region can be Beijing, Shanghai, Guangzhou, or Hong Kong. If your CDN audience is mainly overseas, please choose Hong Kong. If the Application ID is 200xxx or 400xxx, please choose Singapore.\n8. Streams pushed back to the TRTC room will not participate in the mixing of other push back room tasks. If one of the following conditions is met, it can participate in the mixing of other relay CDN tasks: (1) The push stream robot is specified to participate in the mixing in the video parameters of the relay CDN task; (2) The push stream robot is specified to participate in the mixing in the audio parameters of the relay CDN task through the whitelist method; (3) The room number of the mix user participating in the relay CDN task is completely different from the room number of the mix user corresponding to the push back robot.\n9. You can create a relay task before the anchor enters the room. When the relay task is finished, you need to call the stop interface actively. If you do not call the Stop Relay Task Interface, Tencent Cloud will automatically stop the mix relay task when all users participating in the mix have no data uploaded for a period of time exceeding the timeout (AgentParams.MaxIdleTime) set when starting the relay task.",
|
|
284
|
+
"document": "**API Description**\n\nThis API starts a stream mixing and relaying task. This API mixes multiple audio/video streams from a TRTC room into a single stream, encodes it, and then pushes it to CDN server or publishs it into the TRTC room. It also supports relaying a single stream from a TRTC room directly without transcoding.\n\nAfter success, the API returns a globally unique TaskID. You will need this TaskId in later operations such as updating or stopping the task.\n\nFor more details, refer to the document: [Feature Description](https://trtc.io/zh/document/47858?product=rtcengine ) and [FAQs](https://trtc.io/zh/document/36058?product=rtcengine&menulabel=core%20sdk&platform=web) .\n\nNote: You can enable the relay to CDN in the console to monitor events under the CDN relay status. For callback details, see: [Relay to CDN Callback Description](https://trtc.io/zh/document/54913?product=rtcengine&menulabel=core%20sdk&platform=web ) .\n\nStarting a relay task may incur the following fees:\nMCU stream mixing and transcoding fees: [See Cloud Stream Mixing and Transcoding Pricing](https://trtc.io/zh/document/47631 ) .",
|
|
222
285
|
"input": "StartPublishCdnStreamRequest",
|
|
223
286
|
"name": "Starts a relaying task",
|
|
224
287
|
"output": "StartPublishCdnStreamResponse",
|
|
@@ -231,6 +294,13 @@
|
|
|
231
294
|
"output": "StartStreamIngestResponse",
|
|
232
295
|
"status": "online"
|
|
233
296
|
},
|
|
297
|
+
"StartWebRecord": {
|
|
298
|
+
"document": "This interface can be used to initiate a web-page recording task. In the interface parameters, specify the recording URL, recording resolution, recording result storage and other parameters. If there are parameter or API logic problems, the result will be returned immediately. If there are page problems, such as the page cannot be accessed, the result will be returned in the callback. Please pay attention.",
|
|
299
|
+
"input": "StartWebRecordRequest",
|
|
300
|
+
"name": "Starts an web-page recording task",
|
|
301
|
+
"output": "StartWebRecordResponse",
|
|
302
|
+
"status": "online"
|
|
303
|
+
},
|
|
234
304
|
"StopAIConversation": {
|
|
235
305
|
"document": "Stop AI conversation task",
|
|
236
306
|
"input": "StopAIConversationRequest",
|
|
@@ -246,7 +316,7 @@
|
|
|
246
316
|
"status": "online"
|
|
247
317
|
},
|
|
248
318
|
"StopPublishCdnStream": {
|
|
249
|
-
"document": "This API is used to stop a relaying task.",
|
|
319
|
+
"document": "This API is used to stop a relaying task.\nYou can create a relay task before the anchor enters the room. When the relay task is finished, you need to call the stop interface actively. If you do not call the Stop Relay Task Interface, Tencent Cloud will automatically stop the mix relay task when all users participating in the mix have no data uploaded for a period of time exceeding the timeout (AgentParams.MaxIdleTime) set when starting the relay task.",
|
|
250
320
|
"input": "StopPublishCdnStreamRequest",
|
|
251
321
|
"name": "Stops a relaying task",
|
|
252
322
|
"output": "StopPublishCdnStreamResponse",
|
|
@@ -259,6 +329,13 @@
|
|
|
259
329
|
"output": "StopStreamIngestResponse",
|
|
260
330
|
"status": "online"
|
|
261
331
|
},
|
|
332
|
+
"StopWebRecord": {
|
|
333
|
+
"document": "Stop an web-page recording task",
|
|
334
|
+
"input": "StopWebRecordRequest",
|
|
335
|
+
"name": "Stop an web-page recording task",
|
|
336
|
+
"output": "StopWebRecordResponse",
|
|
337
|
+
"status": "online"
|
|
338
|
+
},
|
|
262
339
|
"UpdateAIConversation": {
|
|
263
340
|
"document": "Update AI conversation task parameters",
|
|
264
341
|
"input": "UpdateAIConversationRequest",
|
|
@@ -467,7 +544,7 @@
|
|
|
467
544
|
{
|
|
468
545
|
"disabled": false,
|
|
469
546
|
"document": "The signature (similar to a login password) required for the relaying robot to enter the room. For information on how to calculate the signature, see [What is UserSig?](https://intl.cloud.tencent.com/document/product/647/38104). |",
|
|
470
|
-
"example": "
|
|
547
|
+
"example": "eJw1zc0Ogj***kCs8k5Eg__",
|
|
471
548
|
"member": "string",
|
|
472
549
|
"name": "UserSig",
|
|
473
550
|
"required": false,
|
|
@@ -600,28 +677,146 @@
|
|
|
600
677
|
],
|
|
601
678
|
"usage": "in"
|
|
602
679
|
},
|
|
680
|
+
"CloudModerationStorage": {
|
|
681
|
+
"document": "Information about Tencent COS and third-party cloud storage accounts.",
|
|
682
|
+
"members": [
|
|
683
|
+
{
|
|
684
|
+
"disabled": false,
|
|
685
|
+
"document": "Information about Tencent COS and third-party cloud storage accounts.\n0: Tencent COS.\n1: AWS S3.\n2: Alibaba Cloud OSS.\nExample value: 0.",
|
|
686
|
+
"example": "0",
|
|
687
|
+
"member": "uint64",
|
|
688
|
+
"name": "Vendor",
|
|
689
|
+
"required": true,
|
|
690
|
+
"type": "int"
|
|
691
|
+
},
|
|
692
|
+
{
|
|
693
|
+
"disabled": false,
|
|
694
|
+
"document": "[Region information](https://www.tencentcloud.com/document/product/436/6224?from_cn_redirect=1#.E5.9C.B0.E5.9F.9F) of Tencent COS.\nExample value: cn-shanghai-1.\n\n[Region information](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions) of AWS S3.\nExample value: ap-southeast-3.\t",
|
|
695
|
+
"example": "cn-shanghai-1",
|
|
696
|
+
"member": "string",
|
|
697
|
+
"name": "Region",
|
|
698
|
+
"required": true,
|
|
699
|
+
"type": "string"
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
"disabled": false,
|
|
703
|
+
"document": "Cloud bucket name.",
|
|
704
|
+
"example": "test-bucket",
|
|
705
|
+
"member": "string",
|
|
706
|
+
"name": "Bucket",
|
|
707
|
+
"required": true,
|
|
708
|
+
"type": "string"
|
|
709
|
+
},
|
|
710
|
+
{
|
|
711
|
+
"disabled": false,
|
|
712
|
+
"document": "access_key account information of the cloud storage.\nTo store files to Tencent COS, visit https://console.cloud.tencent.com/cam/capi to view or create the SecretId value corresponding to the key fields in the link.\nExample value: test-accesskey.",
|
|
713
|
+
"example": "test-accesskey",
|
|
714
|
+
"member": "string",
|
|
715
|
+
"name": "AccessKey",
|
|
716
|
+
"required": true,
|
|
717
|
+
"type": "string"
|
|
718
|
+
},
|
|
719
|
+
{
|
|
720
|
+
"disabled": false,
|
|
721
|
+
"document": "secret_key account information of cloud storage.\nTo store files to Tencent COS, visit https://console.cloud.tencent.com/cam/capi to view or create the SecretKey value corresponding to the key fields in the link.\nExample value: test-secretkey.",
|
|
722
|
+
"example": "test-secretkey",
|
|
723
|
+
"member": "string",
|
|
724
|
+
"name": "SecretKey",
|
|
725
|
+
"required": true,
|
|
726
|
+
"type": "string"
|
|
727
|
+
},
|
|
728
|
+
{
|
|
729
|
+
"disabled": false,
|
|
730
|
+
"document": "Specified location of the cloud bucket, which consists of arrays of strings. Value range for the strings is lowercase letters (a-z), uppercase letters (A-Z), digits (0-9), and special characters (_-). For example, under the feature of [\"prefix1\", \"prefix2\"], the audio slicing file (xxx.mp3) is stored as prefix1/prefix2/{taskId}/{userId}/audios/{sdkappid}_{roomId}_{userid}_{UTC time}.ogg, while the video frame is stored as prefix1/prefix2/{taskId}/{userId}/images/{sdkappid}_{roomId}_{userid}_{UTC time}.png.",
|
|
731
|
+
"example": "[\"prefix1\", \"prefix2\"]",
|
|
732
|
+
"member": "string",
|
|
733
|
+
"name": "FileNamePrefix",
|
|
734
|
+
"required": false,
|
|
735
|
+
"type": "list"
|
|
736
|
+
}
|
|
737
|
+
],
|
|
738
|
+
"usage": "in"
|
|
739
|
+
},
|
|
740
|
+
"CloudSliceStorage": {
|
|
741
|
+
"document": "Information about Tencent COS and third-party cloud storage accounts.",
|
|
742
|
+
"members": [
|
|
743
|
+
{
|
|
744
|
+
"disabled": false,
|
|
745
|
+
"document": "Information about Tencent COS and third-party cloud storage accounts.\n0: Tencent COS.\n1: AWS S3.\n2: Alibaba Cloud OSS.\nExample value: 0.",
|
|
746
|
+
"example": "0",
|
|
747
|
+
"member": "uint64",
|
|
748
|
+
"name": "Vendor",
|
|
749
|
+
"required": true,
|
|
750
|
+
"type": "int"
|
|
751
|
+
},
|
|
752
|
+
{
|
|
753
|
+
"disabled": false,
|
|
754
|
+
"document": "[Region information](https://www.tencentcloud.com/document/product/436/6224?from_cn_redirect=1#.E5.9C.B0.E5.9F.9F) of Tencent COS.\nExample value: cn-shanghai-1.\n[Region information](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions) of AWS S3.\nExample value: ap-southeast-3.\t",
|
|
755
|
+
"example": "cn-shanghai-1",
|
|
756
|
+
"member": "string",
|
|
757
|
+
"name": "Region",
|
|
758
|
+
"required": true,
|
|
759
|
+
"type": "string"
|
|
760
|
+
},
|
|
761
|
+
{
|
|
762
|
+
"disabled": false,
|
|
763
|
+
"document": "Cloud bucket name.",
|
|
764
|
+
"example": "test-bucket",
|
|
765
|
+
"member": "string",
|
|
766
|
+
"name": "Bucket",
|
|
767
|
+
"required": true,
|
|
768
|
+
"type": "string"
|
|
769
|
+
},
|
|
770
|
+
{
|
|
771
|
+
"disabled": false,
|
|
772
|
+
"document": "access_key account information of the cloud storage.\nTo store files to Tencent COS, visit https://console.cloud.tencent.com/cam/capi to view or create the SecretId value corresponding to the key fields in the link.\nExample value: test-accesskey.",
|
|
773
|
+
"example": "test-accesskey",
|
|
774
|
+
"member": "string",
|
|
775
|
+
"name": "AccessKey",
|
|
776
|
+
"required": true,
|
|
777
|
+
"type": "string"
|
|
778
|
+
},
|
|
779
|
+
{
|
|
780
|
+
"disabled": false,
|
|
781
|
+
"document": "secret_key account information of the cloud storage.\nTo store files to Tencent COS, visit https://console.cloud.tencent.com/cam/capi to view or create the SecretKey value corresponding to the key fields in the link.\nExample value: test-secretkey.",
|
|
782
|
+
"example": "test-secretkey",
|
|
783
|
+
"member": "string",
|
|
784
|
+
"name": "SecretKey",
|
|
785
|
+
"required": true,
|
|
786
|
+
"type": "string"
|
|
787
|
+
},
|
|
788
|
+
{
|
|
789
|
+
"disabled": false,
|
|
790
|
+
"document": "Specified location of the cloud bucket, which consists of an array of strings. Value range for the strings is lowercase letters (a-z), uppercase letters (A-Z), digits (0-9), and special characters (_-). For example, under the feature of [\"prefix1\", \"prefix2\"], the audio slicing file (xxx.mp3) is stored as prefix1/prefix2/{taskId}/{userId}/audios/{sdkappid}_{roomId}_{userid}_{UTC time}.ogg, while the video frame is stored as prefix1/prefix2/{taskId}/{userId}/images/{sdkappid}_{roomId}_{userid}_{UTC time}.png.",
|
|
791
|
+
"example": "[\"prefix1\", \"prefix2\"]",
|
|
792
|
+
"member": "string",
|
|
793
|
+
"name": "FileNamePrefix",
|
|
794
|
+
"required": false,
|
|
795
|
+
"type": "list"
|
|
796
|
+
}
|
|
797
|
+
],
|
|
798
|
+
"usage": "in"
|
|
799
|
+
},
|
|
603
800
|
"CloudStorage": {
|
|
604
801
|
"document": "The cloud storage information.",
|
|
605
802
|
"members": [
|
|
606
803
|
{
|
|
607
804
|
"disabled": false,
|
|
608
805
|
"document": "The cloud storage provider.\n`0`: Tencent Cloud COS; `1`: AWS storage. Other vendors are not supported currently.",
|
|
609
|
-
"example": "
|
|
806
|
+
"example": "0",
|
|
610
807
|
"member": "uint64",
|
|
611
808
|
"name": "Vendor",
|
|
612
809
|
"required": true,
|
|
613
|
-
"type": "int"
|
|
614
|
-
"value_allowed_null": false
|
|
810
|
+
"type": "int"
|
|
615
811
|
},
|
|
616
812
|
{
|
|
617
813
|
"disabled": false,
|
|
618
814
|
"document": "The region of cloud storage.",
|
|
619
|
-
"example": "
|
|
815
|
+
"example": "ap-shanghai(cos, 具体参考云存储厂商支持的地域)",
|
|
620
816
|
"member": "string",
|
|
621
817
|
"name": "Region",
|
|
622
818
|
"required": true,
|
|
623
|
-
"type": "string"
|
|
624
|
-
"value_allowed_null": false
|
|
819
|
+
"type": "string"
|
|
625
820
|
},
|
|
626
821
|
{
|
|
627
822
|
"disabled": false,
|
|
@@ -630,8 +825,7 @@
|
|
|
630
825
|
"member": "string",
|
|
631
826
|
"name": "Bucket",
|
|
632
827
|
"required": true,
|
|
633
|
-
"type": "string"
|
|
634
|
-
"value_allowed_null": false
|
|
828
|
+
"type": "string"
|
|
635
829
|
},
|
|
636
830
|
{
|
|
637
831
|
"disabled": false,
|
|
@@ -640,8 +834,7 @@
|
|
|
640
834
|
"member": "string",
|
|
641
835
|
"name": "AccessKey",
|
|
642
836
|
"required": true,
|
|
643
|
-
"type": "string"
|
|
644
|
-
"value_allowed_null": false
|
|
837
|
+
"type": "string"
|
|
645
838
|
},
|
|
646
839
|
{
|
|
647
840
|
"disabled": false,
|
|
@@ -650,8 +843,7 @@
|
|
|
650
843
|
"member": "string",
|
|
651
844
|
"name": "SecretKey",
|
|
652
845
|
"required": true,
|
|
653
|
-
"type": "string"
|
|
654
|
-
"value_allowed_null": false
|
|
846
|
+
"type": "string"
|
|
655
847
|
},
|
|
656
848
|
{
|
|
657
849
|
"disabled": false,
|
|
@@ -660,8 +852,7 @@
|
|
|
660
852
|
"member": "string",
|
|
661
853
|
"name": "FileNamePrefix",
|
|
662
854
|
"required": false,
|
|
663
|
-
"type": "list"
|
|
664
|
-
"value_allowed_null": false
|
|
855
|
+
"type": "list"
|
|
665
856
|
}
|
|
666
857
|
],
|
|
667
858
|
"usage": "in"
|
|
@@ -727,6 +918,106 @@
|
|
|
727
918
|
],
|
|
728
919
|
"type": "object"
|
|
729
920
|
},
|
|
921
|
+
"CreateCloudModerationRequest": {
|
|
922
|
+
"document": "CreateCloudModeration request structure.",
|
|
923
|
+
"members": [
|
|
924
|
+
{
|
|
925
|
+
"disabled": false,
|
|
926
|
+
"document": "[SdkAppId](https://www.tencentcloud.com/document/product/647/46351?from_cn_redirect=1#sdkappid) of TRTC, which is the same as the SdkAppId corresponding to the TRTC room.",
|
|
927
|
+
"example": "1400188366",
|
|
928
|
+
"member": "uint64",
|
|
929
|
+
"name": "SdkAppId",
|
|
930
|
+
"required": true,
|
|
931
|
+
"type": "int"
|
|
932
|
+
},
|
|
933
|
+
{
|
|
934
|
+
"disabled": false,
|
|
935
|
+
"document": "[RoomId](https://www.tencentcloud.com/document/product/647/46351?from_cn_redirect=1#roomid) of TRTC, which is the RoomId corresponding to the TRTC room.",
|
|
936
|
+
"example": "295212",
|
|
937
|
+
"member": "string",
|
|
938
|
+
"name": "RoomId",
|
|
939
|
+
"required": true,
|
|
940
|
+
"type": "string"
|
|
941
|
+
},
|
|
942
|
+
{
|
|
943
|
+
"disabled": false,
|
|
944
|
+
"document": "Chatbot's UserId, which is used to enter the room and initiate a moderation task. [*Note] This UserId should not be duplicated with the UserIds of the current anchors or audience members in the room. If multiple moderation tasks are initiated in one room, the chatbot's UserId should also be unique; otherwise, the previous moderation task is interrupted. It is recommended to include the room ID as part of the UserId, ensuring that the chatbot's UserId is unique in the room.",
|
|
945
|
+
"example": "robot_1234",
|
|
946
|
+
"member": "string",
|
|
947
|
+
"name": "UserId",
|
|
948
|
+
"required": true,
|
|
949
|
+
"type": "string"
|
|
950
|
+
},
|
|
951
|
+
{
|
|
952
|
+
"disabled": false,
|
|
953
|
+
"document": "Signature verification corresponding to the chatbot's UserId, namely, the UserId and UserSig serve as the login password for the chatbot to enter the room. For specific calculation methods, see TRTC solution for calculating UserSig.",
|
|
954
|
+
"example": "JwsjsHKgkAURt-lbv8fuXdyzAZauImIZBKDwJ3oKFdJhhkNI3r3yNx*B853XnA954GZLTsDiqSUAhH-l5VrM4zcsHGggAdvTTXCD-m6L63lGhSFiBTHmyhaCbegwIZ-WXfsu2kotauoccklT-Up0fOueN78pH15KFyrZZrtV*XI92-BNhSChKRV91jORYDw",
|
|
955
|
+
"member": "string",
|
|
956
|
+
"name": "UserSig",
|
|
957
|
+
"required": true,
|
|
958
|
+
"type": "string"
|
|
959
|
+
},
|
|
960
|
+
{
|
|
961
|
+
"disabled": false,
|
|
962
|
+
"document": "Control parameters for cloud moderation.",
|
|
963
|
+
"example": "无",
|
|
964
|
+
"member": "ModerationParams",
|
|
965
|
+
"name": "ModerationParams",
|
|
966
|
+
"required": true,
|
|
967
|
+
"type": "object"
|
|
968
|
+
},
|
|
969
|
+
{
|
|
970
|
+
"disabled": false,
|
|
971
|
+
"document": "Parameters for uploading cloud moderation files to the cloud storage.",
|
|
972
|
+
"example": "无",
|
|
973
|
+
"member": "ModerationStorageParams",
|
|
974
|
+
"name": "ModerationStorageParams",
|
|
975
|
+
"required": true,
|
|
976
|
+
"type": "object"
|
|
977
|
+
},
|
|
978
|
+
{
|
|
979
|
+
"disabled": false,
|
|
980
|
+
"document": "Type of the TRTC room number. [*Note] It should be the same as the type of the RoomId corresponding to the recording room. 0: string type; 1: 32-bit integer type (default value). Example value: 1.",
|
|
981
|
+
"example": "1",
|
|
982
|
+
"member": "uint64",
|
|
983
|
+
"name": "RoomIdType",
|
|
984
|
+
"required": false,
|
|
985
|
+
"type": "int"
|
|
986
|
+
},
|
|
987
|
+
{
|
|
988
|
+
"disabled": false,
|
|
989
|
+
"document": "Validity period for calling the task ID, which starts upon successful initiation of the task and obtaining the task ID. After the timeout, APIs such as querying, updating, or stopping cannot be called, but the moderation task is not stopped. The unit of the parameter is hours, with a default value of 24 hours (1 day). The maximum value is 72 hours (3 days), while the minimum value is 6 hours. For example, if this parameter is not specified, the validity period for calling the querying, updating, and stopping slicing APIs is 24 hours upon the successful start of slicing.",
|
|
990
|
+
"example": "24",
|
|
991
|
+
"member": "uint64",
|
|
992
|
+
"name": "ResourceExpiredHour",
|
|
993
|
+
"required": false,
|
|
994
|
+
"type": "int"
|
|
995
|
+
}
|
|
996
|
+
],
|
|
997
|
+
"type": "object"
|
|
998
|
+
},
|
|
999
|
+
"CreateCloudModerationResponse": {
|
|
1000
|
+
"document": "CreateCloudModeration response structure.",
|
|
1001
|
+
"members": [
|
|
1002
|
+
{
|
|
1003
|
+
"disabled": false,
|
|
1004
|
+
"document": "Task ID assigned by the cloud moderation service. It is a unique identifier for the lifecycle of a moderation task, which loses its significance after the task is completed. The task ID needs to be retained by the business system as a parameter for future operations related to this task.",
|
|
1005
|
+
"example": "-npVqpdU7pr3JUbUasDy5PLPQaHPhkPbIkDILoK-2OqyoZWQndibCtH88ztBhkWAhZCH9DwE.",
|
|
1006
|
+
"member": "string",
|
|
1007
|
+
"name": "TaskId",
|
|
1008
|
+
"output_required": true,
|
|
1009
|
+
"type": "string",
|
|
1010
|
+
"value_allowed_null": false
|
|
1011
|
+
},
|
|
1012
|
+
{
|
|
1013
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
1014
|
+
"member": "string",
|
|
1015
|
+
"name": "RequestId",
|
|
1016
|
+
"type": "string"
|
|
1017
|
+
}
|
|
1018
|
+
],
|
|
1019
|
+
"type": "object"
|
|
1020
|
+
},
|
|
730
1021
|
"CreateCloudRecordingRequest": {
|
|
731
1022
|
"document": "CreateCloudRecording request structure.",
|
|
732
1023
|
"members": [
|
|
@@ -854,13 +1145,13 @@
|
|
|
854
1145
|
],
|
|
855
1146
|
"type": "object"
|
|
856
1147
|
},
|
|
857
|
-
"
|
|
858
|
-
"document": "
|
|
1148
|
+
"CreateCloudSliceTaskRequest": {
|
|
1149
|
+
"document": "CreateCloudSliceTask request structure.",
|
|
859
1150
|
"members": [
|
|
860
1151
|
{
|
|
861
1152
|
"disabled": false,
|
|
862
|
-
"document": "
|
|
863
|
-
"example": "
|
|
1153
|
+
"document": "[SdkAppId](https://www.tencentcloud.com/document/product/647/46351?from_cn_redirect=1#sdkappid) of TRTC, which is the same as the SdkAppId corresponding to the TRTC room.",
|
|
1154
|
+
"example": "1400704311",
|
|
864
1155
|
"member": "uint64",
|
|
865
1156
|
"name": "SdkAppId",
|
|
866
1157
|
"required": true,
|
|
@@ -868,36 +1159,237 @@
|
|
|
868
1159
|
},
|
|
869
1160
|
{
|
|
870
1161
|
"disabled": false,
|
|
871
|
-
"document": "
|
|
872
|
-
"example": "
|
|
1162
|
+
"document": "[RoomId](https://www.tencentcloud.com/document/product/647/46351?from_cn_redirect=1#roomid) of TRTC, which is the RoomId corresponding to the TRTC room.",
|
|
1163
|
+
"example": "295212",
|
|
873
1164
|
"member": "string",
|
|
874
|
-
"name": "
|
|
1165
|
+
"name": "RoomId",
|
|
875
1166
|
"required": true,
|
|
876
1167
|
"type": "string"
|
|
877
|
-
}
|
|
878
|
-
],
|
|
879
|
-
"type": "object"
|
|
880
|
-
},
|
|
881
|
-
"DeleteCloudRecordingResponse": {
|
|
882
|
-
"document": "DeleteCloudRecording response structure.",
|
|
883
|
-
"members": [
|
|
1168
|
+
},
|
|
884
1169
|
{
|
|
885
1170
|
"disabled": false,
|
|
886
|
-
"document": "
|
|
887
|
-
"example": "
|
|
1171
|
+
"document": "Chatbot's UserId, which is used to enter the room and initiate a slicing task. [*note] This UserId should not be duplicated with the UserIds of the current anchors or audience members in the room. If multiple slicing tasks are initiated in one room, the chatbot's UserId should also be unique; otherwise, the previous slicing task is interrupted. It is recommended to include the room ID as part of the UserId, ensuring that the chatbot's UserId is unique in the room.",
|
|
1172
|
+
"example": "slice_robot_1",
|
|
888
1173
|
"member": "string",
|
|
889
|
-
"name": "
|
|
1174
|
+
"name": "UserId",
|
|
890
1175
|
"required": true,
|
|
891
|
-
"type": "string"
|
|
892
|
-
"value_allowed_null": false
|
|
1176
|
+
"type": "string"
|
|
893
1177
|
},
|
|
894
1178
|
{
|
|
895
|
-
"
|
|
1179
|
+
"disabled": false,
|
|
1180
|
+
"document": "Signature verification corresponding to the chatbot's UserId, namely, the UserId and UserSig serve as the login password for the chatbot to enter the room. For specific calculation methods, see TRTC solution for calculating UserSig.",
|
|
1181
|
+
"example": "eJyrVgrxCdYrSy1SslIy0jNQ0gHzM1NS80oy0zLBwpl5xQWpySVQqeKU7MSCgswUJSsjAwNDAwsDM4h4axxx",
|
|
896
1182
|
"member": "string",
|
|
897
|
-
"name": "
|
|
1183
|
+
"name": "UserSig",
|
|
1184
|
+
"required": true,
|
|
898
1185
|
"type": "string"
|
|
899
|
-
}
|
|
900
|
-
|
|
1186
|
+
},
|
|
1187
|
+
{
|
|
1188
|
+
"disabled": false,
|
|
1189
|
+
"document": "Control parameters for cloud slicing.",
|
|
1190
|
+
"example": "无",
|
|
1191
|
+
"member": "SliceParams",
|
|
1192
|
+
"name": "SliceParams",
|
|
1193
|
+
"required": true,
|
|
1194
|
+
"type": "object"
|
|
1195
|
+
},
|
|
1196
|
+
{
|
|
1197
|
+
"disabled": false,
|
|
1198
|
+
"document": "Parameters for uploading cloud slicing files to the cloud storage.",
|
|
1199
|
+
"example": "无",
|
|
1200
|
+
"member": "SliceStorageParams",
|
|
1201
|
+
"name": "SliceStorageParams",
|
|
1202
|
+
"required": true,
|
|
1203
|
+
"type": "object"
|
|
1204
|
+
},
|
|
1205
|
+
{
|
|
1206
|
+
"disabled": false,
|
|
1207
|
+
"document": "Type of the TRTC room number. [*Note] It should be the same as the type of the RoomId corresponding to the recording room. 0: string type; 1: 32-bit integer type (default value). Example value: 1.",
|
|
1208
|
+
"example": "1",
|
|
1209
|
+
"member": "uint64",
|
|
1210
|
+
"name": "RoomIdType",
|
|
1211
|
+
"required": false,
|
|
1212
|
+
"type": "int"
|
|
1213
|
+
},
|
|
1214
|
+
{
|
|
1215
|
+
"disabled": false,
|
|
1216
|
+
"document": "Validity period for calling the API, which starts upon successful initiation of recording and obtaining the task ID. After the timeout, APIs such as querying, updating, or stopping cannot be called, but the recording task is not stopped. The unit of the parameter is hours, with a default value of 72 hours (3 days). The maximum value is 720 hours (30 days), while the minimum value is 6 hours. For example, if this parameter is not specified, the validity period for calling the querying, updating, and stopping recording APIs is 72 hours upon the successful start of recording. Example value: 24.",
|
|
1217
|
+
"example": "24",
|
|
1218
|
+
"member": "uint64",
|
|
1219
|
+
"name": "ResourceExpiredHour",
|
|
1220
|
+
"required": false,
|
|
1221
|
+
"type": "int"
|
|
1222
|
+
},
|
|
1223
|
+
{
|
|
1224
|
+
"disabled": false,
|
|
1225
|
+
"document": "TRTC room permission encryption string, which is required only when advanced permission control is enabled in the TRTC console. After enabling, the TRTC backend service system verifies a \"permission ticket\" called [PrivateMapKey], which contains an encrypted RoomId and an encrypted \"permission bit list\". Since the PrivateMapKey includes the RoomId, the specified room cannot be entered if only UserSig is provided and PrivateMapKey is not provided. Example value: eJw1jcEKgkAURX9FZlvY****fL9rfNX4_.",
|
|
1226
|
+
"example": "无",
|
|
1227
|
+
"member": "string",
|
|
1228
|
+
"name": "PrivateMapKey",
|
|
1229
|
+
"required": false,
|
|
1230
|
+
"type": "string"
|
|
1231
|
+
}
|
|
1232
|
+
],
|
|
1233
|
+
"type": "object"
|
|
1234
|
+
},
|
|
1235
|
+
"CreateCloudSliceTaskResponse": {
|
|
1236
|
+
"document": "CreateCloudSliceTask response structure.",
|
|
1237
|
+
"members": [
|
|
1238
|
+
{
|
|
1239
|
+
"disabled": false,
|
|
1240
|
+
"document": "Task ID assigned by the cloud slicing service. It is a unique identifier for the lifecycle of a slicing task, which loses its significance after the task is completed. The task ID needs to be retained by the business system as a parameter for future operations related to this task.",
|
|
1241
|
+
"example": "-npVqpdU7pr3JUbUasDy5PLPQaHPhkPbIkDILoK-2OqyoZWQndibCtH88ztBhkWAhZCH9DwE.",
|
|
1242
|
+
"member": "string",
|
|
1243
|
+
"name": "TaskId",
|
|
1244
|
+
"output_required": true,
|
|
1245
|
+
"type": "string",
|
|
1246
|
+
"value_allowed_null": false
|
|
1247
|
+
},
|
|
1248
|
+
{
|
|
1249
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
1250
|
+
"member": "string",
|
|
1251
|
+
"name": "RequestId",
|
|
1252
|
+
"type": "string"
|
|
1253
|
+
}
|
|
1254
|
+
],
|
|
1255
|
+
"type": "object"
|
|
1256
|
+
},
|
|
1257
|
+
"DeleteCloudModerationRequest": {
|
|
1258
|
+
"document": "DeleteCloudModeration request structure.",
|
|
1259
|
+
"members": [
|
|
1260
|
+
{
|
|
1261
|
+
"disabled": false,
|
|
1262
|
+
"document": "SDKAppId of TRTC, which is the same as the SDKAppId corresponding to the TRTC room.",
|
|
1263
|
+
"example": "1400188366",
|
|
1264
|
+
"member": "uint64",
|
|
1265
|
+
"name": "SdkAppId",
|
|
1266
|
+
"required": true,
|
|
1267
|
+
"type": "int"
|
|
1268
|
+
},
|
|
1269
|
+
{
|
|
1270
|
+
"disabled": false,
|
|
1271
|
+
"document": "Unique ID of the moderation task, which is returned after the task is started.",
|
|
1272
|
+
"example": "-npVoIhU7nQhuIyPncW+12qkkV--KL3bBznoI4K-4pycoZWQndibFvKbEU+fxxvJzuc+2xqATAE.",
|
|
1273
|
+
"member": "string",
|
|
1274
|
+
"name": "TaskId",
|
|
1275
|
+
"required": true,
|
|
1276
|
+
"type": "string"
|
|
1277
|
+
}
|
|
1278
|
+
],
|
|
1279
|
+
"type": "object"
|
|
1280
|
+
},
|
|
1281
|
+
"DeleteCloudModerationResponse": {
|
|
1282
|
+
"document": "DeleteCloudModeration response structure.",
|
|
1283
|
+
"members": [
|
|
1284
|
+
{
|
|
1285
|
+
"disabled": false,
|
|
1286
|
+
"document": "Unique ID of the moderation task, which is returned after the task is started.",
|
|
1287
|
+
"example": "-npVoIhU7nQhuIyPncW+12qkkV--KL3bBznoI4K-4pycoZWQndibFvKbEU+fxxvJzuc+2xqATAE.",
|
|
1288
|
+
"member": "string",
|
|
1289
|
+
"name": "TaskId",
|
|
1290
|
+
"output_required": true,
|
|
1291
|
+
"type": "string",
|
|
1292
|
+
"value_allowed_null": false
|
|
1293
|
+
},
|
|
1294
|
+
{
|
|
1295
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
1296
|
+
"member": "string",
|
|
1297
|
+
"name": "RequestId",
|
|
1298
|
+
"type": "string"
|
|
1299
|
+
}
|
|
1300
|
+
],
|
|
1301
|
+
"type": "object"
|
|
1302
|
+
},
|
|
1303
|
+
"DeleteCloudRecordingRequest": {
|
|
1304
|
+
"document": "DeleteCloudRecording request structure.",
|
|
1305
|
+
"members": [
|
|
1306
|
+
{
|
|
1307
|
+
"disabled": false,
|
|
1308
|
+
"document": "The `SDKAppID` of the room whose streams are recorded.",
|
|
1309
|
+
"example": "1234",
|
|
1310
|
+
"member": "uint64",
|
|
1311
|
+
"name": "SdkAppId",
|
|
1312
|
+
"required": true,
|
|
1313
|
+
"type": "int"
|
|
1314
|
+
},
|
|
1315
|
+
{
|
|
1316
|
+
"disabled": false,
|
|
1317
|
+
"document": "The unique ID of the recording task, which is returned after recording starts successfully.",
|
|
1318
|
+
"example": "1234",
|
|
1319
|
+
"member": "string",
|
|
1320
|
+
"name": "TaskId",
|
|
1321
|
+
"required": true,
|
|
1322
|
+
"type": "string"
|
|
1323
|
+
}
|
|
1324
|
+
],
|
|
1325
|
+
"type": "object"
|
|
1326
|
+
},
|
|
1327
|
+
"DeleteCloudRecordingResponse": {
|
|
1328
|
+
"document": "DeleteCloudRecording response structure.",
|
|
1329
|
+
"members": [
|
|
1330
|
+
{
|
|
1331
|
+
"disabled": false,
|
|
1332
|
+
"document": "The task ID assigned by the recording service, which uniquely identifies a recording process and becomes invalid after a recording task ends.",
|
|
1333
|
+
"example": "1234",
|
|
1334
|
+
"member": "string",
|
|
1335
|
+
"name": "TaskId",
|
|
1336
|
+
"required": true,
|
|
1337
|
+
"type": "string",
|
|
1338
|
+
"value_allowed_null": false
|
|
1339
|
+
},
|
|
1340
|
+
{
|
|
1341
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
1342
|
+
"member": "string",
|
|
1343
|
+
"name": "RequestId",
|
|
1344
|
+
"type": "string"
|
|
1345
|
+
}
|
|
1346
|
+
],
|
|
1347
|
+
"type": "object"
|
|
1348
|
+
},
|
|
1349
|
+
"DeleteCloudSliceTaskRequest": {
|
|
1350
|
+
"document": "DeleteCloudSliceTask request structure.",
|
|
1351
|
+
"members": [
|
|
1352
|
+
{
|
|
1353
|
+
"disabled": false,
|
|
1354
|
+
"document": "SDKAppId of TRTC, which is the same as the SDKAppId corresponding to the TRTC room.",
|
|
1355
|
+
"example": "1400188366",
|
|
1356
|
+
"member": "uint64",
|
|
1357
|
+
"name": "SdkAppId",
|
|
1358
|
+
"required": true,
|
|
1359
|
+
"type": "int"
|
|
1360
|
+
},
|
|
1361
|
+
{
|
|
1362
|
+
"disabled": false,
|
|
1363
|
+
"document": "Unique ID of the slicing task, which is returned after the task is started.",
|
|
1364
|
+
"example": "-nHwX3RU7h3eZ-9PYsqd+z8I1uU1tUnbTWClW4K-xuWiN6KipeCyXJ8ZJEFpWSZ5zZuyZUAuAQ..",
|
|
1365
|
+
"member": "string",
|
|
1366
|
+
"name": "TaskId",
|
|
1367
|
+
"required": true,
|
|
1368
|
+
"type": "string"
|
|
1369
|
+
}
|
|
1370
|
+
],
|
|
1371
|
+
"type": "object"
|
|
1372
|
+
},
|
|
1373
|
+
"DeleteCloudSliceTaskResponse": {
|
|
1374
|
+
"document": "DeleteCloudSliceTask response structure.",
|
|
1375
|
+
"members": [
|
|
1376
|
+
{
|
|
1377
|
+
"disabled": false,
|
|
1378
|
+
"document": "Unique ID of the slicing task, which is returned after the task is started.",
|
|
1379
|
+
"example": "-nHwX3RU7h3eZ-9PYsqd+z8I1uU1tUnbTWClW4K-xuWiN6KipeCyXJ8ZJEFpWSZ5zZuyZUAuAQ..",
|
|
1380
|
+
"member": "string",
|
|
1381
|
+
"name": "TaskId",
|
|
1382
|
+
"output_required": true,
|
|
1383
|
+
"type": "string",
|
|
1384
|
+
"value_allowed_null": false
|
|
1385
|
+
},
|
|
1386
|
+
{
|
|
1387
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
1388
|
+
"member": "string",
|
|
1389
|
+
"name": "RequestId",
|
|
1390
|
+
"type": "string"
|
|
1391
|
+
}
|
|
1392
|
+
],
|
|
901
1393
|
"type": "object"
|
|
902
1394
|
},
|
|
903
1395
|
"DescribeAIConversationRequest": {
|
|
@@ -1190,6 +1682,72 @@
|
|
|
1190
1682
|
],
|
|
1191
1683
|
"type": "object"
|
|
1192
1684
|
},
|
|
1685
|
+
"DescribeCloudModerationRequest": {
|
|
1686
|
+
"document": "DescribeCloudModeration request structure.",
|
|
1687
|
+
"members": [
|
|
1688
|
+
{
|
|
1689
|
+
"disabled": false,
|
|
1690
|
+
"document": "SDKAppId of TRTC, which is the same as the SDKAppId corresponding to the recording room.",
|
|
1691
|
+
"example": "1400188366",
|
|
1692
|
+
"member": "uint64",
|
|
1693
|
+
"name": "SdkAppId",
|
|
1694
|
+
"required": true,
|
|
1695
|
+
"type": "int"
|
|
1696
|
+
},
|
|
1697
|
+
{
|
|
1698
|
+
"disabled": false,
|
|
1699
|
+
"document": "Unique ID of the cloud moderation task, which is returned after the task is started.",
|
|
1700
|
+
"example": "-npVoIhU7uxalbjwbc-qxKyKqluNl93bUmLFI4K-4pycoZWQndibYzKsC3HkljEK3HikwogUxwE.",
|
|
1701
|
+
"member": "string",
|
|
1702
|
+
"name": "TaskId",
|
|
1703
|
+
"required": true,
|
|
1704
|
+
"type": "string"
|
|
1705
|
+
}
|
|
1706
|
+
],
|
|
1707
|
+
"type": "object"
|
|
1708
|
+
},
|
|
1709
|
+
"DescribeCloudModerationResponse": {
|
|
1710
|
+
"document": "DescribeCloudModeration response structure.",
|
|
1711
|
+
"members": [
|
|
1712
|
+
{
|
|
1713
|
+
"disabled": false,
|
|
1714
|
+
"document": "Unique ID of the moderation task, which is returned after the task is started.",
|
|
1715
|
+
"example": "123",
|
|
1716
|
+
"member": "string",
|
|
1717
|
+
"name": "TaskId",
|
|
1718
|
+
"output_required": true,
|
|
1719
|
+
"type": "string",
|
|
1720
|
+
"value_allowed_null": false
|
|
1721
|
+
},
|
|
1722
|
+
{
|
|
1723
|
+
"disabled": false,
|
|
1724
|
+
"document": "Information about the status of the cloud moderation task. Idle: indicates the current task is idle; InProgress: indicates the current task is in progress; Exited: indicates the current task is being exited.",
|
|
1725
|
+
"example": "InProgress",
|
|
1726
|
+
"member": "string",
|
|
1727
|
+
"name": "Status",
|
|
1728
|
+
"output_required": true,
|
|
1729
|
+
"type": "string",
|
|
1730
|
+
"value_allowed_null": false
|
|
1731
|
+
},
|
|
1732
|
+
{
|
|
1733
|
+
"disabled": false,
|
|
1734
|
+
"document": "Subscription blocklist and allowlist.",
|
|
1735
|
+
"example": "{\"SubscribeAudioUserIds\":[],\"UnSubscribeAudioUserIds\":[],\"SubscribeVideoUserIds\":[],\"UnSubscribeVideoUserIds\":[]}",
|
|
1736
|
+
"member": "SubscribeModerationUserIds",
|
|
1737
|
+
"name": "SubscribeStreamUserIds",
|
|
1738
|
+
"output_required": false,
|
|
1739
|
+
"type": "object",
|
|
1740
|
+
"value_allowed_null": false
|
|
1741
|
+
},
|
|
1742
|
+
{
|
|
1743
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
1744
|
+
"member": "string",
|
|
1745
|
+
"name": "RequestId",
|
|
1746
|
+
"type": "string"
|
|
1747
|
+
}
|
|
1748
|
+
],
|
|
1749
|
+
"type": "object"
|
|
1750
|
+
},
|
|
1193
1751
|
"DescribeCloudRecordingRequest": {
|
|
1194
1752
|
"document": "DescribeCloudRecording request structure.",
|
|
1195
1753
|
"members": [
|
|
@@ -1256,6 +1814,62 @@
|
|
|
1256
1814
|
],
|
|
1257
1815
|
"type": "object"
|
|
1258
1816
|
},
|
|
1817
|
+
"DescribeCloudSliceTaskRequest": {
|
|
1818
|
+
"document": "DescribeCloudSliceTask request structure.",
|
|
1819
|
+
"members": [
|
|
1820
|
+
{
|
|
1821
|
+
"disabled": false,
|
|
1822
|
+
"document": "SDKAppId of TRTC, which is the same as the SDKAppId corresponding to the recording room.",
|
|
1823
|
+
"example": "1400188366",
|
|
1824
|
+
"member": "uint64",
|
|
1825
|
+
"name": "SdkAppId",
|
|
1826
|
+
"required": true,
|
|
1827
|
+
"type": "int"
|
|
1828
|
+
},
|
|
1829
|
+
{
|
|
1830
|
+
"disabled": false,
|
|
1831
|
+
"document": "Unique ID of the slicing task, which is returned after the task is started.",
|
|
1832
|
+
"example": "-nHwX3RU7h3eZ-9PYsqd+z8I1uU1tUnbTWClW4K-xuWiN6KipeCyXJ8ZJEFpWSZ5zZuyZUAuAQ..",
|
|
1833
|
+
"member": "string",
|
|
1834
|
+
"name": "TaskId",
|
|
1835
|
+
"required": true,
|
|
1836
|
+
"type": "string"
|
|
1837
|
+
}
|
|
1838
|
+
],
|
|
1839
|
+
"type": "object"
|
|
1840
|
+
},
|
|
1841
|
+
"DescribeCloudSliceTaskResponse": {
|
|
1842
|
+
"document": "DescribeCloudSliceTask response structure.",
|
|
1843
|
+
"members": [
|
|
1844
|
+
{
|
|
1845
|
+
"disabled": false,
|
|
1846
|
+
"document": "Unique ID of the slicing task, which is returned after the task is started.",
|
|
1847
|
+
"example": "123",
|
|
1848
|
+
"member": "string",
|
|
1849
|
+
"name": "TaskId",
|
|
1850
|
+
"output_required": true,
|
|
1851
|
+
"type": "string",
|
|
1852
|
+
"value_allowed_null": false
|
|
1853
|
+
},
|
|
1854
|
+
{
|
|
1855
|
+
"disabled": false,
|
|
1856
|
+
"document": "Information about the status of the cloud slicing task. Idle: indicates the current task is idle; InProgress: indicates the current task is in progress; Exited: indicates the current task is being exited.",
|
|
1857
|
+
"example": "InProgress",
|
|
1858
|
+
"member": "string",
|
|
1859
|
+
"name": "Status",
|
|
1860
|
+
"output_required": true,
|
|
1861
|
+
"type": "string",
|
|
1862
|
+
"value_allowed_null": false
|
|
1863
|
+
},
|
|
1864
|
+
{
|
|
1865
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
1866
|
+
"member": "string",
|
|
1867
|
+
"name": "RequestId",
|
|
1868
|
+
"type": "string"
|
|
1869
|
+
}
|
|
1870
|
+
],
|
|
1871
|
+
"type": "object"
|
|
1872
|
+
},
|
|
1259
1873
|
"DescribeMixTranscodingUsageRequest": {
|
|
1260
1874
|
"document": "DescribeMixTranscodingUsage request structure.",
|
|
1261
1875
|
"members": [
|
|
@@ -2293,6 +2907,81 @@
|
|
|
2293
2907
|
],
|
|
2294
2908
|
"type": "object"
|
|
2295
2909
|
},
|
|
2910
|
+
"DescribeWebRecordRequest": {
|
|
2911
|
+
"document": "DescribeWebRecord request structure.",
|
|
2912
|
+
"members": [
|
|
2913
|
+
{
|
|
2914
|
+
"disabled": false,
|
|
2915
|
+
"document": "The task ID returned when starting web-page recording",
|
|
2916
|
+
"example": "HMLm5HWNuUAXSb0gTEOx0z1x+nLMZNjXrY3keyUSvu7uu8mF9O656uNtbUtvaWLkpMY134jTN2Ix4vuqgOJ68nQ8tho3ri",
|
|
2917
|
+
"member": "string",
|
|
2918
|
+
"name": "TaskId",
|
|
2919
|
+
"required": false,
|
|
2920
|
+
"type": "string"
|
|
2921
|
+
},
|
|
2922
|
+
{
|
|
2923
|
+
"disabled": false,
|
|
2924
|
+
"document": "SdkAppId passed when initiating web-page recording",
|
|
2925
|
+
"example": "1600011111",
|
|
2926
|
+
"member": "int64",
|
|
2927
|
+
"name": "SdkAppId",
|
|
2928
|
+
"required": false,
|
|
2929
|
+
"type": "int"
|
|
2930
|
+
},
|
|
2931
|
+
{
|
|
2932
|
+
"disabled": false,
|
|
2933
|
+
"document": "RecordId passed when initiating recording. When passing this value, you need to pass SdkAppId",
|
|
2934
|
+
"example": "record_class_1",
|
|
2935
|
+
"member": "string",
|
|
2936
|
+
"name": "RecordId",
|
|
2937
|
+
"required": false,
|
|
2938
|
+
"type": "string"
|
|
2939
|
+
}
|
|
2940
|
+
],
|
|
2941
|
+
"type": "object"
|
|
2942
|
+
},
|
|
2943
|
+
"DescribeWebRecordResponse": {
|
|
2944
|
+
"document": "DescribeWebRecord response structure.",
|
|
2945
|
+
"members": [
|
|
2946
|
+
{
|
|
2947
|
+
"disabled": false,
|
|
2948
|
+
"document": "1: Recording",
|
|
2949
|
+
"example": "1",
|
|
2950
|
+
"member": "int64",
|
|
2951
|
+
"name": "Status",
|
|
2952
|
+
"output_required": false,
|
|
2953
|
+
"type": "int",
|
|
2954
|
+
"value_allowed_null": false
|
|
2955
|
+
},
|
|
2956
|
+
{
|
|
2957
|
+
"disabled": false,
|
|
2958
|
+
"document": "Returns when querying using RecordId",
|
|
2959
|
+
"example": "HMLm5HWNuUAXSb0gTEOx0z1x+nLMZNjXrY3keyUSvu7uu8mF9O656uNtbUtvaWLkpMY134jTN2Ix4vuqgOJ68nQ8tho3ri",
|
|
2960
|
+
"member": "string",
|
|
2961
|
+
"name": "TaskId",
|
|
2962
|
+
"output_required": false,
|
|
2963
|
+
"type": "string",
|
|
2964
|
+
"value_allowed_null": false
|
|
2965
|
+
},
|
|
2966
|
+
{
|
|
2967
|
+
"disabled": false,
|
|
2968
|
+
"document": "Returned when querying using TaskId",
|
|
2969
|
+
"example": "record_class_1",
|
|
2970
|
+
"member": "string",
|
|
2971
|
+
"name": "RecordId",
|
|
2972
|
+
"output_required": false,
|
|
2973
|
+
"type": "string",
|
|
2974
|
+
"value_allowed_null": false
|
|
2975
|
+
},
|
|
2976
|
+
{
|
|
2977
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
2978
|
+
"member": "string",
|
|
2979
|
+
"name": "RequestId",
|
|
2980
|
+
"type": "string"
|
|
2981
|
+
}
|
|
2982
|
+
],
|
|
2983
|
+
"type": "object"
|
|
2984
|
+
},
|
|
2296
2985
|
"DismissRoomByStrRoomIdRequest": {
|
|
2297
2986
|
"document": "DismissRoomByStrRoomId request structure.",
|
|
2298
2987
|
"members": [
|
|
@@ -2365,6 +3054,34 @@
|
|
|
2365
3054
|
],
|
|
2366
3055
|
"type": "object"
|
|
2367
3056
|
},
|
|
3057
|
+
"EmulateMobileParams": {
|
|
3058
|
+
"document": "",
|
|
3059
|
+
"members": [
|
|
3060
|
+
{
|
|
3061
|
+
"disabled": false,
|
|
3062
|
+
"document": "",
|
|
3063
|
+
"example": "0",
|
|
3064
|
+
"member": "uint64",
|
|
3065
|
+
"name": "MobileDeviceType",
|
|
3066
|
+
"output_required": false,
|
|
3067
|
+
"required": false,
|
|
3068
|
+
"type": "int",
|
|
3069
|
+
"value_allowed_null": false
|
|
3070
|
+
},
|
|
3071
|
+
{
|
|
3072
|
+
"disabled": false,
|
|
3073
|
+
"document": "",
|
|
3074
|
+
"example": "0",
|
|
3075
|
+
"member": "uint64",
|
|
3076
|
+
"name": "ScreenOrientation",
|
|
3077
|
+
"output_required": false,
|
|
3078
|
+
"required": false,
|
|
3079
|
+
"type": "int",
|
|
3080
|
+
"value_allowed_null": false
|
|
3081
|
+
}
|
|
3082
|
+
],
|
|
3083
|
+
"usage": "both"
|
|
3084
|
+
},
|
|
2368
3085
|
"EventList": {
|
|
2369
3086
|
"document": "A list of SDK or WebRTC events.",
|
|
2370
3087
|
"members": [
|
|
@@ -2453,12 +3170,11 @@
|
|
|
2453
3170
|
{
|
|
2454
3171
|
"disabled": false,
|
|
2455
3172
|
"document": "The stream information.",
|
|
2456
|
-
"example": "
|
|
3173
|
+
"example": "{\"UserInfo\":{\"UserId\":\"user_a\",\"RoomId\":\"123456\",\"RoomIdType\":0},\"StreamType\":0}",
|
|
2457
3174
|
"member": "UserMediaStream",
|
|
2458
3175
|
"name": "UserMediaStream",
|
|
2459
3176
|
"required": true,
|
|
2460
|
-
"type": "object"
|
|
2461
|
-
"value_allowed_null": false
|
|
3177
|
+
"type": "object"
|
|
2462
3178
|
}
|
|
2463
3179
|
],
|
|
2464
3180
|
"usage": "in"
|
|
@@ -2469,32 +3185,44 @@
|
|
|
2469
3185
|
{
|
|
2470
3186
|
"disabled": false,
|
|
2471
3187
|
"document": "The audio encoding parameters.",
|
|
2472
|
-
"example": "
|
|
3188
|
+
"example": "{\"SampleRate\":48000,\"Channel\":2,\"BitRate\":64,\"Codec\":0}}",
|
|
2473
3189
|
"member": "AudioEncode",
|
|
2474
3190
|
"name": "AudioEncode",
|
|
2475
3191
|
"required": false,
|
|
2476
|
-
"type": "object"
|
|
2477
|
-
"value_allowed_null": false
|
|
3192
|
+
"type": "object"
|
|
2478
3193
|
},
|
|
2479
3194
|
{
|
|
2480
3195
|
"disabled": false,
|
|
2481
3196
|
"document": "The audio mix allowlist. For the `StartPublishCdnStream` API, if you do not pass this parameter or leave it empty, the audios of all anchors will be mixed. For the `UpdatePublishCdnStream` API, if you do not pass this parameter, no changes will be made to the current allowlist; if you pass in an empty string, the audios of all anchors will be mixed.\nIn cases where `SubscribeAudioList` and `UnSubscribeAudioList` are used at the same time, you need to specify both parameters. If you pass neither `SubscribeAudioList` nor `UnSubscribeAudioList`, no changes will be made. If a user is included in both parameters, the user’s audio will not be mixed.",
|
|
2482
|
-
"example": "
|
|
3197
|
+
"example": "[{\"UserInfo\":{\"RoomIdType\":0,\"RoomId\":\"123456\",\"UserId\":\"user_a\"}}]",
|
|
2483
3198
|
"member": "McuUserInfoParams",
|
|
2484
3199
|
"name": "SubscribeAudioList",
|
|
2485
3200
|
"required": false,
|
|
2486
|
-
"type": "list"
|
|
2487
|
-
"value_allowed_null": false
|
|
3201
|
+
"type": "list"
|
|
2488
3202
|
},
|
|
2489
3203
|
{
|
|
2490
3204
|
"disabled": false,
|
|
2491
3205
|
"document": "The audio mix blocklist. If you do not pass this parameter or leave it empty, there won’t be a blocklist. For the `UpdatePublishCdnStream` API, if you do not pass this parameter, no changes will be made to the current blocklist; if you pass in an empty string, the blocklist will be reset.\nIn cases where `SubscribeAudioList` and `UnSubscribeAudioList` are used at the same time, you need to specify both parameters. If you pass neither `SubscribeAudioList` nor `UnSubscribeAudioList`, no changes will be made. If a user is included in both parameters, the user’s audio will not be mixed.",
|
|
2492
|
-
"example": "
|
|
3206
|
+
"example": "[{\"UserInfo\":{\"UserId\":\"user_c\",\"RoomId\":\"123456\",\"RoomIdType\":1}}]",
|
|
2493
3207
|
"member": "McuUserInfoParams",
|
|
2494
3208
|
"name": "UnSubscribeAudioList",
|
|
2495
3209
|
"required": false,
|
|
2496
|
-
"type": "list"
|
|
2497
|
-
|
|
3210
|
+
"type": "list"
|
|
3211
|
+
}
|
|
3212
|
+
],
|
|
3213
|
+
"usage": "in"
|
|
3214
|
+
},
|
|
3215
|
+
"McuCloudVod": {
|
|
3216
|
+
"document": "",
|
|
3217
|
+
"members": [
|
|
3218
|
+
{
|
|
3219
|
+
"disabled": false,
|
|
3220
|
+
"document": "Tencent VOD Parameters\nExample :{\"ExpireTime\":86400}",
|
|
3221
|
+
"example": "{\"ExpireTime\":86400}",
|
|
3222
|
+
"member": "McuTencentVod",
|
|
3223
|
+
"name": "McuTencentVod",
|
|
3224
|
+
"required": false,
|
|
3225
|
+
"type": "object"
|
|
2498
3226
|
}
|
|
2499
3227
|
],
|
|
2500
3228
|
"usage": "in"
|
|
@@ -2555,8 +3283,7 @@
|
|
|
2555
3283
|
"member": "string",
|
|
2556
3284
|
"name": "RoomId",
|
|
2557
3285
|
"required": true,
|
|
2558
|
-
"type": "string"
|
|
2559
|
-
"value_allowed_null": false
|
|
3286
|
+
"type": "string"
|
|
2560
3287
|
},
|
|
2561
3288
|
{
|
|
2562
3289
|
"disabled": false,
|
|
@@ -2565,8 +3292,7 @@
|
|
|
2565
3292
|
"member": "uint64",
|
|
2566
3293
|
"name": "RoomIdType",
|
|
2567
3294
|
"required": true,
|
|
2568
|
-
"type": "int"
|
|
2569
|
-
"value_allowed_null": false
|
|
3295
|
+
"type": "int"
|
|
2570
3296
|
},
|
|
2571
3297
|
{
|
|
2572
3298
|
"disabled": false,
|
|
@@ -2575,18 +3301,16 @@
|
|
|
2575
3301
|
"member": "string",
|
|
2576
3302
|
"name": "UserId",
|
|
2577
3303
|
"required": true,
|
|
2578
|
-
"type": "string"
|
|
2579
|
-
"value_allowed_null": false
|
|
3304
|
+
"type": "string"
|
|
2580
3305
|
},
|
|
2581
3306
|
{
|
|
2582
3307
|
"disabled": false,
|
|
2583
3308
|
"document": "The signature (similar to login password) required for the relaying robot to enter the room. For information on how to calculate the signature, see [What is UserSig?](https://www.tencentcloud.com/document/product/647/38104).",
|
|
2584
|
-
"example": "
|
|
3309
|
+
"example": "eJw1zc0Ogj***kCs8k5Eg__",
|
|
2585
3310
|
"member": "string",
|
|
2586
3311
|
"name": "UserSig",
|
|
2587
3312
|
"required": true,
|
|
2588
|
-
"type": "string"
|
|
2589
|
-
"value_allowed_null": false
|
|
3313
|
+
"type": "string"
|
|
2590
3314
|
}
|
|
2591
3315
|
],
|
|
2592
3316
|
"usage": "in"
|
|
@@ -2597,7 +3321,7 @@
|
|
|
2597
3321
|
{
|
|
2598
3322
|
"disabled": false,
|
|
2599
3323
|
"document": "The information of the stream that is displayed. If you do not pass this parameter, TRTC will display the videos of anchors in the room according to their room entry sequence.",
|
|
2600
|
-
"example": "
|
|
3324
|
+
"example": "无",
|
|
2601
3325
|
"member": "UserMediaStream",
|
|
2602
3326
|
"name": "UserMediaStream",
|
|
2603
3327
|
"required": false,
|
|
@@ -2669,7 +3393,7 @@
|
|
|
2669
3393
|
{
|
|
2670
3394
|
"disabled": false,
|
|
2671
3395
|
"document": "The URL of the background image for the video. This parameter allows you to specify an image to display when the user’s camera is turned off or before the user enters the room. If the dimensions of the image specified are different from those of the video window, the image will be stretched to fit the space. This parameter has a higher priority than `BackGroundColor`.",
|
|
2672
|
-
"example": "
|
|
3396
|
+
"example": "https://***.png",
|
|
2673
3397
|
"member": "string",
|
|
2674
3398
|
"name": "BackgroundImageUrl",
|
|
2675
3399
|
"required": false,
|
|
@@ -2678,7 +3402,7 @@
|
|
|
2678
3402
|
{
|
|
2679
3403
|
"disabled": false,
|
|
2680
3404
|
"document": "Custom cropping.",
|
|
2681
|
-
"example": "
|
|
3405
|
+
"example": "无",
|
|
2682
3406
|
"member": "McuCustomCrop",
|
|
2683
3407
|
"name": "CustomCrop",
|
|
2684
3408
|
"required": false,
|
|
@@ -2706,8 +3430,7 @@
|
|
|
2706
3430
|
"member": "uint64",
|
|
2707
3431
|
"name": "MixLayoutMode",
|
|
2708
3432
|
"required": false,
|
|
2709
|
-
"type": "int"
|
|
2710
|
-
"value_allowed_null": false
|
|
3433
|
+
"type": "int"
|
|
2711
3434
|
},
|
|
2712
3435
|
{
|
|
2713
3436
|
"disabled": false,
|
|
@@ -2716,28 +3439,25 @@
|
|
|
2716
3439
|
"member": "uint64",
|
|
2717
3440
|
"name": "PureAudioHoldPlaceMode",
|
|
2718
3441
|
"required": false,
|
|
2719
|
-
"type": "int"
|
|
2720
|
-
"value_allowed_null": false
|
|
3442
|
+
"type": "int"
|
|
2721
3443
|
},
|
|
2722
3444
|
{
|
|
2723
3445
|
"disabled": false,
|
|
2724
3446
|
"document": "The details of a custom layout.",
|
|
2725
|
-
"example": "
|
|
3447
|
+
"example": "[{\"UserMediaStream\":{\"UserInfo\":{\"UserId\":\"user_a\"}},\"ImageWidth\":1920,\"ImageHeight\":1080,\"LocationX\":0,\"LocationY\":0}]",
|
|
2726
3448
|
"member": "McuLayout",
|
|
2727
3449
|
"name": "MixLayoutList",
|
|
2728
3450
|
"required": false,
|
|
2729
|
-
"type": "list"
|
|
2730
|
-
"value_allowed_null": false
|
|
3451
|
+
"type": "list"
|
|
2731
3452
|
},
|
|
2732
3453
|
{
|
|
2733
3454
|
"disabled": false,
|
|
2734
3455
|
"document": "The information of the large video in screen sharing or floating layout mode.",
|
|
2735
|
-
"example": "
|
|
3456
|
+
"example": "{\"UserMediaStream\":{\"UserInfo\":{\"UserId\":\"user_a\"}}}",
|
|
2736
3457
|
"member": "MaxVideoUser",
|
|
2737
3458
|
"name": "MaxVideoUser",
|
|
2738
3459
|
"required": false,
|
|
2739
|
-
"type": "object"
|
|
2740
|
-
"value_allowed_null": false
|
|
3460
|
+
"type": "object"
|
|
2741
3461
|
},
|
|
2742
3462
|
{
|
|
2743
3463
|
"disabled": false,
|
|
@@ -2746,8 +3466,7 @@
|
|
|
2746
3466
|
"member": "uint64",
|
|
2747
3467
|
"name": "RenderMode",
|
|
2748
3468
|
"required": false,
|
|
2749
|
-
"type": "int"
|
|
2750
|
-
"value_allowed_null": false
|
|
3469
|
+
"type": "int"
|
|
2751
3470
|
}
|
|
2752
3471
|
],
|
|
2753
3472
|
"usage": "in"
|
|
@@ -2758,12 +3477,11 @@
|
|
|
2758
3477
|
{
|
|
2759
3478
|
"disabled": false,
|
|
2760
3479
|
"document": "The application data, which will be embedded in the `app_data` field of the custom SEI. It must be shorter than 4,096 characters.",
|
|
2761
|
-
"example": "
|
|
3480
|
+
"example": "user_custom_data",
|
|
2762
3481
|
"member": "string",
|
|
2763
3482
|
"name": "AppData",
|
|
2764
3483
|
"required": false,
|
|
2765
|
-
"type": "string"
|
|
2766
|
-
"value_allowed_null": false
|
|
3484
|
+
"type": "string"
|
|
2767
3485
|
},
|
|
2768
3486
|
{
|
|
2769
3487
|
"disabled": false,
|
|
@@ -2772,8 +3490,58 @@
|
|
|
2772
3490
|
"member": "uint64",
|
|
2773
3491
|
"name": "PayloadType",
|
|
2774
3492
|
"required": false,
|
|
2775
|
-
"type": "int"
|
|
2776
|
-
|
|
3493
|
+
"type": "int"
|
|
3494
|
+
},
|
|
3495
|
+
{
|
|
3496
|
+
"disabled": false,
|
|
3497
|
+
"document": "The SEI sending interval (milliseconds). The default value is 1000.",
|
|
3498
|
+
"example": "1000",
|
|
3499
|
+
"member": "uint64",
|
|
3500
|
+
"name": "Interval",
|
|
3501
|
+
"required": false,
|
|
3502
|
+
"type": "int"
|
|
3503
|
+
},
|
|
3504
|
+
{
|
|
3505
|
+
"disabled": false,
|
|
3506
|
+
"document": "Valid values: `1`: SEI is guaranteed when keyframes are sent; `0` (default): SEI is not guaranteed when keyframes are sent.",
|
|
3507
|
+
"example": "0",
|
|
3508
|
+
"member": "uint64",
|
|
3509
|
+
"name": "FollowIdr",
|
|
3510
|
+
"required": false,
|
|
3511
|
+
"type": "int"
|
|
3512
|
+
}
|
|
3513
|
+
],
|
|
3514
|
+
"usage": "in"
|
|
3515
|
+
},
|
|
3516
|
+
"McuPassThrough": {
|
|
3517
|
+
"document": "The custom pass-through SEI.",
|
|
3518
|
+
"members": [
|
|
3519
|
+
{
|
|
3520
|
+
"disabled": false,
|
|
3521
|
+
"document": "The payload of the pass-through SEI.",
|
|
3522
|
+
"example": "user_custom_data",
|
|
3523
|
+
"member": "string",
|
|
3524
|
+
"name": "PayloadContent",
|
|
3525
|
+
"required": true,
|
|
3526
|
+
"type": "string"
|
|
3527
|
+
},
|
|
3528
|
+
{
|
|
3529
|
+
"disabled": false,
|
|
3530
|
+
"document": "The payload type of the SEI message. Value range: 5 and 100-254 (244 is used internally by Tencent Cloud for timestamps).",
|
|
3531
|
+
"example": "101",
|
|
3532
|
+
"member": "uint64",
|
|
3533
|
+
"name": "PayloadType",
|
|
3534
|
+
"required": true,
|
|
3535
|
+
"type": "int"
|
|
3536
|
+
},
|
|
3537
|
+
{
|
|
3538
|
+
"disabled": false,
|
|
3539
|
+
"document": "This parameter is required only if `PayloadType` is 5. It must be a 32-character hexadecimal string. If `PayloadType` is not 5, this parameter will be ignored.",
|
|
3540
|
+
"example": "aaaaaaaabbbbbbbbccccccccdddddddd",
|
|
3541
|
+
"member": "string",
|
|
3542
|
+
"name": "PayloadUuid",
|
|
3543
|
+
"required": false,
|
|
3544
|
+
"type": "string"
|
|
2777
3545
|
},
|
|
2778
3546
|
{
|
|
2779
3547
|
"disabled": false,
|
|
@@ -2782,119 +3550,235 @@
|
|
|
2782
3550
|
"member": "uint64",
|
|
2783
3551
|
"name": "Interval",
|
|
2784
3552
|
"required": false,
|
|
2785
|
-
"type": "int"
|
|
2786
|
-
|
|
3553
|
+
"type": "int"
|
|
3554
|
+
},
|
|
3555
|
+
{
|
|
3556
|
+
"disabled": false,
|
|
3557
|
+
"document": "Valid values: `1`: SEI is guaranteed when keyframes are sent; `0` (default): SEI is not guaranteed when keyframes are sent.",
|
|
3558
|
+
"example": "0",
|
|
3559
|
+
"member": "uint64",
|
|
3560
|
+
"name": "FollowIdr",
|
|
3561
|
+
"required": false,
|
|
3562
|
+
"type": "int"
|
|
3563
|
+
}
|
|
3564
|
+
],
|
|
3565
|
+
"usage": "in"
|
|
3566
|
+
},
|
|
3567
|
+
"McuPublishCdnParam": {
|
|
3568
|
+
"document": "The relaying parameters.",
|
|
3569
|
+
"members": [
|
|
3570
|
+
{
|
|
3571
|
+
"disabled": false,
|
|
3572
|
+
"document": "The URLs of the CDNs to relay to.",
|
|
3573
|
+
"example": "rtmp://***&txTime=686F7239",
|
|
3574
|
+
"member": "string",
|
|
3575
|
+
"name": "PublishCdnUrl",
|
|
3576
|
+
"required": true,
|
|
3577
|
+
"type": "string"
|
|
3578
|
+
},
|
|
3579
|
+
{
|
|
3580
|
+
"disabled": false,
|
|
3581
|
+
"document": "Whether to relay to Tencent Cloud’s CDN. `0`: Third-party CDN; `1` (default): Tencent Cloud’s CDN. Relaying to a third-party CDN will incur fees. To avoid unexpected charges, we recommend you pass in a specific value. For details, see the API document.",
|
|
3582
|
+
"example": "1",
|
|
3583
|
+
"member": "uint64",
|
|
3584
|
+
"name": "IsTencentCdn",
|
|
3585
|
+
"required": false,
|
|
3586
|
+
"type": "int"
|
|
3587
|
+
}
|
|
3588
|
+
],
|
|
3589
|
+
"usage": "in"
|
|
3590
|
+
},
|
|
3591
|
+
"McuRecordParams": {
|
|
3592
|
+
"document": "Relay Recording Parameters",
|
|
3593
|
+
"members": [
|
|
3594
|
+
{
|
|
3595
|
+
"disabled": false,
|
|
3596
|
+
"document": "Relay Recording Mode\n0/blank: Not currently supported, behavior undefined.\n1: Disable recording.\n2: Start recording (uses console's auto-recording template parameters. Reference: [Link to Documentation]).\n3: Start recording (uses API-specified parameters).\nExample: 2",
|
|
3597
|
+
"example": "2",
|
|
3598
|
+
"member": "uint64",
|
|
3599
|
+
"name": "UniRecord",
|
|
3600
|
+
"required": false,
|
|
3601
|
+
"type": "int"
|
|
3602
|
+
},
|
|
3603
|
+
{
|
|
3604
|
+
"disabled": false,
|
|
3605
|
+
"document": "Recording Task Key\nIdentifies a recording task. This parameter allows merging multiple relay tasks into one recording file. If unspecified, only records the current relay task.\n[Format: Up to 128 bytes; only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-).]\nExample: test_record_key_a",
|
|
3606
|
+
"example": "test_recore_key_a",
|
|
3607
|
+
"member": "string",
|
|
3608
|
+
"name": "RecordKey",
|
|
3609
|
+
"required": false,
|
|
3610
|
+
"type": "string"
|
|
3611
|
+
},
|
|
3612
|
+
{
|
|
3613
|
+
"disabled": false,
|
|
3614
|
+
"document": "[Valid only when UniRecord=3]\nRecording Resume Wait Time\nCorresponds to template parameter \"Resume Wait Duration.\" Unit: seconds.\nRange: 5-86400 (24 hours). Default: 30. Recording stops if idle longer than this value.\nExample: 30",
|
|
3615
|
+
"example": "30",
|
|
3616
|
+
"member": "uint64",
|
|
3617
|
+
"name": "RecordWaitTime",
|
|
3618
|
+
"required": false,
|
|
3619
|
+
"type": "int"
|
|
3620
|
+
},
|
|
3621
|
+
{
|
|
3622
|
+
"disabled": false,
|
|
3623
|
+
"document": "[Valid only when UniRecord=3]\nRecording Output Formats\nCorresponds to template parameter \"File Format.\" Supported values: hls, mp4, aac. Default: mp4.\nNote: mp4 and aac formats are mutually exclusive.\nExample (MP4 only): [\"mp4\"]\nExample (MP4 + HLS): [\"mp4\",\"hls\"]",
|
|
3624
|
+
"example": "[\"mp4\",\"hls\"]",
|
|
3625
|
+
"member": "string",
|
|
3626
|
+
"name": "RecordFormat",
|
|
3627
|
+
"required": false,
|
|
3628
|
+
"type": "list"
|
|
3629
|
+
},
|
|
3630
|
+
{
|
|
3631
|
+
"disabled": false,
|
|
3632
|
+
"document": "[Valid only when UniRecord=3]\nSingle File Duration\nCorresponds to template parameter \"Max File Duration.\" Unit: minutes.\nRange: 1-1440 (24 hours). Default: 1440. Applies only to mp4/aac. Actual duration is capped at 2GB file size.\nExample: 1440",
|
|
3633
|
+
"example": "1440",
|
|
3634
|
+
"member": "uint64",
|
|
3635
|
+
"name": "MaxMediaFileDuration",
|
|
3636
|
+
"required": false,
|
|
3637
|
+
"type": "int"
|
|
3638
|
+
},
|
|
3639
|
+
{
|
|
3640
|
+
"disabled": false,
|
|
3641
|
+
"document": "[Valid only when UniRecord=3]\nRecording Media Type\nCorresponds to template parameter \"Recording Format.\"\n0: Audio+Video, 1: Audio only, 2: Video only. Output is the intersection of this setting and relay content.\nExample: 0",
|
|
3642
|
+
"example": "0",
|
|
3643
|
+
"member": "uint64",
|
|
3644
|
+
"name": "StreamType",
|
|
3645
|
+
"required": false,
|
|
3646
|
+
"type": "int"
|
|
3647
|
+
},
|
|
3648
|
+
{
|
|
3649
|
+
"disabled": false,
|
|
3650
|
+
"document": "Recording Filename Prefix\nFilename prefix (<=64 bytes). Applies only to VOD storage.\n*Format: Letters (a-z, A-Z), numbers (0-9), underscores (_), hyphens (-).*\nExample: mcu_record_prefix",
|
|
3651
|
+
"example": "mcu_record_prefix",
|
|
3652
|
+
"member": "string",
|
|
3653
|
+
"name": "UserDefineRecordPrefix",
|
|
3654
|
+
"required": false,
|
|
3655
|
+
"type": "string"
|
|
3656
|
+
},
|
|
3657
|
+
{
|
|
3658
|
+
"disabled": false,
|
|
3659
|
+
"document": "[Valid only when UniRecord=3]\nRecording Storage Parameters\nCorresponds to console parameter \"Storage Location.\" Supports Tencent VOD or COS (exclusively).\nExample: {\"McuCloudVod\":{\"McuTencentVod\":{\"ExpireTime\":86400}}}",
|
|
3660
|
+
"example": "{\"McuCloudVod\":{\"McuTencentVod\":{\"ExpireTime\":86400}}}",
|
|
3661
|
+
"member": "McuStorageParams",
|
|
3662
|
+
"name": "McuStorageParams",
|
|
3663
|
+
"required": false,
|
|
3664
|
+
"type": "object"
|
|
3665
|
+
}
|
|
3666
|
+
],
|
|
3667
|
+
"usage": "in"
|
|
3668
|
+
},
|
|
3669
|
+
"McuSeiParams": {
|
|
3670
|
+
"document": "The stream mixing SEI parameters.",
|
|
3671
|
+
"members": [
|
|
3672
|
+
{
|
|
3673
|
+
"disabled": false,
|
|
3674
|
+
"document": "The audio volume layout SEI.",
|
|
3675
|
+
"example": "{\"PayloadType\":243,\"FollowIdr\":1}",
|
|
3676
|
+
"member": "McuLayoutVolume",
|
|
3677
|
+
"name": "LayoutVolume",
|
|
3678
|
+
"required": false,
|
|
3679
|
+
"type": "object"
|
|
3680
|
+
},
|
|
3681
|
+
{
|
|
3682
|
+
"disabled": false,
|
|
3683
|
+
"document": "The pass-through SEI.",
|
|
3684
|
+
"example": "{\"PayloadContent\":\"user_custom_data\",\"PayloadType\":108,\"Interval\":2000,\"FollowIdr\":1}",
|
|
3685
|
+
"member": "McuPassThrough",
|
|
3686
|
+
"name": "PassThrough",
|
|
3687
|
+
"required": false,
|
|
3688
|
+
"type": "object"
|
|
3689
|
+
}
|
|
3690
|
+
],
|
|
3691
|
+
"usage": "in"
|
|
3692
|
+
},
|
|
3693
|
+
"McuStorageParams": {
|
|
3694
|
+
"document": "",
|
|
3695
|
+
"members": [
|
|
3696
|
+
{
|
|
3697
|
+
"disabled": false,
|
|
3698
|
+
"document": "Third-Party Cloud Storage Account Information\n(Note: Storing files in Object Storage COS will incur recording file delivery fees. For details, see [Cloud Recording Billing]. Storing in VOD does not incur this fee.)\nExample:{\"Vendor\":0,\"Region\":\"ap-shanghai\",\"Bucket\":\"*\",\"AccessKey\":\"*\",\"SecretKey\":\"***\",\"FileNamePrefix\":[\"mcu_record\"]}",
|
|
3699
|
+
"example": "{\"Vendor\":0,\"Region\":\"ap-shanghai\",\"Bucket\":\"***\",\"AccessKey\":\"***\",\"SecretKey\":\"***\",\"FileNamePrefix\":[\"mcu_record\"]}",
|
|
3700
|
+
"member": "CloudStorage",
|
|
3701
|
+
"name": "CloudStorage",
|
|
3702
|
+
"required": false,
|
|
3703
|
+
"type": "object"
|
|
2787
3704
|
},
|
|
2788
3705
|
{
|
|
2789
3706
|
"disabled": false,
|
|
2790
|
-
"document": "
|
|
2791
|
-
"example": "
|
|
2792
|
-
"member": "
|
|
2793
|
-
"name": "
|
|
3707
|
+
"document": "Tencent Cloud VOD Account Information\nExample:{\"McuTencentVod\":{\"ExpireTime\":86400}}",
|
|
3708
|
+
"example": "{\"McuTencentVod\":{\"ExpireTime\":86400}}",
|
|
3709
|
+
"member": "McuCloudVod",
|
|
3710
|
+
"name": "McuCloudVod",
|
|
2794
3711
|
"required": false,
|
|
2795
|
-
"type": "
|
|
2796
|
-
"value_allowed_null": true
|
|
3712
|
+
"type": "object"
|
|
2797
3713
|
}
|
|
2798
3714
|
],
|
|
2799
3715
|
"usage": "in"
|
|
2800
3716
|
},
|
|
2801
|
-
"
|
|
2802
|
-
"document": "
|
|
3717
|
+
"McuTencentVod": {
|
|
3718
|
+
"document": "Mcu Relay Recording and Tencent VOD Parameters",
|
|
2803
3719
|
"members": [
|
|
2804
3720
|
{
|
|
2805
3721
|
"disabled": false,
|
|
2806
|
-
"document": "
|
|
2807
|
-
"example": "
|
|
3722
|
+
"document": "Post-Upload Task Processing\nAutomatically initiates task flows after media uploads complete. Value = Task flow template name.\nVOD supports creating and naming task flow templates.\nExample: template_name",
|
|
3723
|
+
"example": "template_name",
|
|
2808
3724
|
"member": "string",
|
|
2809
|
-
"name": "
|
|
2810
|
-
"required":
|
|
3725
|
+
"name": "Procedure",
|
|
3726
|
+
"required": false,
|
|
2811
3727
|
"type": "string"
|
|
2812
3728
|
},
|
|
2813
3729
|
{
|
|
2814
3730
|
"disabled": false,
|
|
2815
|
-
"document": "
|
|
2816
|
-
"example": "
|
|
3731
|
+
"document": "Media File Expiration Time\nAbsolute expiration time from current timestamp.\n86400 = 1 day retention\n0 = permanent storage (default)\nExample: 86400",
|
|
3732
|
+
"example": "86400",
|
|
2817
3733
|
"member": "uint64",
|
|
2818
|
-
"name": "
|
|
2819
|
-
"required":
|
|
3734
|
+
"name": "ExpireTime",
|
|
3735
|
+
"required": false,
|
|
2820
3736
|
"type": "int"
|
|
2821
3737
|
},
|
|
2822
3738
|
{
|
|
2823
3739
|
"disabled": false,
|
|
2824
|
-
"document": "
|
|
2825
|
-
"example": "
|
|
3740
|
+
"document": "Upload Region Specification\nFor users requiring specific upload regions.\nExample: ap-shanghai",
|
|
3741
|
+
"example": "ap-shanghai",
|
|
2826
3742
|
"member": "string",
|
|
2827
|
-
"name": "
|
|
3743
|
+
"name": "StorageRegion",
|
|
2828
3744
|
"required": false,
|
|
2829
3745
|
"type": "string"
|
|
2830
3746
|
},
|
|
2831
3747
|
{
|
|
2832
3748
|
"disabled": false,
|
|
2833
|
-
"document": "
|
|
2834
|
-
"example": "
|
|
3749
|
+
"document": "Category ID\nManages media classification. Obtain via category creation API.\nDefault: 0 (Other category)\nExample: 0",
|
|
3750
|
+
"example": "0",
|
|
2835
3751
|
"member": "uint64",
|
|
2836
|
-
"name": "
|
|
3752
|
+
"name": "ClassId",
|
|
2837
3753
|
"required": false,
|
|
2838
3754
|
"type": "int"
|
|
2839
3755
|
},
|
|
2840
3756
|
{
|
|
2841
3757
|
"disabled": false,
|
|
2842
|
-
"document": "
|
|
3758
|
+
"document": "VOD SubAppId\nRequired when accessing sub-application resources. Leave empty otherwise.\nExample: 0",
|
|
2843
3759
|
"example": "0",
|
|
2844
3760
|
"member": "uint64",
|
|
2845
|
-
"name": "
|
|
3761
|
+
"name": "SubAppId",
|
|
2846
3762
|
"required": false,
|
|
2847
3763
|
"type": "int"
|
|
2848
|
-
}
|
|
2849
|
-
],
|
|
2850
|
-
"usage": "in"
|
|
2851
|
-
},
|
|
2852
|
-
"McuPublishCdnParam": {
|
|
2853
|
-
"document": "The relaying parameters.",
|
|
2854
|
-
"members": [
|
|
2855
|
-
{
|
|
2856
|
-
"disabled": false,
|
|
2857
|
-
"document": "The URLs of the CDNs to relay to.",
|
|
2858
|
-
"example": "xxxx",
|
|
2859
|
-
"member": "string",
|
|
2860
|
-
"name": "PublishCdnUrl",
|
|
2861
|
-
"required": true,
|
|
2862
|
-
"type": "string"
|
|
2863
3764
|
},
|
|
2864
3765
|
{
|
|
2865
3766
|
"disabled": false,
|
|
2866
|
-
"document": "
|
|
2867
|
-
"example": "
|
|
2868
|
-
"member": "
|
|
2869
|
-
"name": "
|
|
2870
|
-
"required": false,
|
|
2871
|
-
"type": "int"
|
|
2872
|
-
}
|
|
2873
|
-
],
|
|
2874
|
-
"usage": "in"
|
|
2875
|
-
},
|
|
2876
|
-
"McuSeiParams": {
|
|
2877
|
-
"document": "The stream mixing SEI parameters.",
|
|
2878
|
-
"members": [
|
|
2879
|
-
{
|
|
2880
|
-
"disabled": false,
|
|
2881
|
-
"document": "The audio volume layout SEI.",
|
|
2882
|
-
"example": "LayoutVolume",
|
|
2883
|
-
"member": "McuLayoutVolume",
|
|
2884
|
-
"name": "LayoutVolume",
|
|
3767
|
+
"document": "Task Flow Context\nPassed through in task completion callbacks.\nExample: user_custom",
|
|
3768
|
+
"example": "user_custom",
|
|
3769
|
+
"member": "string",
|
|
3770
|
+
"name": "SessionContext",
|
|
2885
3771
|
"required": false,
|
|
2886
|
-
"type": "
|
|
2887
|
-
"value_allowed_null": false
|
|
3772
|
+
"type": "string"
|
|
2888
3773
|
},
|
|
2889
3774
|
{
|
|
2890
3775
|
"disabled": false,
|
|
2891
|
-
"document": "
|
|
2892
|
-
"example": "
|
|
2893
|
-
"member": "
|
|
2894
|
-
"name": "
|
|
3776
|
+
"document": "Upload Context\nPassed through in upload completion callbacks.\nExample: user_custom",
|
|
3777
|
+
"example": "user_custom",
|
|
3778
|
+
"member": "string",
|
|
3779
|
+
"name": "SourceContext",
|
|
2895
3780
|
"required": false,
|
|
2896
|
-
"type": "
|
|
2897
|
-
"value_allowed_null": false
|
|
3781
|
+
"type": "string"
|
|
2898
3782
|
}
|
|
2899
3783
|
],
|
|
2900
3784
|
"usage": "in"
|
|
@@ -2905,7 +3789,7 @@
|
|
|
2905
3789
|
{
|
|
2906
3790
|
"disabled": false,
|
|
2907
3791
|
"document": "The user information.",
|
|
2908
|
-
"example": "
|
|
3792
|
+
"example": "{\"UserId\": \"user_a\",\"RoomId\": \"123456\",\"RoomIdType\": 0}",
|
|
2909
3793
|
"member": "MixUserInfo",
|
|
2910
3794
|
"name": "UserInfo",
|
|
2911
3795
|
"required": true,
|
|
@@ -2920,7 +3804,7 @@
|
|
|
2920
3804
|
{
|
|
2921
3805
|
"disabled": false,
|
|
2922
3806
|
"document": "The video encoding parameters.",
|
|
2923
|
-
"example": "
|
|
3807
|
+
"example": "无",
|
|
2924
3808
|
"member": "VideoEncode",
|
|
2925
3809
|
"name": "VideoEncode",
|
|
2926
3810
|
"required": false,
|
|
@@ -2929,7 +3813,7 @@
|
|
|
2929
3813
|
{
|
|
2930
3814
|
"disabled": false,
|
|
2931
3815
|
"document": "The layout parameters.",
|
|
2932
|
-
"example": "
|
|
3816
|
+
"example": "无",
|
|
2933
3817
|
"member": "McuLayoutParams",
|
|
2934
3818
|
"name": "LayoutParams",
|
|
2935
3819
|
"required": false,
|
|
@@ -2947,7 +3831,7 @@
|
|
|
2947
3831
|
{
|
|
2948
3832
|
"disabled": false,
|
|
2949
3833
|
"document": "The URL of the background image for the canvas. This parameter has a higher priority than `BackGroundColor`.",
|
|
2950
|
-
"example": "
|
|
3834
|
+
"example": "https://******.png",
|
|
2951
3835
|
"member": "string",
|
|
2952
3836
|
"name": "BackgroundImageUrl",
|
|
2953
3837
|
"required": false,
|
|
@@ -2956,7 +3840,7 @@
|
|
|
2956
3840
|
{
|
|
2957
3841
|
"disabled": false,
|
|
2958
3842
|
"document": "The watermark information for the mixed stream.",
|
|
2959
|
-
"example": "
|
|
3843
|
+
"example": "无",
|
|
2960
3844
|
"member": "McuWaterMarkParams",
|
|
2961
3845
|
"name": "WaterMarkList",
|
|
2962
3846
|
"required": false,
|
|
@@ -3049,7 +3933,7 @@
|
|
|
3049
3933
|
{
|
|
3050
3934
|
"disabled": false,
|
|
3051
3935
|
"document": "The watermark image information. This parameter is required if `WaterMarkType` is 0.",
|
|
3052
|
-
"example": "
|
|
3936
|
+
"example": "{\"WaterMarkUrl\": \"http://your_picture.png\",\"WaterMarkWidth\": 150,\"WaterMarkHeight\": 90,\"LocationX\": 0,\"LocationY\": 0,\"ZOrder\": 20}",
|
|
3053
3937
|
"member": "McuWaterMarkImage",
|
|
3054
3938
|
"name": "WaterMarkImage",
|
|
3055
3939
|
"required": false,
|
|
@@ -3058,7 +3942,7 @@
|
|
|
3058
3942
|
{
|
|
3059
3943
|
"disabled": false,
|
|
3060
3944
|
"document": "The text watermark configuration. This parameter is required if `WaterMarkType` is `1`.",
|
|
3061
|
-
"example": "
|
|
3945
|
+
"example": "{\"Text\": \"主持人\",\"WaterMarkWidth\": 54,\"WaterMarkHeight\": 18,\"LocationX\": 80,\"LocationY\": 80,\"FontSize\": 18,\"DynamicPosType\": 0}",
|
|
3062
3946
|
"member": "McuWaterMarkText",
|
|
3063
3947
|
"name": "WaterMarkText",
|
|
3064
3948
|
"required": false,
|
|
@@ -3073,7 +3957,7 @@
|
|
|
3073
3957
|
{
|
|
3074
3958
|
"disabled": false,
|
|
3075
3959
|
"document": "The text.",
|
|
3076
|
-
"example": "\"
|
|
3960
|
+
"example": "\"主持人\"",
|
|
3077
3961
|
"member": "string",
|
|
3078
3962
|
"name": "Text",
|
|
3079
3963
|
"required": true,
|
|
@@ -3392,49 +4276,257 @@
|
|
|
3392
4276
|
},
|
|
3393
4277
|
{
|
|
3394
4278
|
"disabled": false,
|
|
3395
|
-
"document": "The audio transcoding parameters for recording. If you set this parameter, you must specify all its fields. If you do not set it, the default will be used.",
|
|
3396
|
-
"example": "无",
|
|
3397
|
-
"member": "AudioParams",
|
|
3398
|
-
"name": "AudioParams",
|
|
4279
|
+
"document": "The audio transcoding parameters for recording. If you set this parameter, you must specify all its fields. If you do not set it, the default will be used.",
|
|
4280
|
+
"example": "无",
|
|
4281
|
+
"member": "AudioParams",
|
|
4282
|
+
"name": "AudioParams",
|
|
4283
|
+
"required": false,
|
|
4284
|
+
"type": "object",
|
|
4285
|
+
"value_allowed_null": false
|
|
4286
|
+
}
|
|
4287
|
+
],
|
|
4288
|
+
"usage": "in"
|
|
4289
|
+
},
|
|
4290
|
+
"MixUserInfo": {
|
|
4291
|
+
"document": "The user information.",
|
|
4292
|
+
"members": [
|
|
4293
|
+
{
|
|
4294
|
+
"disabled": false,
|
|
4295
|
+
"document": "User ID.",
|
|
4296
|
+
"example": "user_a",
|
|
4297
|
+
"member": "string",
|
|
4298
|
+
"name": "UserId",
|
|
4299
|
+
"required": true,
|
|
4300
|
+
"type": "string"
|
|
4301
|
+
},
|
|
4302
|
+
{
|
|
4303
|
+
"disabled": false,
|
|
4304
|
+
"document": "If a dynamic layout is used, the value of this parameter should be the ID of the main room. If a custom layout is used, the value of this parameter should be the same as the room ID in `MixLayoutList`.",
|
|
4305
|
+
"example": "room_123456",
|
|
4306
|
+
"member": "string",
|
|
4307
|
+
"name": "RoomId",
|
|
4308
|
+
"required": false,
|
|
4309
|
+
"type": "string"
|
|
4310
|
+
},
|
|
4311
|
+
{
|
|
4312
|
+
"disabled": false,
|
|
4313
|
+
"document": "The type of the `RoomId` parameter. 0: integer; 1: string.",
|
|
4314
|
+
"example": "1",
|
|
4315
|
+
"member": "uint64",
|
|
4316
|
+
"name": "RoomIdType",
|
|
4317
|
+
"required": false,
|
|
4318
|
+
"type": "int"
|
|
4319
|
+
}
|
|
4320
|
+
],
|
|
4321
|
+
"usage": "in"
|
|
4322
|
+
},
|
|
4323
|
+
"ModerationParams": {
|
|
4324
|
+
"document": "Control parameters for cloud moderation.",
|
|
4325
|
+
"members": [
|
|
4326
|
+
{
|
|
4327
|
+
"disabled": false,
|
|
4328
|
+
"document": "Moderation task type. 1: audio slicing moderation; 2: video frame extraction moderation; 3: audio slicing moderation + video frame extraction moderation; 4: audio stream moderation; 5: audio stream moderation + video frame extraction moderation. The default value is 1. (Support from suppliers is required for stream moderation to take effect.)",
|
|
4329
|
+
"example": "1",
|
|
4330
|
+
"member": "uint64",
|
|
4331
|
+
"name": "ModerationType",
|
|
4332
|
+
"required": false,
|
|
4333
|
+
"type": "int"
|
|
4334
|
+
},
|
|
4335
|
+
{
|
|
4336
|
+
"disabled": false,
|
|
4337
|
+
"document": "Slicing is stopped automatically when there is no user (anchor) performing upstream push in the room for more than MaxIdleTime. Unit: seconds. Default value: 30 seconds. This value needs to be greater than or equal to 5 seconds and less than or equal to 1800 seconds (0.5 hours). Example value: 30.",
|
|
4338
|
+
"example": "30",
|
|
4339
|
+
"member": "uint64",
|
|
4340
|
+
"name": "MaxIdleTime",
|
|
4341
|
+
"required": false,
|
|
4342
|
+
"type": "int"
|
|
4343
|
+
},
|
|
4344
|
+
{
|
|
4345
|
+
"disabled": false,
|
|
4346
|
+
"document": "Audio slicing duration. Default value: 15s. Example value: 15.",
|
|
4347
|
+
"example": "15",
|
|
4348
|
+
"member": "uint64",
|
|
4349
|
+
"name": "SliceAudio",
|
|
4350
|
+
"required": false,
|
|
4351
|
+
"type": "int"
|
|
4352
|
+
},
|
|
4353
|
+
{
|
|
4354
|
+
"disabled": false,
|
|
4355
|
+
"document": "Interval for video frame extraction. Default value: 5s.",
|
|
4356
|
+
"example": "5",
|
|
4357
|
+
"member": "uint64",
|
|
4358
|
+
"name": "SliceVideo",
|
|
4359
|
+
"required": false,
|
|
4360
|
+
"type": "int"
|
|
4361
|
+
},
|
|
4362
|
+
{
|
|
4363
|
+
"disabled": false,
|
|
4364
|
+
"document": "Enumeration values for suppliers.\ntianyu: Tencent Tianyu content security. (Valid values: 1: audio slicing moderation; 2: video frame extraction moderation; 3: audio-visual slicing moderation + video frame extraction moderation.)\nace: ACE content security. (Valid values: 1: audio slicing moderation; 2: video frame extraction moderation; 3: audio-visual slicing moderation + video frame extraction moderation.)\nshumei: shumei moderation. (Valid values: 1: audio slicing moderation; 2: video frame extraction moderation; 3: audio-visual slicing moderation + video frame extraction moderation.)\nYidun: NetEase Yidun moderation. (Valid values: 1: audio slicing moderation; 2: video frame extraction moderation; 3: audio-visual slicing moderation + video frame extraction moderation.)",
|
|
4365
|
+
"example": "ace",
|
|
4366
|
+
"member": "string",
|
|
4367
|
+
"name": "ModerationSupplier",
|
|
4368
|
+
"required": false,
|
|
4369
|
+
"type": "string"
|
|
4370
|
+
},
|
|
4371
|
+
{
|
|
4372
|
+
"disabled": false,
|
|
4373
|
+
"document": "Configuration information required for submitting content to the third-party moderation supplier.",
|
|
4374
|
+
"example": "无",
|
|
4375
|
+
"member": "ModerationSupplierParam",
|
|
4376
|
+
"name": "ModerationSupplierParam",
|
|
4377
|
+
"required": false,
|
|
4378
|
+
"type": "object"
|
|
4379
|
+
},
|
|
4380
|
+
{
|
|
4381
|
+
"disabled": false,
|
|
4382
|
+
"document": "Whether to save file. 0: not save by default; 1: save; 2 save the hit file.",
|
|
4383
|
+
"example": "0",
|
|
4384
|
+
"member": "uint64",
|
|
4385
|
+
"name": "SaveModerationFile",
|
|
4386
|
+
"required": false,
|
|
4387
|
+
"type": "int"
|
|
4388
|
+
},
|
|
4389
|
+
{
|
|
4390
|
+
"disabled": false,
|
|
4391
|
+
"document": "Whether to call back all moderation results: \u000b0: call back all results by default; \u000b1: only call back hit results.",
|
|
4392
|
+
"example": "0",
|
|
4393
|
+
"member": "uint64",
|
|
4394
|
+
"name": "CallbackAllResults",
|
|
4395
|
+
"required": false,
|
|
4396
|
+
"type": "int"
|
|
4397
|
+
},
|
|
4398
|
+
{
|
|
4399
|
+
"disabled": false,
|
|
4400
|
+
"document": "Specifies the allowlist or blocklist for the subscription stream.",
|
|
4401
|
+
"example": "无",
|
|
4402
|
+
"member": "SubscribeModerationUserIds",
|
|
4403
|
+
"name": "SubscribeStreamUserIds",
|
|
4404
|
+
"required": false,
|
|
4405
|
+
"type": "object"
|
|
4406
|
+
}
|
|
4407
|
+
],
|
|
4408
|
+
"usage": "in"
|
|
4409
|
+
},
|
|
4410
|
+
"ModerationStorageParams": {
|
|
4411
|
+
"document": "Moderation file storage parameters.",
|
|
4412
|
+
"members": [
|
|
4413
|
+
{
|
|
4414
|
+
"disabled": false,
|
|
4415
|
+
"document": "Information about Tencent COS and third-party cloud storage accounts.",
|
|
4416
|
+
"example": "无",
|
|
4417
|
+
"member": "CloudModerationStorage",
|
|
4418
|
+
"name": "CloudModerationStorage",
|
|
4419
|
+
"required": false,
|
|
4420
|
+
"type": "object"
|
|
4421
|
+
}
|
|
4422
|
+
],
|
|
4423
|
+
"usage": "in"
|
|
4424
|
+
},
|
|
4425
|
+
"ModerationSupplierParam": {
|
|
4426
|
+
"document": "Parameters required for submitting content to the third-party moderation supplier.",
|
|
4427
|
+
"members": [
|
|
4428
|
+
{
|
|
4429
|
+
"disabled": false,
|
|
4430
|
+
"document": "Moderation supplier account ID. For Tencent Tianyu, the value is not null; for NETEASE Yidun, the value is null.",
|
|
4431
|
+
"example": "\"24189\"",
|
|
4432
|
+
"member": "string",
|
|
4433
|
+
"name": "AppID",
|
|
4434
|
+
"required": false,
|
|
4435
|
+
"type": "string"
|
|
4436
|
+
},
|
|
4437
|
+
{
|
|
4438
|
+
"disabled": false,
|
|
4439
|
+
"document": "Moderation supplier key ID.",
|
|
4440
|
+
"example": "\"ace_ugc_20521\"",
|
|
4441
|
+
"member": "string",
|
|
4442
|
+
"name": "SecretId",
|
|
4443
|
+
"required": false,
|
|
4444
|
+
"type": "string"
|
|
4445
|
+
},
|
|
4446
|
+
{
|
|
4447
|
+
"disabled": false,
|
|
4448
|
+
"document": "Moderation supplier key.",
|
|
4449
|
+
"example": "\"637ae34f4069afb92e9c6a799b36xxxx\"",
|
|
4450
|
+
"member": "string",
|
|
4451
|
+
"name": "SecretKey",
|
|
4452
|
+
"required": false,
|
|
4453
|
+
"type": "string"
|
|
4454
|
+
},
|
|
4455
|
+
{
|
|
4456
|
+
"disabled": false,
|
|
4457
|
+
"document": "Audio scenario. Policy ID or businessId.",
|
|
4458
|
+
"example": "\"2001\"",
|
|
4459
|
+
"member": "string",
|
|
4460
|
+
"name": "AudioBizType",
|
|
4461
|
+
"required": false,
|
|
4462
|
+
"type": "string"
|
|
4463
|
+
},
|
|
4464
|
+
{
|
|
4465
|
+
"disabled": false,
|
|
4466
|
+
"document": "Image scenario. Policy ID or businessId.",
|
|
4467
|
+
"example": "\"2001\"",
|
|
4468
|
+
"member": "string",
|
|
4469
|
+
"name": "ImageBizType",
|
|
4470
|
+
"required": false,
|
|
4471
|
+
"type": "string"
|
|
4472
|
+
}
|
|
4473
|
+
],
|
|
4474
|
+
"usage": "in"
|
|
4475
|
+
},
|
|
4476
|
+
"ModifyCloudModerationRequest": {
|
|
4477
|
+
"document": "ModifyCloudModeration request structure.",
|
|
4478
|
+
"members": [
|
|
4479
|
+
{
|
|
4480
|
+
"disabled": false,
|
|
4481
|
+
"document": "SDKAppId of TRTC, which is the same as the SDKAppId corresponding to the TRTC room.",
|
|
4482
|
+
"example": "1400188366",
|
|
4483
|
+
"member": "uint64",
|
|
4484
|
+
"name": "SdkAppId",
|
|
4485
|
+
"required": true,
|
|
4486
|
+
"type": "int"
|
|
4487
|
+
},
|
|
4488
|
+
{
|
|
4489
|
+
"disabled": false,
|
|
4490
|
+
"document": "Unique ID of the moderation task, which is returned after the task is started.",
|
|
4491
|
+
"example": "-npVoIhU7uxalbjwbc-qxKyKqluNl93bUmLFI4K-4pycoZWQndibYzKsC3HkljEK3HikwogUxwE.",
|
|
4492
|
+
"member": "string",
|
|
4493
|
+
"name": "TaskId",
|
|
4494
|
+
"required": true,
|
|
4495
|
+
"type": "string"
|
|
4496
|
+
},
|
|
4497
|
+
{
|
|
4498
|
+
"disabled": false,
|
|
4499
|
+
"document": "Specifies the allowlist or blocklist for the subscription stream.",
|
|
4500
|
+
"example": "{\"SubscribeAudioUserIds\":[\"user1\"],\"SubscribeVideoUserIds\":[\"user2\"]}",
|
|
4501
|
+
"member": "SubscribeStreamUserIds",
|
|
4502
|
+
"name": "SubscribeStreamUserIds",
|
|
3399
4503
|
"required": false,
|
|
3400
|
-
"type": "object"
|
|
3401
|
-
"value_allowed_null": false
|
|
4504
|
+
"type": "object"
|
|
3402
4505
|
}
|
|
3403
4506
|
],
|
|
3404
|
-
"
|
|
4507
|
+
"type": "object"
|
|
3405
4508
|
},
|
|
3406
|
-
"
|
|
3407
|
-
"document": "
|
|
4509
|
+
"ModifyCloudModerationResponse": {
|
|
4510
|
+
"document": "ModifyCloudModeration response structure.",
|
|
3408
4511
|
"members": [
|
|
3409
4512
|
{
|
|
3410
4513
|
"disabled": false,
|
|
3411
|
-
"document": "
|
|
3412
|
-
"example": "
|
|
4514
|
+
"document": "Unique ID of the moderation task, which is returned after the task is started.",
|
|
4515
|
+
"example": "-npVoIhU7uxalbjwbc-qxKyKqluNl93bUmLFI4K-4pycoZWQndibYzKsC3HkljEK3HikwogUxwE.",
|
|
3413
4516
|
"member": "string",
|
|
3414
|
-
"name": "
|
|
3415
|
-
"
|
|
3416
|
-
"type": "string"
|
|
4517
|
+
"name": "TaskId",
|
|
4518
|
+
"output_required": true,
|
|
4519
|
+
"type": "string",
|
|
4520
|
+
"value_allowed_null": false
|
|
3417
4521
|
},
|
|
3418
4522
|
{
|
|
3419
|
-
"
|
|
3420
|
-
"document": "If a dynamic layout is used, the value of this parameter should be the ID of the main room. If a custom layout is used, the value of this parameter should be the same as the room ID in `MixLayoutList`.",
|
|
3421
|
-
"example": "room_1234",
|
|
4523
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
3422
4524
|
"member": "string",
|
|
3423
|
-
"name": "
|
|
3424
|
-
"required": false,
|
|
4525
|
+
"name": "RequestId",
|
|
3425
4526
|
"type": "string"
|
|
3426
|
-
},
|
|
3427
|
-
{
|
|
3428
|
-
"disabled": false,
|
|
3429
|
-
"document": "The type of the `RoomId` parameter. 0: integer; 1: string.",
|
|
3430
|
-
"example": "1",
|
|
3431
|
-
"member": "uint64",
|
|
3432
|
-
"name": "RoomIdType",
|
|
3433
|
-
"required": false,
|
|
3434
|
-
"type": "int"
|
|
3435
4527
|
}
|
|
3436
4528
|
],
|
|
3437
|
-
"
|
|
4529
|
+
"type": "object"
|
|
3438
4530
|
},
|
|
3439
4531
|
"ModifyCloudRecordingRequest": {
|
|
3440
4532
|
"document": "ModifyCloudRecording request structure.",
|
|
@@ -3500,6 +4592,61 @@
|
|
|
3500
4592
|
],
|
|
3501
4593
|
"type": "object"
|
|
3502
4594
|
},
|
|
4595
|
+
"ModifyCloudSliceTaskRequest": {
|
|
4596
|
+
"document": "ModifyCloudSliceTask request structure.",
|
|
4597
|
+
"members": [
|
|
4598
|
+
{
|
|
4599
|
+
"disabled": false,
|
|
4600
|
+
"document": "SDKAppId of TRTC, which is the same as the SDKAppId corresponding to the TRTC room.",
|
|
4601
|
+
"example": "1400188366",
|
|
4602
|
+
"member": "uint64",
|
|
4603
|
+
"name": "SdkAppId",
|
|
4604
|
+
"required": true,
|
|
4605
|
+
"type": "int"
|
|
4606
|
+
},
|
|
4607
|
+
{
|
|
4608
|
+
"disabled": false,
|
|
4609
|
+
"document": "Unique ID of the slicing task, which is returned after the task is started.",
|
|
4610
|
+
"example": "-nHwX3RU7h3eZ-9PYsqd+z8I1uU1tUnbTWClW4K-xuWiN6KipeCyXJ8ZJEFpWSZ5zZuyZUAuAQ..",
|
|
4611
|
+
"member": "string",
|
|
4612
|
+
"name": "TaskId",
|
|
4613
|
+
"required": true,
|
|
4614
|
+
"type": "string"
|
|
4615
|
+
},
|
|
4616
|
+
{
|
|
4617
|
+
"disabled": false,
|
|
4618
|
+
"document": "Specifies the allowlist or blocklist for the subscription stream.",
|
|
4619
|
+
"example": "无",
|
|
4620
|
+
"member": "SubscribeStreamUserIds",
|
|
4621
|
+
"name": "SubscribeStreamUserIds",
|
|
4622
|
+
"required": false,
|
|
4623
|
+
"type": "object"
|
|
4624
|
+
}
|
|
4625
|
+
],
|
|
4626
|
+
"type": "object"
|
|
4627
|
+
},
|
|
4628
|
+
"ModifyCloudSliceTaskResponse": {
|
|
4629
|
+
"document": "ModifyCloudSliceTask response structure.",
|
|
4630
|
+
"members": [
|
|
4631
|
+
{
|
|
4632
|
+
"disabled": false,
|
|
4633
|
+
"document": "Unique ID of the slicing task, which is returned after the task is started.",
|
|
4634
|
+
"example": "-nHwX3RU7h3eZ-9PYsqd+z8I1uU1tUnbTWClW4K-xuWiN6KipeCyXJ8ZJEFpWSZ5zZuyZUAuAQ..",
|
|
4635
|
+
"member": "string",
|
|
4636
|
+
"name": "TaskId",
|
|
4637
|
+
"output_required": true,
|
|
4638
|
+
"type": "string",
|
|
4639
|
+
"value_allowed_null": false
|
|
4640
|
+
},
|
|
4641
|
+
{
|
|
4642
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
4643
|
+
"member": "string",
|
|
4644
|
+
"name": "RequestId",
|
|
4645
|
+
"type": "string"
|
|
4646
|
+
}
|
|
4647
|
+
],
|
|
4648
|
+
"type": "object"
|
|
4649
|
+
},
|
|
3503
4650
|
"QualityData": {
|
|
3504
4651
|
"document": "The quality data returned by ES.",
|
|
3505
4652
|
"members": [
|
|
@@ -3561,7 +4708,7 @@
|
|
|
3561
4708
|
{
|
|
3562
4709
|
"disabled": false,
|
|
3563
4710
|
"document": "Initiate fuzzy recognition to replace additional language types. Fill in up to 3 language types. Note: When Language is specified as \"zh-dialect\", fuzzy recognition is not supported and this field is invalid.",
|
|
3564
|
-
"example": "
|
|
4711
|
+
"example": "[\"en\",\"jp\"]",
|
|
3565
4712
|
"member": "string",
|
|
3566
4713
|
"name": "AlternativeLanguage",
|
|
3567
4714
|
"required": false,
|
|
@@ -4079,12 +5226,86 @@
|
|
|
4079
5226
|
{
|
|
4080
5227
|
"disabled": false,
|
|
4081
5228
|
"document": "The stream information.",
|
|
4082
|
-
"example": "
|
|
5229
|
+
"example": "{\"UserInfo\":{\"UserId\":\"user_a\",\"RoomId\":\"123456\",\"RoomIdType\":0},\"StreamType\":0}",
|
|
4083
5230
|
"member": "UserMediaStream",
|
|
4084
5231
|
"name": "UserMediaStream",
|
|
4085
5232
|
"required": true,
|
|
4086
|
-
"type": "object"
|
|
4087
|
-
|
|
5233
|
+
"type": "object"
|
|
5234
|
+
}
|
|
5235
|
+
],
|
|
5236
|
+
"usage": "in"
|
|
5237
|
+
},
|
|
5238
|
+
"SliceParams": {
|
|
5239
|
+
"document": "Control parameters for cloud slicing.",
|
|
5240
|
+
"members": [
|
|
5241
|
+
{
|
|
5242
|
+
"disabled": false,
|
|
5243
|
+
"document": "Slicing task type.\n1: audio slicing;\n2: video frame extraction;\n3: audio/video slicing + video frame extraction.\nExample value: 1.",
|
|
5244
|
+
"example": "1",
|
|
5245
|
+
"member": "uint64",
|
|
5246
|
+
"name": "SliceType",
|
|
5247
|
+
"required": false,
|
|
5248
|
+
"type": "int"
|
|
5249
|
+
},
|
|
5250
|
+
{
|
|
5251
|
+
"disabled": false,
|
|
5252
|
+
"document": "Recording is stopped automatically when there is no anchor in the room for more than MaxIdleTime. Unit: seconds. Default value: 30 seconds. This value needs to be greater than or equal to 5 seconds and less than or equal to 86,400 seconds (24 hours).\nExample value: 30.",
|
|
5253
|
+
"example": "30",
|
|
5254
|
+
"member": "uint64",
|
|
5255
|
+
"name": "MaxIdleTime",
|
|
5256
|
+
"required": false,
|
|
5257
|
+
"type": "int"
|
|
5258
|
+
},
|
|
5259
|
+
{
|
|
5260
|
+
"disabled": false,
|
|
5261
|
+
"document": "Audio slicing duration. Default value: 15s. Example value: 15.",
|
|
5262
|
+
"example": "15",
|
|
5263
|
+
"member": "uint64",
|
|
5264
|
+
"name": "SliceAudio",
|
|
5265
|
+
"required": false,
|
|
5266
|
+
"type": "int"
|
|
5267
|
+
},
|
|
5268
|
+
{
|
|
5269
|
+
"disabled": false,
|
|
5270
|
+
"document": "Interval for video frame extraction. Default value: 5s. Example value: 5.",
|
|
5271
|
+
"example": "5",
|
|
5272
|
+
"member": "uint64",
|
|
5273
|
+
"name": "SliceVideo",
|
|
5274
|
+
"required": false,
|
|
5275
|
+
"type": "int"
|
|
5276
|
+
},
|
|
5277
|
+
{
|
|
5278
|
+
"disabled": false,
|
|
5279
|
+
"document": "Specifies the allowlist or blocklist for the subscription stream.",
|
|
5280
|
+
"example": "无",
|
|
5281
|
+
"member": "SubscribeStreamUserIds",
|
|
5282
|
+
"name": "SubscribeStreamUserIds",
|
|
5283
|
+
"required": false,
|
|
5284
|
+
"type": "object"
|
|
5285
|
+
},
|
|
5286
|
+
{
|
|
5287
|
+
"disabled": false,
|
|
5288
|
+
"document": "Depreciated. The callback URL is configured in the console.",
|
|
5289
|
+
"example": "url",
|
|
5290
|
+
"member": "string",
|
|
5291
|
+
"name": "SliceCallbackUrl",
|
|
5292
|
+
"required": false,
|
|
5293
|
+
"type": "string"
|
|
5294
|
+
}
|
|
5295
|
+
],
|
|
5296
|
+
"usage": "in"
|
|
5297
|
+
},
|
|
5298
|
+
"SliceStorageParams": {
|
|
5299
|
+
"document": "Storage parameters for the slicing files.",
|
|
5300
|
+
"members": [
|
|
5301
|
+
{
|
|
5302
|
+
"disabled": false,
|
|
5303
|
+
"document": "Information about Tencent COS and third-party cloud storage accounts.",
|
|
5304
|
+
"example": "无",
|
|
5305
|
+
"member": "CloudSliceStorage",
|
|
5306
|
+
"name": "CloudSliceStorage",
|
|
5307
|
+
"required": false,
|
|
5308
|
+
"type": "object"
|
|
4088
5309
|
}
|
|
4089
5310
|
],
|
|
4090
5311
|
"usage": "in"
|
|
@@ -4195,7 +5416,7 @@
|
|
|
4195
5416
|
{
|
|
4196
5417
|
"disabled": false,
|
|
4197
5418
|
"document": "TRTC's [SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid) is the same as the SdkAppId used by the room that starts the transcription task.",
|
|
4198
|
-
"example": "
|
|
5419
|
+
"example": "14600000",
|
|
4199
5420
|
"member": "uint64",
|
|
4200
5421
|
"name": "SdkAppId",
|
|
4201
5422
|
"required": true,
|
|
@@ -4204,7 +5425,7 @@
|
|
|
4204
5425
|
{
|
|
4205
5426
|
"disabled": false,
|
|
4206
5427
|
"document": "TRTC's [RoomId](https://cloud.tencent.com/document/product/647/46351#roomid), which indicates the room number where the transcription task is started.",
|
|
4207
|
-
"example": "
|
|
5428
|
+
"example": "11",
|
|
4208
5429
|
"member": "string",
|
|
4209
5430
|
"name": "RoomId",
|
|
4210
5431
|
"required": true,
|
|
@@ -4222,7 +5443,7 @@
|
|
|
4222
5443
|
{
|
|
4223
5444
|
"disabled": false,
|
|
4224
5445
|
"document": "The unique ID passed by the caller is used by the server to deduplicate. Note: If this parameter is passed, the server will use it first to deduplicate. If this parameter is not passed, the server's deduplication strategy is as follows: \n- If the TranscriptionMode field is 0, only one task can be opened in a room\n- If the TranscriptionMode field is 1, only one task can be opened in a TargetUserId",
|
|
4225
|
-
"example": "
|
|
5446
|
+
"example": "session_1",
|
|
4226
5447
|
"member": "string",
|
|
4227
5448
|
"name": "SessionId",
|
|
4228
5449
|
"required": false,
|
|
@@ -4231,7 +5452,7 @@
|
|
|
4231
5452
|
{
|
|
4232
5453
|
"disabled": false,
|
|
4233
5454
|
"document": "The type of TRTC room number. 0 represents a numeric room number, and 1 represents a string room number. If not filled in, the default is a numeric room number.",
|
|
4234
|
-
"example": "
|
|
5455
|
+
"example": "0",
|
|
4235
5456
|
"member": "uint64",
|
|
4236
5457
|
"name": "RoomIdType",
|
|
4237
5458
|
"required": false,
|
|
@@ -4245,6 +5466,15 @@
|
|
|
4245
5466
|
"name": "RecognizeConfig",
|
|
4246
5467
|
"required": false,
|
|
4247
5468
|
"type": "object"
|
|
5469
|
+
},
|
|
5470
|
+
{
|
|
5471
|
+
"disabled": false,
|
|
5472
|
+
"document": "Translation config.",
|
|
5473
|
+
"example": "无",
|
|
5474
|
+
"member": "TranslationConfig",
|
|
5475
|
+
"name": "TranslationConfig",
|
|
5476
|
+
"required": false,
|
|
5477
|
+
"type": "object"
|
|
4248
5478
|
}
|
|
4249
5479
|
],
|
|
4250
5480
|
"type": "object"
|
|
@@ -4277,7 +5507,7 @@
|
|
|
4277
5507
|
{
|
|
4278
5508
|
"disabled": false,
|
|
4279
5509
|
"document": "The [SDKAppID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are relayed.",
|
|
4280
|
-
"example": "
|
|
5510
|
+
"example": "1400***000",
|
|
4281
5511
|
"member": "uint64",
|
|
4282
5512
|
"name": "SdkAppId",
|
|
4283
5513
|
"required": true,
|
|
@@ -4304,7 +5534,7 @@
|
|
|
4304
5534
|
{
|
|
4305
5535
|
"disabled": false,
|
|
4306
5536
|
"document": "The information of the relaying robot in the room.",
|
|
4307
|
-
"example": "
|
|
5537
|
+
"example": "{\"UserId\":\"trtc_user_agent\",\"UserSig\":\"eJw1zV8****pljzBb*IOTE_\",\"MaxIdleTime\":30}",
|
|
4308
5538
|
"member": "AgentParams",
|
|
4309
5539
|
"name": "AgentParams",
|
|
4310
5540
|
"required": true,
|
|
@@ -4322,7 +5552,7 @@
|
|
|
4322
5552
|
{
|
|
4323
5553
|
"disabled": false,
|
|
4324
5554
|
"document": "The audio encoding parameters. Because audio is always transcoded (no fees are incurred), this parameter is required when you start a relay task.",
|
|
4325
|
-
"example": "
|
|
5555
|
+
"example": "{\"AudioEncode\":{\"SampleRate\":48000,\"Channel\":2,\"BitRate\":64,\"Codec\":0}}",
|
|
4326
5556
|
"member": "McuAudioParams",
|
|
4327
5557
|
"name": "AudioParams",
|
|
4328
5558
|
"required": false,
|
|
@@ -4331,7 +5561,7 @@
|
|
|
4331
5561
|
{
|
|
4332
5562
|
"disabled": false,
|
|
4333
5563
|
"document": "The video encoding parameters for relaying. If you do not pass this parameter, only audio will be relayed.",
|
|
4334
|
-
"example": "
|
|
5564
|
+
"example": "{\"VideoEncode\":{\"Width\":64,\"Height\":64,\"Fps\":15,\"BitRate\":128,\"Gop\":2},\"LayoutParams\":{\"MixLayoutMode\":3}}",
|
|
4335
5565
|
"member": "McuVideoParams",
|
|
4336
5566
|
"name": "VideoParams",
|
|
4337
5567
|
"required": false,
|
|
@@ -4340,7 +5570,7 @@
|
|
|
4340
5570
|
{
|
|
4341
5571
|
"disabled": false,
|
|
4342
5572
|
"document": "The information of a single stream relayed. When you relay a single stream, set `WithTranscoding` to 0.",
|
|
4343
|
-
"example": "
|
|
5573
|
+
"example": "{\"UserMediaStream\":{\"UserInfo\":{\"RoomId\":\"123456\",\"RoomIdType\":0,\"UserId\":\"trtc_user_id\"},\"StreamType\":0}}",
|
|
4344
5574
|
"member": "SingleSubscribeParams",
|
|
4345
5575
|
"name": "SingleSubscribeParams",
|
|
4346
5576
|
"required": false,
|
|
@@ -4349,7 +5579,7 @@
|
|
|
4349
5579
|
{
|
|
4350
5580
|
"disabled": false,
|
|
4351
5581
|
"document": "The information of the CDNs to relay to. You need to specify at least one between this parameter and `FeedBackRoomParams.N`.",
|
|
4352
|
-
"example": "
|
|
5582
|
+
"example": "[{\"IsTencentCdn\":1,\"PublishCdnUrl\":\"rtmp://***&txTime=68639060\"}]",
|
|
4353
5583
|
"member": "McuPublishCdnParam",
|
|
4354
5584
|
"name": "PublishCdnParams",
|
|
4355
5585
|
"required": false,
|
|
@@ -4358,7 +5588,7 @@
|
|
|
4358
5588
|
{
|
|
4359
5589
|
"disabled": false,
|
|
4360
5590
|
"document": "The stream mixing SEI parameters.",
|
|
4361
|
-
"example": "
|
|
5591
|
+
"example": "{\"LayoutVolume\":{\"AppData\":\"***\",\"PayloadType\":120, \"Interval\":3000,\"FollowIdr\":1}}",
|
|
4362
5592
|
"member": "McuSeiParams",
|
|
4363
5593
|
"name": "SeiParams",
|
|
4364
5594
|
"required": false,
|
|
@@ -4367,11 +5597,20 @@
|
|
|
4367
5597
|
{
|
|
4368
5598
|
"disabled": false,
|
|
4369
5599
|
"document": "The information of the room to which streams are relayed. Between this parameter and `PublishCdnParams`, you must specify at least one. Please note that relaying to a TRTC room is only supported in some SDK versions. For details, please contact technical support.",
|
|
4370
|
-
"example": "
|
|
5600
|
+
"example": "[{\"RoomId\":\"123456\",\"RoomIdType\":0,\"UserId\":\"trtc_user_fb\",\"UserSig\":\"eJw1jdEKgj***AEOjOFw_\"}]",
|
|
4371
5601
|
"member": "McuFeedBackRoomParams",
|
|
4372
5602
|
"name": "FeedBackRoomParams",
|
|
4373
5603
|
"required": false,
|
|
4374
5604
|
"type": "list"
|
|
5605
|
+
},
|
|
5606
|
+
{
|
|
5607
|
+
"disabled": false,
|
|
5608
|
+
"document": "Relay Recording Parameters.\nExample value:{\"UniRecord\":1,\"RecordKey\": \"test_recore_key_a\"}",
|
|
5609
|
+
"example": "{\"UniRecord\":1,\"RecordKey\": \"test_recore_key_a\"}",
|
|
5610
|
+
"member": "McuRecordParams",
|
|
5611
|
+
"name": "RecordParams",
|
|
5612
|
+
"required": false,
|
|
5613
|
+
"type": "object"
|
|
4375
5614
|
}
|
|
4376
5615
|
],
|
|
4377
5616
|
"type": "object"
|
|
@@ -4382,7 +5621,7 @@
|
|
|
4382
5621
|
{
|
|
4383
5622
|
"disabled": false,
|
|
4384
5623
|
"document": "The task ID, which is generated by the Tencent Cloud server. You need to pass in the task ID when making a request to update or stop a relaying task.",
|
|
4385
|
-
"example": "
|
|
5624
|
+
"example": "-nHPekVU7h******sceOqAZ1YVQE.",
|
|
4386
5625
|
"member": "string",
|
|
4387
5626
|
"name": "TaskId",
|
|
4388
5627
|
"output_required": true,
|
|
@@ -4493,59 +5732,168 @@
|
|
|
4493
5732
|
},
|
|
4494
5733
|
{
|
|
4495
5734
|
"disabled": false,
|
|
4496
|
-
"document": "",
|
|
5735
|
+
"document": "",
|
|
5736
|
+
"example": "无",
|
|
5737
|
+
"member": "int64",
|
|
5738
|
+
"name": "SeekSecond",
|
|
5739
|
+
"required": false,
|
|
5740
|
+
"type": "int"
|
|
5741
|
+
},
|
|
5742
|
+
{
|
|
5743
|
+
"disabled": false,
|
|
5744
|
+
"document": "Enable auto relay to cdn, please make sure that this feature has been enabled in the console.",
|
|
5745
|
+
"example": "无",
|
|
5746
|
+
"member": "bool",
|
|
5747
|
+
"name": "AutoPush",
|
|
5748
|
+
"required": false,
|
|
5749
|
+
"type": "bool"
|
|
5750
|
+
},
|
|
5751
|
+
{
|
|
5752
|
+
"disabled": false,
|
|
5753
|
+
"document": "Loop playback count, value range: [-1, 1000], default is 1 time. - 0 is an invalid value - -1 is for loop playback, task termination requires actively calling the stop interface or setting MaxDuration.",
|
|
5754
|
+
"example": "无",
|
|
5755
|
+
"member": "int64",
|
|
5756
|
+
"name": "RepeatNum",
|
|
5757
|
+
"required": false,
|
|
5758
|
+
"type": "int"
|
|
5759
|
+
},
|
|
5760
|
+
{
|
|
5761
|
+
"disabled": false,
|
|
5762
|
+
"document": "Loop playback maximum duration, only effective when RepeatNum is set to -1, valid value range: [1, 10080], unit: minutes",
|
|
5763
|
+
"example": "无",
|
|
5764
|
+
"member": "int64",
|
|
5765
|
+
"name": "MaxDuration",
|
|
5766
|
+
"required": false,
|
|
5767
|
+
"type": "int"
|
|
5768
|
+
},
|
|
5769
|
+
{
|
|
5770
|
+
"disabled": false,
|
|
5771
|
+
"document": "Volume. Valid value range: [0, 100], default value is 100, indicating the original volume.",
|
|
5772
|
+
"example": "90",
|
|
5773
|
+
"member": "uint64",
|
|
5774
|
+
"name": "Volume",
|
|
5775
|
+
"required": false,
|
|
5776
|
+
"type": "int"
|
|
5777
|
+
}
|
|
5778
|
+
],
|
|
5779
|
+
"type": "object"
|
|
5780
|
+
},
|
|
5781
|
+
"StartStreamIngestResponse": {
|
|
5782
|
+
"document": "StartStreamIngest response structure.",
|
|
5783
|
+
"members": [
|
|
5784
|
+
{
|
|
5785
|
+
"disabled": false,
|
|
5786
|
+
"document": "The Task ID of the Pull stream Relay. The Task ID is a unique identifier for a Pull stream Relay lifecycle process, and it loses its meaning when the task ends. The Task ID needs to be saved by the business as a parameter for the next operation on this task.",
|
|
5787
|
+
"example": "无",
|
|
5788
|
+
"member": "string",
|
|
5789
|
+
"name": "TaskId",
|
|
5790
|
+
"output_required": false,
|
|
5791
|
+
"type": "string",
|
|
5792
|
+
"value_allowed_null": false
|
|
5793
|
+
},
|
|
5794
|
+
{
|
|
5795
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
5796
|
+
"member": "string",
|
|
5797
|
+
"name": "RequestId",
|
|
5798
|
+
"type": "string"
|
|
5799
|
+
}
|
|
5800
|
+
],
|
|
5801
|
+
"type": "object"
|
|
5802
|
+
},
|
|
5803
|
+
"StartWebRecordRequest": {
|
|
5804
|
+
"document": "StartWebRecord request structure.",
|
|
5805
|
+
"members": [
|
|
5806
|
+
{
|
|
5807
|
+
"disabled": false,
|
|
5808
|
+
"document": "URL of the web page to be recorded",
|
|
5809
|
+
"example": "https://web-record-xxxx.cos.ap-xxx.xxx.com/test/xxx.mp4",
|
|
5810
|
+
"member": "string",
|
|
5811
|
+
"name": "RecordUrl",
|
|
5812
|
+
"required": true,
|
|
5813
|
+
"type": "string"
|
|
5814
|
+
},
|
|
5815
|
+
{
|
|
5816
|
+
"disabled": false,
|
|
5817
|
+
"document": "Maximum recording duration limit, in seconds. Valid range: [1800, 36000]. Default is 36,000 seconds (10 hours).",
|
|
5818
|
+
"example": "36000",
|
|
5819
|
+
"member": "uint64",
|
|
5820
|
+
"name": "MaxDurationLimit",
|
|
5821
|
+
"required": false,
|
|
5822
|
+
"type": "int"
|
|
5823
|
+
},
|
|
5824
|
+
{
|
|
5825
|
+
"disabled": false,
|
|
5826
|
+
"document": "[Required] Parameters related to cloud storage. Currently, Tencent Cloud Object Storage and Tencent Cloud VOD are supported, but third-party cloud storage is not supported. The storage format of the output file only supports hls or mp4.",
|
|
4497
5827
|
"example": "无",
|
|
4498
|
-
"member": "
|
|
4499
|
-
"name": "
|
|
5828
|
+
"member": "StorageParams",
|
|
5829
|
+
"name": "StorageParams",
|
|
4500
5830
|
"required": false,
|
|
4501
|
-
"type": "
|
|
5831
|
+
"type": "object"
|
|
4502
5832
|
},
|
|
4503
5833
|
{
|
|
4504
5834
|
"disabled": false,
|
|
4505
|
-
"document": "
|
|
5835
|
+
"document": "web-page recording video parameters",
|
|
4506
5836
|
"example": "无",
|
|
4507
|
-
"member": "
|
|
4508
|
-
"name": "
|
|
5837
|
+
"member": "WebRecordVideoParams",
|
|
5838
|
+
"name": "WebRecordVideoParams",
|
|
4509
5839
|
"required": false,
|
|
4510
|
-
"type": "
|
|
5840
|
+
"type": "object"
|
|
4511
5841
|
},
|
|
4512
5842
|
{
|
|
4513
5843
|
"disabled": false,
|
|
4514
|
-
"document": "
|
|
4515
|
-
"example": "
|
|
5844
|
+
"document": "[Required] The SDKAppID of the TRTC room ",
|
|
5845
|
+
"example": "1600011111",
|
|
4516
5846
|
"member": "int64",
|
|
4517
|
-
"name": "
|
|
5847
|
+
"name": "SdkAppId",
|
|
4518
5848
|
"required": false,
|
|
4519
5849
|
"type": "int"
|
|
4520
5850
|
},
|
|
4521
5851
|
{
|
|
4522
5852
|
"disabled": false,
|
|
4523
|
-
"document": "
|
|
5853
|
+
"document": "When sensitive to repetitive tasks, please pay attention to this value: To avoid tasks being initiated repeatedly in a short period, leading to task duplication, pass in the recording RecordId to identify the current task. The RecordId should be less than 32 bytes. If you carry the RecordId and initiate the start recording request more than once, only one task will be started, and the second one will report the error FailedOperation.TaskExist. Note that if the StartWebRecord call fails with an error other than FailedOperation.TaskExist, please change the RecordId and initiate the request again.",
|
|
5854
|
+
"example": "record_task_abc_1",
|
|
5855
|
+
"member": "string",
|
|
5856
|
+
"name": "RecordId",
|
|
5857
|
+
"required": false,
|
|
5858
|
+
"type": "string"
|
|
5859
|
+
},
|
|
5860
|
+
{
|
|
5861
|
+
"disabled": false,
|
|
5862
|
+
"document": "If you want to push the stream to a CDN, you can use the PublishCdnParams.N parameter to set it. It supports pushing streams to up to 10 CDN addresses simultaneously. If the relay address is a Tencent Cloud CDN, please explicitly set IsTencentCdn to 1.",
|
|
4524
5863
|
"example": "无",
|
|
4525
|
-
"member": "
|
|
4526
|
-
"name": "
|
|
5864
|
+
"member": "McuPublishCdnParam",
|
|
5865
|
+
"name": "PublishCdnParams",
|
|
4527
5866
|
"required": false,
|
|
4528
|
-
"type": "
|
|
5867
|
+
"type": "list"
|
|
4529
5868
|
},
|
|
4530
5869
|
{
|
|
4531
5870
|
"disabled": false,
|
|
4532
|
-
"document": "
|
|
4533
|
-
"example": "
|
|
5871
|
+
"document": "The timeout for loading page resources during recording, in seconds. The default value is 0 seconds. This value must be greater than or equal to 0 seconds and less than or equal to 60 seconds. If page load timeout detection is not enabled for the recording page, please do not set this parameter.",
|
|
5872
|
+
"example": "30",
|
|
4534
5873
|
"member": "uint64",
|
|
4535
|
-
"name": "
|
|
5874
|
+
"name": "ReadyTimeout",
|
|
4536
5875
|
"required": false,
|
|
4537
5876
|
"type": "int"
|
|
5877
|
+
},
|
|
5878
|
+
{
|
|
5879
|
+
"disabled": false,
|
|
5880
|
+
"document": "Render mobile mode parameters; do not set this parameter if you are not going to render mobile mode pages.",
|
|
5881
|
+
"example": "无",
|
|
5882
|
+
"member": "EmulateMobileParams",
|
|
5883
|
+
"name": "EmulateMobileParams",
|
|
5884
|
+
"required": false,
|
|
5885
|
+
"type": "object"
|
|
4538
5886
|
}
|
|
4539
5887
|
],
|
|
4540
5888
|
"type": "object"
|
|
4541
5889
|
},
|
|
4542
|
-
"
|
|
4543
|
-
"document": "
|
|
5890
|
+
"StartWebRecordResponse": {
|
|
5891
|
+
"document": "StartWebRecord response structure.",
|
|
4544
5892
|
"members": [
|
|
4545
5893
|
{
|
|
4546
5894
|
"disabled": false,
|
|
4547
|
-
"document": "The
|
|
4548
|
-
"example": "
|
|
5895
|
+
"document": "The unique ID of the recording task",
|
|
5896
|
+
"example": "Vfn+FlMTUh1hL0a6kfBUPUsd9FmPLyznAsbd+QFsasqLg5UulUlA9JhYTw15YEYMCxXlfQwtl5cNmrbJqFubDTUp3OGPsU.",
|
|
4549
5897
|
"member": "string",
|
|
4550
5898
|
"name": "TaskId",
|
|
4551
5899
|
"output_required": false,
|
|
@@ -4621,7 +5969,7 @@
|
|
|
4621
5969
|
{
|
|
4622
5970
|
"disabled": false,
|
|
4623
5971
|
"document": "The [SDKAppID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are relayed.",
|
|
4624
|
-
"example": "
|
|
5972
|
+
"example": "1400***000",
|
|
4625
5973
|
"member": "uint64",
|
|
4626
5974
|
"name": "SdkAppId",
|
|
4627
5975
|
"required": true,
|
|
@@ -4630,7 +5978,7 @@
|
|
|
4630
5978
|
{
|
|
4631
5979
|
"disabled": false,
|
|
4632
5980
|
"document": "The task ID.",
|
|
4633
|
-
"example": "
|
|
5981
|
+
"example": "-nHPekVU7h******sceOqAZ1YVQE.",
|
|
4634
5982
|
"member": "string",
|
|
4635
5983
|
"name": "TaskId",
|
|
4636
5984
|
"required": true,
|
|
@@ -4645,10 +5993,10 @@
|
|
|
4645
5993
|
{
|
|
4646
5994
|
"disabled": false,
|
|
4647
5995
|
"document": "The task ID.",
|
|
4648
|
-
"example": "
|
|
5996
|
+
"example": "-nHPekVU7h******sceOqAZ1YVQE.",
|
|
4649
5997
|
"member": "string",
|
|
4650
5998
|
"name": "TaskId",
|
|
4651
|
-
"
|
|
5999
|
+
"output_required": true,
|
|
4652
6000
|
"type": "string",
|
|
4653
6001
|
"value_allowed_null": false
|
|
4654
6002
|
},
|
|
@@ -4697,6 +6045,33 @@
|
|
|
4697
6045
|
],
|
|
4698
6046
|
"type": "object"
|
|
4699
6047
|
},
|
|
6048
|
+
"StopWebRecordRequest": {
|
|
6049
|
+
"document": "StopWebRecord request structure.",
|
|
6050
|
+
"members": [
|
|
6051
|
+
{
|
|
6052
|
+
"disabled": false,
|
|
6053
|
+
"document": "The ID of the task that needs to be stopped",
|
|
6054
|
+
"example": "HMLm5HWNuUAXSb0gTEOx0z1x+nLMZNjXrY3keyUSvu7uu8mF9O656uNtbUtvaWLkpMY134jTN2Ix4vuqgOJ68nQ8tho3ri",
|
|
6055
|
+
"member": "string",
|
|
6056
|
+
"name": "TaskId",
|
|
6057
|
+
"required": true,
|
|
6058
|
+
"type": "string"
|
|
6059
|
+
}
|
|
6060
|
+
],
|
|
6061
|
+
"type": "object"
|
|
6062
|
+
},
|
|
6063
|
+
"StopWebRecordResponse": {
|
|
6064
|
+
"document": "StopWebRecord response structure.",
|
|
6065
|
+
"members": [
|
|
6066
|
+
{
|
|
6067
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
6068
|
+
"member": "string",
|
|
6069
|
+
"name": "RequestId",
|
|
6070
|
+
"type": "string"
|
|
6071
|
+
}
|
|
6072
|
+
],
|
|
6073
|
+
"type": "object"
|
|
6074
|
+
},
|
|
4700
6075
|
"StorageFile": {
|
|
4701
6076
|
"document": "The information of the recording files, which is returned by the `DescribeCloudRecording` API.",
|
|
4702
6077
|
"members": [
|
|
@@ -4753,8 +6128,7 @@
|
|
|
4753
6128
|
"member": "CloudStorage",
|
|
4754
6129
|
"name": "CloudStorage",
|
|
4755
6130
|
"required": false,
|
|
4756
|
-
"type": "object"
|
|
4757
|
-
"value_allowed_null": false
|
|
6131
|
+
"type": "object"
|
|
4758
6132
|
},
|
|
4759
6133
|
{
|
|
4760
6134
|
"disabled": false,
|
|
@@ -4763,12 +6137,61 @@
|
|
|
4763
6137
|
"member": "CloudVod",
|
|
4764
6138
|
"name": "CloudVod",
|
|
4765
6139
|
"required": false,
|
|
4766
|
-
"type": "object"
|
|
4767
|
-
"value_allowed_null": false
|
|
6140
|
+
"type": "object"
|
|
4768
6141
|
}
|
|
4769
6142
|
],
|
|
4770
6143
|
"usage": "in"
|
|
4771
6144
|
},
|
|
6145
|
+
"SubscribeModerationUserIds": {
|
|
6146
|
+
"document": "Specifies the subscription stream allowlist or blocklist. The audio allowlist and blocklist cannot be set simultaneously, and this also applies to video. Additionally, up to 25 concurrently subscribed media streams are supported, and up to 24 video screens are supported in mixed stream scenarios. It is also supported to use the \".*$\" wildcard for prefix matching of UserId in the blocklist and allowlist. Note that if there are user IDs in the room that match the wildcard rule, specific users are subscribed, causing the prefix rule to become ineffective.",
|
|
6147
|
+
"members": [
|
|
6148
|
+
{
|
|
6149
|
+
"disabled": false,
|
|
6150
|
+
"document": "Subscription audio stream allowlist. It specifies which UserIds' audio streams to subscribe to, for example, [\"1\", \"2\", \"3\"] indicates subscriptions to the audio streams of UserId 1, 2, and 3; [\"1.*$\"] indicates subscription to audio streams with UserId prefixes starting with 1. If this parameter is left unspecified, all audio streams in the room are subscribed to by default. The number of users in the subscription list should not exceed 32.\nNote: This field may return null, indicating that no valid values can be obtained.",
|
|
6151
|
+
"example": "[\"123\",\"456\"]",
|
|
6152
|
+
"member": "string",
|
|
6153
|
+
"name": "SubscribeAudioUserIds",
|
|
6154
|
+
"output_required": false,
|
|
6155
|
+
"required": false,
|
|
6156
|
+
"type": "list",
|
|
6157
|
+
"value_allowed_null": true
|
|
6158
|
+
},
|
|
6159
|
+
{
|
|
6160
|
+
"disabled": false,
|
|
6161
|
+
"document": "Subscription audio stream blocklist. It specifies which UserIds' audio streams not to subscribe to, for example, [\"1\", \"2\", \"3\"] indicates that the audio streams of UserId 1, 2, and 3 are not subscribed to; [\"1.*$\"] indicates that audio streams with UserId prefixes starting with 1 are not subscribed to. If this parameter is left unspecified, all audio streams in the room are subscribed to by default. The number of users in the subscription list should not exceed 32.\nNote: This field may return null, indicating that no valid values can be obtained.",
|
|
6162
|
+
"example": "[\"123\",\"456\"]",
|
|
6163
|
+
"member": "string",
|
|
6164
|
+
"name": "UnSubscribeAudioUserIds",
|
|
6165
|
+
"output_required": false,
|
|
6166
|
+
"required": false,
|
|
6167
|
+
"type": "list",
|
|
6168
|
+
"value_allowed_null": true
|
|
6169
|
+
},
|
|
6170
|
+
{
|
|
6171
|
+
"disabled": false,
|
|
6172
|
+
"document": "Subscription video stream allowlist. It specifies which UserIds' video streams to subscribe to, for example, [\"1\", \"2\", \"3\"] indicates subscriptions to the video streams of UserId 1, 2, and 3; [\"1.*$\"] indicates subscription to video streams with UserId prefixes starting with 1. If this parameter is left unspecified, all video streams in the room are subscribed to by default. The number of users in the subscription list should not exceed 32.\nNote: This field may return null, indicating that no valid values can be obtained.",
|
|
6173
|
+
"example": "[\"123\",\"456\"]",
|
|
6174
|
+
"member": "string",
|
|
6175
|
+
"name": "SubscribeVideoUserIds",
|
|
6176
|
+
"output_required": false,
|
|
6177
|
+
"required": false,
|
|
6178
|
+
"type": "list",
|
|
6179
|
+
"value_allowed_null": true
|
|
6180
|
+
},
|
|
6181
|
+
{
|
|
6182
|
+
"disabled": false,
|
|
6183
|
+
"document": "Subscription video stream blocklist. It specifies which UserIds' video streams not to subscribe to, for example, [\"1\", \"2\", \"3\"] indicates that the video streams of UserId 1, 2, and 3 are not subscribed to; [\"1.*$\"] indicates that video streams with UserId prefixes starting with 1 are not subscribed to. If this parameter is left unspecified, all video streams in the room are subscribed to by default. The number of users in the subscription list should not exceed 32.\nNote: This field may return null, indicating that no valid values can be obtained.",
|
|
6184
|
+
"example": "[\"123\",\"456\"]",
|
|
6185
|
+
"member": "string",
|
|
6186
|
+
"name": "UnSubscribeVideoUserIds",
|
|
6187
|
+
"output_required": false,
|
|
6188
|
+
"required": false,
|
|
6189
|
+
"type": "list",
|
|
6190
|
+
"value_allowed_null": true
|
|
6191
|
+
}
|
|
6192
|
+
],
|
|
6193
|
+
"usage": "both"
|
|
6194
|
+
},
|
|
4772
6195
|
"SubscribeStreamUserIds": {
|
|
4773
6196
|
"document": "The subscription allowlist/blocklist. You cannot specify an allowlist and a blocklist for audio/video subscription at the same time. The maximum number of streams one can receive at the same time is 25. When streams are mixed, up to 24 videos are supported. You can use `.*$` to specify user IDs with the same prefix, but make sure there aren’t users whose IDs contain \".*$\" and are exactly the same as the prefix you pass in. If there are, TRTC will only allow or block those users.",
|
|
4774
6197
|
"members": [
|
|
@@ -4779,8 +6202,7 @@
|
|
|
4779
6202
|
"member": "string",
|
|
4780
6203
|
"name": "SubscribeAudioUserIds",
|
|
4781
6204
|
"required": false,
|
|
4782
|
-
"type": "list"
|
|
4783
|
-
"value_allowed_null": false
|
|
6205
|
+
"type": "list"
|
|
4784
6206
|
},
|
|
4785
6207
|
{
|
|
4786
6208
|
"disabled": false,
|
|
@@ -4789,8 +6211,7 @@
|
|
|
4789
6211
|
"member": "string",
|
|
4790
6212
|
"name": "UnSubscribeAudioUserIds",
|
|
4791
6213
|
"required": false,
|
|
4792
|
-
"type": "list"
|
|
4793
|
-
"value_allowed_null": false
|
|
6214
|
+
"type": "list"
|
|
4794
6215
|
},
|
|
4795
6216
|
{
|
|
4796
6217
|
"disabled": false,
|
|
@@ -4799,8 +6220,7 @@
|
|
|
4799
6220
|
"member": "string",
|
|
4800
6221
|
"name": "SubscribeVideoUserIds",
|
|
4801
6222
|
"required": false,
|
|
4802
|
-
"type": "list"
|
|
4803
|
-
"value_allowed_null": false
|
|
6223
|
+
"type": "list"
|
|
4804
6224
|
},
|
|
4805
6225
|
{
|
|
4806
6226
|
"disabled": false,
|
|
@@ -4809,8 +6229,7 @@
|
|
|
4809
6229
|
"member": "string",
|
|
4810
6230
|
"name": "UnSubscribeVideoUserIds",
|
|
4811
6231
|
"required": false,
|
|
4812
|
-
"type": "list"
|
|
4813
|
-
"value_allowed_null": false
|
|
6232
|
+
"type": "list"
|
|
4814
6233
|
}
|
|
4815
6234
|
],
|
|
4816
6235
|
"usage": "in"
|
|
@@ -4851,13 +6270,30 @@
|
|
|
4851
6270
|
],
|
|
4852
6271
|
"usage": "out"
|
|
4853
6272
|
},
|
|
6273
|
+
"TTSConfig": {
|
|
6274
|
+
"document": "",
|
|
6275
|
+
"members": [
|
|
6276
|
+
{
|
|
6277
|
+
"disabled": false,
|
|
6278
|
+
"document": "",
|
|
6279
|
+
"example": "xiaoming",
|
|
6280
|
+
"member": "string",
|
|
6281
|
+
"name": "VoiceId",
|
|
6282
|
+
"output_required": false,
|
|
6283
|
+
"required": true,
|
|
6284
|
+
"type": "string",
|
|
6285
|
+
"value_allowed_null": false
|
|
6286
|
+
}
|
|
6287
|
+
],
|
|
6288
|
+
"usage": "both"
|
|
6289
|
+
},
|
|
4854
6290
|
"TencentVod": {
|
|
4855
6291
|
"document": "The Tencent Cloud VOD parameters.",
|
|
4856
6292
|
"members": [
|
|
4857
6293
|
{
|
|
4858
6294
|
"disabled": false,
|
|
4859
6295
|
"document": "The operation to perform on the media uploaded. The value of this parameter is the name of a task flow template. You can create a custom task flow template in Tencent Cloud VOD.",
|
|
4860
|
-
"example": "
|
|
6296
|
+
"example": "LongVideoPreset",
|
|
4861
6297
|
"member": "string",
|
|
4862
6298
|
"name": "Procedure",
|
|
4863
6299
|
"required": false,
|
|
@@ -4893,7 +6329,7 @@
|
|
|
4893
6329
|
{
|
|
4894
6330
|
"disabled": false,
|
|
4895
6331
|
"document": "The VOD subapplication ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty.",
|
|
4896
|
-
"example": "
|
|
6332
|
+
"example": "1",
|
|
4897
6333
|
"member": "uint64",
|
|
4898
6334
|
"name": "SubAppId",
|
|
4899
6335
|
"required": false,
|
|
@@ -4902,7 +6338,7 @@
|
|
|
4902
6338
|
{
|
|
4903
6339
|
"disabled": false,
|
|
4904
6340
|
"document": "The task flow context, which is passed through after the task is completed.",
|
|
4905
|
-
"example": "
|
|
6341
|
+
"example": "\"session_context_example\"",
|
|
4906
6342
|
"member": "string",
|
|
4907
6343
|
"name": "SessionContext",
|
|
4908
6344
|
"required": false,
|
|
@@ -4911,7 +6347,7 @@
|
|
|
4911
6347
|
{
|
|
4912
6348
|
"disabled": false,
|
|
4913
6349
|
"document": "The upload context, which is passed through after upload is completed.",
|
|
4914
|
-
"example": "
|
|
6350
|
+
"example": "\"source_context_example\"",
|
|
4915
6351
|
"member": "string",
|
|
4916
6352
|
"name": "SourceContext",
|
|
4917
6353
|
"required": false,
|
|
@@ -4929,7 +6365,7 @@
|
|
|
4929
6365
|
{
|
|
4930
6366
|
"disabled": false,
|
|
4931
6367
|
"document": "The custom prefix of recording files. This parameter is valid only if recording files are uploaded to VOD. It can contain letters, numbers, underscores, and hyphens and cannot exceed 64 bytes. This prefix and the automatically generated filename are connected with `__UserId_u_`.",
|
|
4932
|
-
"example": "
|
|
6368
|
+
"example": "\"user_prefix\"",
|
|
4933
6369
|
"member": "string",
|
|
4934
6370
|
"name": "UserDefineRecordId",
|
|
4935
6371
|
"required": false,
|
|
@@ -4938,6 +6374,34 @@
|
|
|
4938
6374
|
],
|
|
4939
6375
|
"usage": "in"
|
|
4940
6376
|
},
|
|
6377
|
+
"Terminology": {
|
|
6378
|
+
"document": "Translation terminology",
|
|
6379
|
+
"members": [
|
|
6380
|
+
{
|
|
6381
|
+
"disabled": false,
|
|
6382
|
+
"document": "Source terminology",
|
|
6383
|
+
"example": "腾讯云",
|
|
6384
|
+
"member": "string",
|
|
6385
|
+
"name": "Source",
|
|
6386
|
+
"output_required": false,
|
|
6387
|
+
"required": true,
|
|
6388
|
+
"type": "string",
|
|
6389
|
+
"value_allowed_null": false
|
|
6390
|
+
},
|
|
6391
|
+
{
|
|
6392
|
+
"disabled": false,
|
|
6393
|
+
"document": "Target terminology",
|
|
6394
|
+
"example": "Tencent Cloud",
|
|
6395
|
+
"member": "string",
|
|
6396
|
+
"name": "Target",
|
|
6397
|
+
"output_required": false,
|
|
6398
|
+
"required": true,
|
|
6399
|
+
"type": "string",
|
|
6400
|
+
"value_allowed_null": false
|
|
6401
|
+
}
|
|
6402
|
+
],
|
|
6403
|
+
"usage": "both"
|
|
6404
|
+
},
|
|
4941
6405
|
"TimeValue": {
|
|
4942
6406
|
"document": "The quality data, which consists of the `time` and `value` parameters.",
|
|
4943
6407
|
"members": [
|
|
@@ -4970,7 +6434,7 @@
|
|
|
4970
6434
|
{
|
|
4971
6435
|
"disabled": false,
|
|
4972
6436
|
"document": "The robot's UserId is used to enter a room and initiate tasks. [Note] This UserId cannot be repeated with the host viewer [UserId](https://cloud.tencent.com/document/product/647/46351#userid) in the current room. If multiple tasks are initiated in a room, the robot's UserId cannot be repeated, otherwise the previous task will be interrupted. The robot's UserId must be unique in the room.",
|
|
4973
|
-
"example": "
|
|
6437
|
+
"example": "user329",
|
|
4974
6438
|
"member": "string",
|
|
4975
6439
|
"name": "UserId",
|
|
4976
6440
|
"required": true,
|
|
@@ -4979,7 +6443,7 @@
|
|
|
4979
6443
|
{
|
|
4980
6444
|
"disabled": false,
|
|
4981
6445
|
"document": "The verification signature corresponding to the robot's UserId, that is, UserId and UserSig are equivalent to the robot's login password to enter the room. For the specific calculation method, please refer to the TRTC calculation [UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig) solution.",
|
|
4982
|
-
"example": "
|
|
6446
|
+
"example": "egjirneiwrwq",
|
|
4983
6447
|
"member": "string",
|
|
4984
6448
|
"name": "UserSig",
|
|
4985
6449
|
"required": true,
|
|
@@ -4988,7 +6452,7 @@
|
|
|
4988
6452
|
{
|
|
4989
6453
|
"disabled": false,
|
|
4990
6454
|
"document": "If there is no streaming in the room for more than MaxIdleTime, the background will automatically close the task. The default value is 60s.",
|
|
4991
|
-
"example": "
|
|
6455
|
+
"example": "60",
|
|
4992
6456
|
"member": "uint64",
|
|
4993
6457
|
"name": "MaxIdleTime",
|
|
4994
6458
|
"required": false,
|
|
@@ -4997,7 +6461,7 @@
|
|
|
4997
6461
|
{
|
|
4998
6462
|
"disabled": false,
|
|
4999
6463
|
"document": "1 means the robot subscribes to the stream of only one person, 0 means the robot subscribes to the stream of the entire room. If it is not filled in, the robot subscribes to the stream of the entire room by default.",
|
|
5000
|
-
"example": "
|
|
6464
|
+
"example": "1",
|
|
5001
6465
|
"member": "uint64",
|
|
5002
6466
|
"name": "TranscriptionMode",
|
|
5003
6467
|
"required": false,
|
|
@@ -5006,7 +6470,7 @@
|
|
|
5006
6470
|
{
|
|
5007
6471
|
"disabled": false,
|
|
5008
6472
|
"document": "Required when TranscriptionMode is 1. The robot will only pull the stream of the userid and ignore other users in the room.",
|
|
5009
|
-
"example": "
|
|
6473
|
+
"example": "user219",
|
|
5010
6474
|
"member": "string",
|
|
5011
6475
|
"name": "TargetUserId",
|
|
5012
6476
|
"required": false,
|
|
@@ -5015,6 +6479,56 @@
|
|
|
5015
6479
|
],
|
|
5016
6480
|
"usage": "in"
|
|
5017
6481
|
},
|
|
6482
|
+
"TranslationConfig": {
|
|
6483
|
+
"document": "Translation config",
|
|
6484
|
+
"members": [
|
|
6485
|
+
{
|
|
6486
|
+
"disabled": false,
|
|
6487
|
+
"document": "Target language, target language list (ISO 639-1).",
|
|
6488
|
+
"example": "[\"en\", \"ja\"]",
|
|
6489
|
+
"member": "string",
|
|
6490
|
+
"name": "TargetLanguages",
|
|
6491
|
+
"output_required": false,
|
|
6492
|
+
"required": true,
|
|
6493
|
+
"type": "list",
|
|
6494
|
+
"value_allowed_null": false
|
|
6495
|
+
},
|
|
6496
|
+
{
|
|
6497
|
+
"disabled": false,
|
|
6498
|
+
"document": "1: Only text translation, 2: Voice simultaneous interpretation.",
|
|
6499
|
+
"example": "2",
|
|
6500
|
+
"member": "uint64",
|
|
6501
|
+
"name": "Mode",
|
|
6502
|
+
"output_required": false,
|
|
6503
|
+
"required": false,
|
|
6504
|
+
"type": "int",
|
|
6505
|
+
"value_allowed_null": false
|
|
6506
|
+
},
|
|
6507
|
+
{
|
|
6508
|
+
"disabled": false,
|
|
6509
|
+
"document": "Voice simultaneous interpretation configuration: When enabling simultaneous interpretation, this parameter needs to be passed.",
|
|
6510
|
+
"example": "无",
|
|
6511
|
+
"member": "TTSConfig",
|
|
6512
|
+
"name": "TTSConfig",
|
|
6513
|
+
"output_required": false,
|
|
6514
|
+
"required": false,
|
|
6515
|
+
"type": "object",
|
|
6516
|
+
"value_allowed_null": false
|
|
6517
|
+
},
|
|
6518
|
+
{
|
|
6519
|
+
"disabled": false,
|
|
6520
|
+
"document": "Translation terminology.",
|
|
6521
|
+
"example": "无",
|
|
6522
|
+
"member": "Terminology",
|
|
6523
|
+
"name": "Terminology",
|
|
6524
|
+
"output_required": false,
|
|
6525
|
+
"required": false,
|
|
6526
|
+
"type": "list",
|
|
6527
|
+
"value_allowed_null": false
|
|
6528
|
+
}
|
|
6529
|
+
],
|
|
6530
|
+
"usage": "both"
|
|
6531
|
+
},
|
|
5018
6532
|
"TrtcUsage": {
|
|
5019
6533
|
"document": "The TRTC audio/video duration generated in a certain time period.",
|
|
5020
6534
|
"members": [
|
|
@@ -5396,12 +6910,11 @@
|
|
|
5396
6910
|
{
|
|
5397
6911
|
"disabled": false,
|
|
5398
6912
|
"document": "The user information.",
|
|
5399
|
-
"example": "
|
|
6913
|
+
"example": "{\"UserId\":\"user_a\",\"RoomId\":\"123456\",\"RoomIdType\":0}",
|
|
5400
6914
|
"member": "MixUserInfo",
|
|
5401
6915
|
"name": "UserInfo",
|
|
5402
6916
|
"required": false,
|
|
5403
|
-
"type": "object"
|
|
5404
|
-
"value_allowed_null": false
|
|
6917
|
+
"type": "object"
|
|
5405
6918
|
},
|
|
5406
6919
|
{
|
|
5407
6920
|
"disabled": false,
|
|
@@ -5410,8 +6923,7 @@
|
|
|
5410
6923
|
"member": "uint64",
|
|
5411
6924
|
"name": "StreamType",
|
|
5412
6925
|
"required": false,
|
|
5413
|
-
"type": "int"
|
|
5414
|
-
"value_allowed_null": false
|
|
6926
|
+
"type": "int"
|
|
5415
6927
|
}
|
|
5416
6928
|
],
|
|
5417
6929
|
"usage": "in"
|
|
@@ -5787,6 +7299,48 @@
|
|
|
5787
7299
|
}
|
|
5788
7300
|
],
|
|
5789
7301
|
"usage": "in"
|
|
7302
|
+
},
|
|
7303
|
+
"WebRecordVideoParams": {
|
|
7304
|
+
"document": "",
|
|
7305
|
+
"members": [
|
|
7306
|
+
{
|
|
7307
|
+
"disabled": false,
|
|
7308
|
+
"document": "",
|
|
7309
|
+
"example": "1280",
|
|
7310
|
+
"member": "uint64",
|
|
7311
|
+
"name": "Width",
|
|
7312
|
+
"required": false,
|
|
7313
|
+
"type": "int"
|
|
7314
|
+
},
|
|
7315
|
+
{
|
|
7316
|
+
"disabled": false,
|
|
7317
|
+
"document": "",
|
|
7318
|
+
"example": "720",
|
|
7319
|
+
"member": "uint64",
|
|
7320
|
+
"name": "Height",
|
|
7321
|
+
"required": false,
|
|
7322
|
+
"type": "int"
|
|
7323
|
+
},
|
|
7324
|
+
{
|
|
7325
|
+
"disabled": false,
|
|
7326
|
+
"document": "",
|
|
7327
|
+
"example": "mp4",
|
|
7328
|
+
"member": "string",
|
|
7329
|
+
"name": "Format",
|
|
7330
|
+
"required": false,
|
|
7331
|
+
"type": "string"
|
|
7332
|
+
},
|
|
7333
|
+
{
|
|
7334
|
+
"disabled": false,
|
|
7335
|
+
"document": "",
|
|
7336
|
+
"example": "1440",
|
|
7337
|
+
"member": "int64",
|
|
7338
|
+
"name": "MaxMediaFileDuration",
|
|
7339
|
+
"required": false,
|
|
7340
|
+
"type": "int"
|
|
7341
|
+
}
|
|
7342
|
+
],
|
|
7343
|
+
"usage": "in"
|
|
5790
7344
|
}
|
|
5791
7345
|
},
|
|
5792
7346
|
"version": "1.0"
|