tccli-intl-en 3.0.1237.1__py2.py3-none-any.whl → 3.0.1282.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.
Files changed (214) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/__init__.py +17 -1
  3. tccli/services/advisor/advisor_client.py +8 -2
  4. tccli/services/aiart/aiart_client.py +4 -1
  5. tccli/services/ams/ams_client.py +16 -4
  6. tccli/services/antiddos/antiddos_client.py +280 -70
  7. tccli/services/apigateway/apigateway_client.py +372 -93
  8. tccli/services/apm/apm_client.py +52 -13
  9. tccli/services/asr/asr_client.py +8 -2
  10. tccli/services/autoscaling/autoscaling_client.py +232 -58
  11. tccli/services/autoscaling/v20180419/api.json +1 -1
  12. tccli/services/batch/batch_client.py +112 -28
  13. tccli/services/bi/bi_client.py +1242 -4
  14. tccli/services/bi/v20220105/api.json +5340 -107
  15. tccli/services/bi/v20220105/examples.json +196 -1
  16. tccli/services/billing/billing_client.py +168 -42
  17. tccli/services/cam/cam_client.py +324 -81
  18. tccli/services/captcha/captcha_client.py +4 -1
  19. tccli/services/car/car_client.py +132 -33
  20. tccli/services/cbs/cbs_client.py +152 -38
  21. tccli/services/ccc/ccc_client.py +732 -98
  22. tccli/services/ccc/v20200210/api.json +1727 -196
  23. tccli/services/ccc/v20200210/examples.json +64 -0
  24. tccli/services/cdb/cdb_client.py +532 -133
  25. tccli/services/cdc/cdc_client.py +80 -20
  26. tccli/services/cdc/v20201214/api.json +2 -2
  27. tccli/services/cdc/v20201214/examples.json +4 -4
  28. tccli/services/cdn/cdn_client.py +176 -44
  29. tccli/services/cdwdoris/cdwdoris_client.py +308 -77
  30. tccli/services/cdwpg/cdwpg_client.py +96 -24
  31. tccli/services/cdz/__init__.py +4 -0
  32. tccli/services/cdz/cdz_client.py +210 -0
  33. tccli/services/cdz/v20221123/api.json +233 -0
  34. tccli/services/cdz/v20221123/examples.json +12 -0
  35. tccli/services/cfg/cfg_client.py +64 -16
  36. tccli/services/cfs/cfs_client.py +156 -39
  37. tccli/services/cfw/cfw_client.py +264 -66
  38. tccli/services/chdfs/chdfs_client.py +116 -29
  39. tccli/services/ciam/ciam_client.py +64 -16
  40. tccli/services/ckafka/ckafka_client.py +575 -77
  41. tccli/services/ckafka/v20190819/api.json +2749 -1470
  42. tccli/services/ckafka/v20190819/examples.json +209 -155
  43. tccli/services/clb/clb_client.py +332 -83
  44. tccli/services/clb/v20180317/api.json +29 -14
  45. tccli/services/cloudaudit/cloudaudit_client.py +72 -18
  46. tccli/services/cls/cls_client.py +348 -87
  47. tccli/services/cmq/cmq_client.py +12 -801
  48. tccli/services/cmq/v20190304/api.json +173 -1367
  49. tccli/services/cmq/v20190304/examples.json +0 -120
  50. tccli/services/config/config_client.py +24 -6
  51. tccli/services/controlcenter/controlcenter_client.py +4 -1
  52. tccli/services/csip/csip_client.py +136 -34
  53. tccli/services/ctsdb/ctsdb_client.py +8 -2
  54. tccli/services/cvm/cvm_client.py +627 -110
  55. tccli/services/cvm/v20170312/api.json +750 -340
  56. tccli/services/cvm/v20170312/examples.json +105 -59
  57. tccli/services/cwp/cwp_client.py +1860 -465
  58. tccli/services/cynosdb/cynosdb_client.py +1749 -439
  59. tccli/services/cynosdb/v20190107/api.json +11763 -7697
  60. tccli/services/cynosdb/v20190107/examples.json +132 -4
  61. tccli/services/dataintegration/dataintegration_client.py +4 -1
  62. tccli/services/dayu/dayu_client.py +412 -103
  63. tccli/services/dbbrain/dbbrain_client.py +168 -42
  64. tccli/services/dc/dc_client.py +72 -18
  65. tccli/services/dcdb/dcdb_client.py +248 -62
  66. tccli/services/dlc/dlc_client.py +756 -111
  67. tccli/services/dlc/v20210125/api.json +637 -13
  68. tccli/services/dlc/v20210125/examples.json +48 -0
  69. tccli/services/dms/dms_client.py +8 -2
  70. tccli/services/dnspod/dnspod_client.py +353 -74
  71. tccli/services/dnspod/v20210323/api.json +196 -0
  72. tccli/services/dnspod/v20210323/examples.json +24 -0
  73. tccli/services/domain/domain_client.py +96 -24
  74. tccli/services/dts/dts_client.py +332 -83
  75. tccli/services/eb/eb_client.py +104 -26
  76. tccli/services/ecdn/ecdn_client.py +60 -15
  77. tccli/services/ecm/ecm_client.py +496 -124
  78. tccli/services/eiam/eiam_client.py +160 -40
  79. tccli/services/emr/emr_client.py +2784 -115
  80. tccli/services/emr/v20190103/api.json +14647 -4756
  81. tccli/services/emr/v20190103/examples.json +408 -40
  82. tccli/services/es/es_client.py +84 -21
  83. tccli/services/facefusion/facefusion_client.py +12 -3
  84. tccli/services/faceid/faceid_client.py +76 -19
  85. tccli/services/faceid/v20180301/api.json +79 -14
  86. tccli/services/faceid/v20180301/examples.json +3 -3
  87. tccli/services/gaap/gaap_client.py +352 -88
  88. tccli/services/gme/gme_client.py +40 -10
  89. tccli/services/gpm/gpm_client.py +72 -18
  90. tccli/services/gse/gse_client.py +88 -22
  91. tccli/services/gwlb/gwlb_client.py +72 -18
  92. tccli/services/iai/iai_client.py +116 -29
  93. tccli/services/iap/iap_client.py +24 -6
  94. tccli/services/ims/ims_client.py +4 -1
  95. tccli/services/intlpartnersmgt/intlpartnersmgt_client.py +168 -42
  96. tccli/services/intlpartnersmgt/v20220928/api.json +11 -11
  97. tccli/services/iotcloud/iotcloud_client.py +80 -20
  98. tccli/services/ip/ip_client.py +24 -6
  99. tccli/services/kms/kms_client.py +272 -68
  100. tccli/services/lcic/lcic_client.py +212 -53
  101. tccli/services/lighthouse/lighthouse_client.py +296 -74
  102. tccli/services/lighthouse/v20200324/api.json +14 -14
  103. tccli/services/lighthouse/v20200324/examples.json +5 -5
  104. tccli/services/live/live_client.py +480 -120
  105. tccli/services/lke/lke_client.py +360 -90
  106. tccli/services/lke/v20231130/api.json +182 -39
  107. tccli/services/lkeap/__init__.py +4 -0
  108. tccli/services/lkeap/lkeap_client.py +546 -0
  109. tccli/services/lkeap/v20240522/api.json +855 -0
  110. tccli/services/lkeap/v20240522/examples.json +72 -0
  111. tccli/services/mariadb/mariadb_client.py +200 -50
  112. tccli/services/mdc/mdc_client.py +72 -18
  113. tccli/services/mdl/mdl_client.py +132 -33
  114. tccli/services/mdl/v20200326/api.json +186 -12
  115. tccli/services/mdl/v20200326/examples.json +16 -16
  116. tccli/services/mdp/mdp_client.py +680 -70
  117. tccli/services/mdp/v20200527/api.json +748 -23
  118. tccli/services/mdp/v20200527/examples.json +143 -79
  119. tccli/services/message/__init__.py +4 -0
  120. tccli/services/message/message_client.py +210 -0
  121. tccli/services/message/v20181225/api.json +72 -0
  122. tccli/services/message/v20181225/examples.json +13 -0
  123. tccli/services/mongodb/mongodb_client.py +340 -29
  124. tccli/services/mongodb/v20190725/api.json +811 -226
  125. tccli/services/mongodb/v20190725/examples.json +54 -22
  126. tccli/services/monitor/monitor_client.py +864 -152
  127. tccli/services/monitor/v20180724/api.json +657 -8
  128. tccli/services/monitor/v20180724/examples.json +152 -4
  129. tccli/services/mps/mps_client.py +592 -92
  130. tccli/services/mps/v20190612/api.json +2931 -399
  131. tccli/services/mps/v20190612/examples.json +64 -14
  132. tccli/services/msp/msp_client.py +28 -7
  133. tccli/services/ocr/ocr_client.py +212 -45
  134. tccli/services/ocr/v20181119/api.json +872 -112
  135. tccli/services/ocr/v20181119/examples.json +12 -4
  136. tccli/services/omics/omics_client.py +80 -20
  137. tccli/services/organization/organization_client.py +464 -116
  138. tccli/services/postgres/postgres_client.py +364 -91
  139. tccli/services/postgres/v20170312/api.json +134 -109
  140. tccli/services/postgres/v20170312/examples.json +14 -14
  141. tccli/services/privatedns/privatedns_client.py +124 -31
  142. tccli/services/pts/pts_client.py +192 -48
  143. tccli/services/quota/__init__.py +4 -0
  144. tccli/services/quota/quota_client.py +434 -0
  145. tccli/services/quota/v20241204/api.json +548 -0
  146. tccli/services/quota/v20241204/examples.json +51 -0
  147. tccli/services/rce/rce_client.py +4 -1
  148. tccli/services/redis/redis_client.py +592 -106
  149. tccli/services/redis/v20180412/api.json +636 -240
  150. tccli/services/redis/v20180412/examples.json +98 -56
  151. tccli/services/region/region_client.py +12 -3
  152. tccli/services/rum/rum_client.py +240 -60
  153. tccli/services/scf/scf_client.py +168 -42
  154. tccli/services/ses/ses_client.py +116 -29
  155. tccli/services/sms/sms_client.py +72 -18
  156. tccli/services/sqlserver/sqlserver_client.py +3772 -387
  157. tccli/services/sqlserver/v20180328/api.json +9760 -3380
  158. tccli/services/sqlserver/v20180328/examples.json +478 -18
  159. tccli/services/ssl/ssl_client.py +152 -38
  160. tccli/services/ssm/ssm_client.py +96 -24
  161. tccli/services/sts/sts_client.py +20 -5
  162. tccli/services/tag/tag_client.py +120 -30
  163. tccli/services/tat/tat_client.py +76 -19
  164. tccli/services/tbaas/tbaas_client.py +16 -4
  165. tccli/services/tcaplusdb/tcaplusdb_client.py +208 -52
  166. tccli/services/tcaplusdb/v20190823/api.json +836 -760
  167. tccli/services/tcaplusdb/v20190823/examples.json +3 -3
  168. tccli/services/tchd/tchd_client.py +4 -1
  169. tccli/services/tcmpp/tcmpp_client.py +416 -104
  170. tccli/services/tcr/tcr_client.py +304 -76
  171. tccli/services/tcsas/tcsas_client.py +236 -59
  172. tccli/services/tcsas/v20250106/api.json +155 -79
  173. tccli/services/tcsas/v20250106/examples.json +3 -3
  174. tccli/services/tcss/tcss_client.py +1320 -330
  175. tccli/services/tdid/tdid_client.py +192 -48
  176. tccli/services/tdmq/tdmq_client.py +376 -94
  177. tccli/services/tem/tem_client.py +224 -56
  178. tccli/services/teo/teo_client.py +1127 -245
  179. tccli/services/teo/v20220901/api.json +382 -58
  180. tccli/services/teo/v20220901/examples.json +24 -0
  181. tccli/services/tione/__init__.py +4 -0
  182. tccli/services/tione/tione_client.py +210 -0
  183. tccli/services/tione/v20211111/api.json +3074 -0
  184. tccli/services/tione/v20211111/examples.json +12 -0
  185. tccli/services/tiw/tiw_client.py +204 -51
  186. tccli/services/tke/tke_client.py +552 -138
  187. tccli/services/tms/tms_client.py +4 -1
  188. tccli/services/tmt/tmt_client.py +4 -1
  189. tccli/services/trabbit/trabbit_client.py +116 -29
  190. tccli/services/trro/trro_client.py +76 -19
  191. tccli/services/trtc/trtc_client.py +420 -55
  192. tccli/services/trtc/v20190722/api.json +685 -23
  193. tccli/services/trtc/v20190722/examples.json +39 -7
  194. tccli/services/tts/tts_client.py +4 -1
  195. tccli/services/vclm/vclm_client.py +8 -2
  196. tccli/services/vm/vm_client.py +16 -4
  197. tccli/services/vod/v20180717/examples.json +1 -1
  198. tccli/services/vod/vod_client.py +716 -179
  199. tccli/services/vpc/v20170312/api.json +970 -75
  200. tccli/services/vpc/v20170312/examples.json +106 -10
  201. tccli/services/vpc/vpc_client.py +1876 -361
  202. tccli/services/waf/v20180125/api.json +1372 -194
  203. tccli/services/waf/v20180125/examples.json +89 -1
  204. tccli/services/waf/waf_client.py +1051 -147
  205. tccli/services/wedata/v20250806/api.json +13644 -0
  206. tccli/services/wedata/v20250806/examples.json +621 -0
  207. tccli/services/wedata/wedata_client.py +5830 -1026
  208. tccli/services/yunjing/yunjing_client.py +284 -71
  209. {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/METADATA +4 -7
  210. {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/RECORD +214 -192
  211. {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/WHEEL +1 -1
  212. {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/entry_points.txt +0 -1
  213. {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/LICENSE +0 -0
  214. {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.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",
@@ -21,6 +28,13 @@
21
28
  "output": "CreateCloudSliceTaskResponse",
22
29
  "status": "online"
23
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
+ },
24
38
  "DeleteCloudRecording": {
25
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.",
26
40
  "input": "DeleteCloudRecordingRequest",
@@ -56,6 +70,13 @@
56
70
  "output": "DescribeCallDetailInfoResponse",
57
71
  "status": "online"
58
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
+ },
59
80
  "DescribeCloudRecording": {
60
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.",
61
82
  "input": "DescribeCloudRecordingRequest",
@@ -196,6 +217,13 @@
196
217
  "output": "DismissRoomByStrRoomIdResponse",
197
218
  "status": "online"
198
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
+ },
199
227
  "ModifyCloudRecording": {
200
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.",
201
229
  "input": "ModifyCloudRecordingRequest",
@@ -253,7 +281,7 @@
253
281
  "status": "online"
254
282
  },
255
283
  "StartPublishCdnStream": {
256
- "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 ) .",
257
285
  "input": "StartPublishCdnStreamRequest",
258
286
  "name": "Starts a relaying task",
259
287
  "output": "StartPublishCdnStreamResponse",
@@ -649,6 +677,66 @@
649
677
  ],
650
678
  "usage": "in"
651
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.comom/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
+ },
652
740
  "CloudSliceStorage": {
653
741
  "document": "Information about Tencent COS and third-party cloud storage accounts.",
654
742
  "members": [
@@ -830,6 +918,106 @@
830
918
  ],
831
919
  "type": "object"
832
920
  },
921
+ "CreateCloudModerationRequest": {
922
+ "document": "CreateCloudModeration request structure.",
923
+ "members": [
924
+ {
925
+ "disabled": false,
926
+ "document": "[SdkAppId](https://www.tencentcloud.comom/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.comom/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
+ },
833
1021
  "CreateCloudRecordingRequest": {
834
1022
  "document": "CreateCloudRecording request structure.",
835
1023
  "members": [
@@ -1066,6 +1254,52 @@
1066
1254
  ],
1067
1255
  "type": "object"
1068
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
+ },
1069
1303
  "DeleteCloudRecordingRequest": {
1070
1304
  "document": "DeleteCloudRecording request structure.",
1071
1305
  "members": [
@@ -1448,6 +1682,72 @@
1448
1682
  ],
1449
1683
  "type": "object"
1450
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
+ },
1451
1751
  "DescribeCloudRecordingRequest": {
1452
1752
  "document": "DescribeCloudRecording request structure.",
1453
1753
  "members": [
@@ -3021,7 +3321,7 @@
3021
3321
  {
3022
3322
  "disabled": false,
3023
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.",
3024
- "example": "{\"UserInfo\":{\"UserId\":\"user_a\"}}",
3324
+ "example": "",
3025
3325
  "member": "UserMediaStream",
3026
3326
  "name": "UserMediaStream",
3027
3327
  "required": false,
@@ -3102,7 +3402,7 @@
3102
3402
  {
3103
3403
  "disabled": false,
3104
3404
  "document": "Custom cropping.",
3105
- "example": "{\"Height\":720,\"LocationX\":400,\"LocationY\":0,\"Width\":480}",
3405
+ "example": "",
3106
3406
  "member": "McuCustomCrop",
3107
3407
  "name": "CustomCrop",
3108
3408
  "required": false,
@@ -3504,7 +3804,7 @@
3504
3804
  {
3505
3805
  "disabled": false,
3506
3806
  "document": "The video encoding parameters.",
3507
- "example": "{\"Width\":1280,\"Height\":720,\"Fps\":15,\"BitRate\":1130,\"Gop\":2}",
3807
+ "example": "",
3508
3808
  "member": "VideoEncode",
3509
3809
  "name": "VideoEncode",
3510
3810
  "required": false,
@@ -3513,7 +3813,7 @@
3513
3813
  {
3514
3814
  "disabled": false,
3515
3815
  "document": "The layout parameters.",
3516
- "example": "{\"MixLayoutMode\":3}",
3816
+ "example": "",
3517
3817
  "member": "McuLayoutParams",
3518
3818
  "name": "LayoutParams",
3519
3819
  "required": false,
@@ -3540,7 +3840,7 @@
3540
3840
  {
3541
3841
  "disabled": false,
3542
3842
  "document": "The watermark information for the mixed stream.",
3543
- "example": "[{\"WaterMarkImage\":{\"WaterMarkUrl\":\"***.png\",\"WaterMarkWidth\":192,\"WaterMarkHeight\":79,\"LocationX\":0,\"LocationY\":0}}]",
3843
+ "example": "",
3544
3844
  "member": "McuWaterMarkParams",
3545
3845
  "name": "WaterMarkList",
3546
3846
  "required": false,
@@ -4020,21 +4320,229 @@
4020
4320
  ],
4021
4321
  "usage": "in"
4022
4322
  },
4023
- "ModifyCloudRecordingRequest": {
4024
- "document": "ModifyCloudRecording request structure.",
4323
+ "ModerationParams": {
4324
+ "document": "Control parameters for cloud moderation.",
4025
4325
  "members": [
4026
4326
  {
4027
4327
  "disabled": false,
4028
- "document": "The `SDKAppID` of the room whose streams are recorded.",
4029
- "example": "1234",
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",
4030
4330
  "member": "uint64",
4031
- "name": "SdkAppId",
4032
- "required": true,
4331
+ "name": "ModerationType",
4332
+ "required": false,
4033
4333
  "type": "int"
4034
4334
  },
4035
4335
  {
4036
4336
  "disabled": false,
4037
- "document": "The unique ID of the recording task, which is returned after recording starts successfully.",
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 the hit file. 0: not save by default; 1: save.",
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",
4503
+ "required": false,
4504
+ "type": "object"
4505
+ }
4506
+ ],
4507
+ "type": "object"
4508
+ },
4509
+ "ModifyCloudModerationResponse": {
4510
+ "document": "ModifyCloudModeration response structure.",
4511
+ "members": [
4512
+ {
4513
+ "disabled": false,
4514
+ "document": "Unique ID of the moderation task, which is returned after the task is started.",
4515
+ "example": "-npVoIhU7uxalbjwbc-qxKyKqluNl93bUmLFI4K-4pycoZWQndibYzKsC3HkljEK3HikwogUxwE.",
4516
+ "member": "string",
4517
+ "name": "TaskId",
4518
+ "output_required": true,
4519
+ "type": "string",
4520
+ "value_allowed_null": false
4521
+ },
4522
+ {
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.",
4524
+ "member": "string",
4525
+ "name": "RequestId",
4526
+ "type": "string"
4527
+ }
4528
+ ],
4529
+ "type": "object"
4530
+ },
4531
+ "ModifyCloudRecordingRequest": {
4532
+ "document": "ModifyCloudRecording request structure.",
4533
+ "members": [
4534
+ {
4535
+ "disabled": false,
4536
+ "document": "The `SDKAppID` of the room whose streams are recorded.",
4537
+ "example": "1234",
4538
+ "member": "uint64",
4539
+ "name": "SdkAppId",
4540
+ "required": true,
4541
+ "type": "int"
4542
+ },
4543
+ {
4544
+ "disabled": false,
4545
+ "document": "The unique ID of the recording task, which is returned after recording starts successfully.",
4038
4546
  "example": "1234",
4039
4547
  "member": "string",
4040
4548
  "name": "TaskId",
@@ -4200,7 +4708,7 @@
4200
4708
  {
4201
4709
  "disabled": false,
4202
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.",
4203
- "example": "",
4711
+ "example": "[\"en\",\"jp\"]",
4204
4712
  "member": "string",
4205
4713
  "name": "AlternativeLanguage",
4206
4714
  "required": false,
@@ -4908,7 +5416,7 @@
4908
5416
  {
4909
5417
  "disabled": false,
4910
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.",
4911
- "example": "",
5419
+ "example": "14600000",
4912
5420
  "member": "uint64",
4913
5421
  "name": "SdkAppId",
4914
5422
  "required": true,
@@ -4917,7 +5425,7 @@
4917
5425
  {
4918
5426
  "disabled": false,
4919
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.",
4920
- "example": "",
5428
+ "example": "11",
4921
5429
  "member": "string",
4922
5430
  "name": "RoomId",
4923
5431
  "required": true,
@@ -4935,7 +5443,7 @@
4935
5443
  {
4936
5444
  "disabled": false,
4937
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",
4938
- "example": "",
5446
+ "example": "session_1",
4939
5447
  "member": "string",
4940
5448
  "name": "SessionId",
4941
5449
  "required": false,
@@ -4944,7 +5452,7 @@
4944
5452
  {
4945
5453
  "disabled": false,
4946
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.",
4947
- "example": "",
5455
+ "example": "0",
4948
5456
  "member": "uint64",
4949
5457
  "name": "RoomIdType",
4950
5458
  "required": false,
@@ -4958,6 +5466,15 @@
4958
5466
  "name": "RecognizeConfig",
4959
5467
  "required": false,
4960
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"
4961
5478
  }
4962
5479
  ],
4963
5480
  "type": "object"
@@ -5625,6 +6142,56 @@
5625
6142
  ],
5626
6143
  "usage": "in"
5627
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
+ },
5628
6195
  "SubscribeStreamUserIds": {
5629
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.",
5630
6197
  "members": [
@@ -5703,6 +6270,23 @@
5703
6270
  ],
5704
6271
  "usage": "out"
5705
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
+ },
5706
6290
  "TencentVod": {
5707
6291
  "document": "The Tencent Cloud VOD parameters.",
5708
6292
  "members": [
@@ -5790,6 +6374,34 @@
5790
6374
  ],
5791
6375
  "usage": "in"
5792
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
+ },
5793
6405
  "TimeValue": {
5794
6406
  "document": "The quality data, which consists of the `time` and `value` parameters.",
5795
6407
  "members": [
@@ -5822,7 +6434,7 @@
5822
6434
  {
5823
6435
  "disabled": false,
5824
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.",
5825
- "example": "user123",
6437
+ "example": "user329",
5826
6438
  "member": "string",
5827
6439
  "name": "UserId",
5828
6440
  "required": true,
@@ -5831,7 +6443,7 @@
5831
6443
  {
5832
6444
  "disabled": false,
5833
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.",
5834
- "example": "",
6446
+ "example": "egjirneiwrwq",
5835
6447
  "member": "string",
5836
6448
  "name": "UserSig",
5837
6449
  "required": true,
@@ -5840,7 +6452,7 @@
5840
6452
  {
5841
6453
  "disabled": false,
5842
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.",
5843
- "example": "",
6455
+ "example": "60",
5844
6456
  "member": "uint64",
5845
6457
  "name": "MaxIdleTime",
5846
6458
  "required": false,
@@ -5849,7 +6461,7 @@
5849
6461
  {
5850
6462
  "disabled": false,
5851
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.",
5852
- "example": "",
6464
+ "example": "1",
5853
6465
  "member": "uint64",
5854
6466
  "name": "TranscriptionMode",
5855
6467
  "required": false,
@@ -5858,7 +6470,7 @@
5858
6470
  {
5859
6471
  "disabled": false,
5860
6472
  "document": "Required when TranscriptionMode is 1. The robot will only pull the stream of the userid and ignore other users in the room.",
5861
- "example": "",
6473
+ "example": "user219",
5862
6474
  "member": "string",
5863
6475
  "name": "TargetUserId",
5864
6476
  "required": false,
@@ -5867,6 +6479,56 @@
5867
6479
  ],
5868
6480
  "usage": "in"
5869
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
+ },
5870
6532
  "TrtcUsage": {
5871
6533
  "document": "The TRTC audio/video duration generated in a certain time period.",
5872
6534
  "members": [