tccli 3.0.845.1__py2.py3-none-any.whl → 3.0.847.1__py2.py3-none-any.whl

tccli/services/tiw/v20190919/examples.json

@@ -1,5 +1,29 @@
 {
   "actions": {
+    "ApplyTiwTrial": [
+      {
+        "document": "",
+        "input": "https://tiw.tencentcloudapi.com/?Action=ApplyTiwTrial\n&<公共请求参数>",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\"\n    }\n}",
+        "title": "申请互动白板试用"
+      }
+    ],
+    "CreateApplication": [
+      {
+        "document": "创建白板应用",
+        "input": "https://tiw.tencentcloudapi.com/?Action=CreateApplication\n&SdkAppId=1400000001\n&AppName=ForTest\n&SKey=xxxx\n&TinyId=xxxx\n&<公共请求参数>",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\",\n        \"AppId\": 1200000001,\n        \"SdkAppId\": 1400000001,\n        \"AppName\": \"ForTest\"\n    }\n}",
+        "title": "创建白板应用"
+      }
+    ],
+    "CreateOfflineRecord": [
+      {
+        "document": "创建课后录制任务",
+        "input": "https://tiw.tencentcloudapi.com/?Action=CreateOfflineRecord\n&SdkAppId=1400000001\n&RoomId=8000\n&GroupId=8000\n&MixStream.Enabled=true\n&MixStream.ModelId=1\n&Whiteboard.Width=1280\n&Whiteboard.Height=960\n&<公共请求参数>",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"eac6b301-a322-493a-8e36-83b295459397\"\n    }\n}",
+        "title": "创建课后录制任务"
+      }
+    ],
     "CreateSnapshotTask": [
       {
         "document": "",
@@ -30,6 +54,62 @@
         "title": "开始录制视频生成"
       }
     ],
+    "DescribeAPIService": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: tiw.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAPIService\n<公共请求参数>\n\n{\n    \"Service\": \"cos:GetService\",\n    \"Data\": \"\"\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"51a33e48-a808-4fe7-8c02-4e7be5245351\",\n        \"ResponseData\": \"{\\\"Bucket\\\": \\\"test\\\"}\"\n    }\n}",
+        "title": "查询COS桶列表"
+      }
+    ],
+    "DescribeApplicationInfos": [
+      {
+        "document": "查询白板应用列表",
+        "input": "https://tiw.tencentcloudapi.com/?Action=DescribeApplicationInfos\n&<公共请求参数>",
+        "output": "{\n    \"Response\": {\n        \"ApplicationInfos\": [\n            {\n                \"TagList\": [\n                    {\n                        \"TagKey\": \"tag_key\",\n                        \"TagValue\": \"tag_value\"\n                    }\n                ],\n                \"SdkAppId\": \"1400000001\",\n                \"AppName\": \"ForTest\",\n                \"CreateTime\": \"2019-11-10 00:00:00\"\n            }\n        ],\n        \"AllOption\": 1,\n        \"RequestId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\"\n    }\n}",
+        "title": "查询白板应用列表"
+      }
+    ],
+    "DescribeApplicationUsage": [
+      {
+        "document": "按天查询白板用量",
+        "input": "POST / HTTP/1.1\nHost: tiw.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeApplicationUsage\n<公共请求参数>\n\n{\n    \"TimeLevel\": \"DAILY\",\n    \"SubProduct\": \"sp_tiw_ric\",\n    \"BeginTime\": \"2019-10-01 00:00:00\",\n    \"SdkAppId\": 1400000001,\n    \"IsWeighted\": true,\n    \"EndTime\": \"2019-12-31 00:00:00\"\n}",
+        "output": "{\n    \"Response\": {\n        \"Data\": [\n            {\n                \"Details\": [\n                    {\n                        \"Value\": 0.1,\n                        \"Weight\": 0.1,\n                        \"TagName\": \"tag_name\"\n                    }\n                ],\n                \"Value\": 23773611121,\n                \"Time\": \"2019-11-10 00:00:00\"\n            }\n        ],\n        \"RequestId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\"\n    }\n}",
+        "title": "查询白板用量"
+      }
+    ],
+    "DescribeBoardSDKLog": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: tiw.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBoardSDKLog\n<公共请求参数>\n\n{\n    \"SdkAppId\": 1400000001,\n    \"RoomId\": \"73394291\",\n    \"UserId\": \"tic_web\",\n    \"TimeRange\": [\n        1614519034000,\n        1614691834999\n    ],\n    \"Context\": \"\",\n    \"AggregationInterval\": \"1h\",\n    \"Query\": \"\",\n    \"Ascending\": true\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"52214ab1-eeaa-4c9a-aa8f-6c501f7cae18\",\n        \"Total\": 65,\n        \"Context\": \"\",\n        \"Sources\": [],\n        \"Buckets\": []\n    }\n}",
+        "title": "查询白板日志"
+      }
+    ],
+    "DescribeIMApplications": [
+      {
+        "document": "查询可用于创建白板应用的IM应用列表",
+        "input": "https://tiw.tencentcloudapi.com/?Action=DescribeIMApplications\n&<公共请求参数>",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\"\n    }\n}",
+        "title": "查询IM应用列表"
+      }
+    ],
+    "DescribeOfflineRecord": [
+      {
+        "document": "查询课后录制任务",
+        "input": "https://tiw.tencentcloudapi.com/?Action=DescribeOfflineRecord\n&SdkAppId=1400000001\n&TaskId=00e1jv8ve0jcqk7da9lb\n&<公共请求参数>",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\"\n    }\n}",
+        "title": "查询课后录制任务"
+      }
+    ],
+    "DescribeOfflineRecordCallback": [
+      {
+        "document": "查询课后录制回调地址",
+        "input": "https://tiw.tencentcloudapi.com/?Action=DescribeOfflineRecordCallback\n&SdkAppId=1400000001\n&<公共请求参数>",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"eac6b301-a322-493a-8e36-83b295459397\"\n    }\n}",
+        "title": "查询课后录制回调地址"
+      }
+    ],
     "DescribeOnlineRecord": [
       {
         "document": "",
@@ -52,6 +132,14 @@
         "title": "查询实时录制回调地址"
       }
     ],
+    "DescribePostpaidUsage": [
+      {
+        "document": "查询用户后付费用量",
+        "input": "https://tiw.tencentcloudapi.com/?Action=DescribePostpaidUsage\n&BeginTime=2019-12-16 10:44:58\n&EndTime=2019-12-16 10:44:58\n&<公共请求参数>",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\"\n    }\n}",
+        "title": "查询用户后付费用量"
+      }
+    ],
     "DescribeQualityMetrics": [
       {
         "document": "",
@@ -60,6 +148,14 @@
         "title": "查询白板图片加载失败统计"
       }
     ],
+    "DescribeRoomList": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: tiw.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRoomList\n<公共请求参数>\n\n{\n    \"SdkAppId\": 1400000001,\n    \"Query\": \"*\",\n    \"MaxSize\": 1000,\n    \"TimeRange\": [\n        1614519034000,\n        1615190492000\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"7f560a64-d7fb-476b-89b9-2b90acc5c675\",\n        \"RoomList\": [\n            {\n                \"RoomId\": \"108594741\",\n                \"StartTime\": 1614851243268,\n                \"EndTime\": 1614851284952,\n                \"UserNumber\": 1\n            }\n        ]\n    }\n}",
+        "title": "查询白板房间列表"
+      }
+    ],
     "DescribeSnapshotTask": [
       {
         "document": "",
@@ -106,6 +202,46 @@
         "title": "查询文档转码回调地址"
       }
     ],
+    "DescribeTranscodeSearch": [
+      {
+        "document": "",
+        "input": "https://tiw.tencentcloudapi.com/?Action=DescribeTranscodeSearch\n&Offset=0\n&Limit=1\n&Keyword=拼音\n&<公共请求参数>",
+        "output": "{\n    \"Response\": {\n        \"TranscodeTaskSet\": [\n            {\n                \"CreateTime\": \"2020-08-21T16:05:36+08:00\",\n                \"Status\": \"FINISHED\",\n                \"TaskId\": \"ggdb2vjdnc3lp0k0ovsb\",\n                \"OriginalFilename\": \"拼音.pptx\",\n                \"SdkAppId\": 1400127140,\n                \"IsStatic\": false,\n                \"Result\": {\n                    \"ResultUrl\": \"https://whiteboard-cam-test-1257307760.cos.ap-nanjing.myqcloud.com/doc/ggdb2vjdnc3lp0k0ovsb_tiw/h5/index.html\",\n                    \"Resolution\": \"960x540\",\n                    \"Title\": \"拼音.pptx\",\n                    \"Pages\": 20,\n                    \"ThumbnailUrl\": \"\",\n                    \"ThumbnailResolution\": \"\",\n                    \"CompressFileUrl\": \"\",\n                    \"ErrorCode\": 0,\n                    \"ErrorMsg\": \"ppt convert sucess!\"\n                }\n            }\n        ],\n        \"TotalCount\": 1340,\n        \"RequestId\": \"bc309eaa-6d64-11e8-a7fe-5254000b4175\"\n    }\n}",
+        "title": "成功"
+      }
+    ],
+    "DescribeUsageSummary": [
+      {
+        "document": "查询子产品用量统计",
+        "input": "https://tiw.tencentcloudapi.com/?Action=DescribeUsageSummary\n&BeginTime=2019-12-30 11:41:58\n&EndTime=2019-12-30 11:42:06\n&SubProducts.0=sp_tiw_dt\n&SubProducts.1=sp_tiw_st\n&IsWeighted=true\n&<公共请求参数>",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"70443084-c60f-4f8e-a4f9-acb791802298\"\n    }\n}",
+        "title": "查询子产品用量统计"
+      }
+    ],
+    "DescribeUserList": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: tiw.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeUserList\n<公共请求参数>\n\n{\n    \"SdkAppId\": 1400000001,\n    \"RoomId\": \"0\",\n    \"Query\": \"*\",\n    \"MaxSize\": 1000,\n    \"TimeRange\": [\n        1614519034000,\n        1615190492000\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"7f560a64-d7fb-476b-89b9-2b90acc5c675\",\n        \"UserList\": [\n            {\n                \"UserId\": \"131001012\",\n                \"StartTime\": 1614519034000,\n                \"EndTime\": 1615190492000\n            }\n        ]\n    }\n}",
+        "title": "查询白板用户列表"
+      }
+    ],
+    "DescribeUserResources": [
+      {
+        "document": "查询客户资源列表",
+        "input": "https://tiw.tencentcloudapi.com/?Action=DescribeUserResources\n&<公共请求参数>",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\"\n    }\n}",
+        "title": "查询客户资源列表"
+      }
+    ],
+    "DescribeUserStatus": [
+      {
+        "document": "",
+        "input": "https://tiw.tencentcloudapi.com/?Action=DescribeUserStatus\n&<公共请求参数>",
+        "output": "{\n    \"Response\": {\n        \"AppId\": 1250000060,\n        \"IsTiwUser\": 1,\n        \"IsSaaSUser\": 1,\n        \"IsTiwOfflineRecordUser\": 1,\n        \"IsAuthenticated\": 1,\n        \"RequestId\": \"9f5a59d6-2b77-41b2-a945-78084577e225\"\n    }\n}",
+        "title": "查询互动白板用户详情"
+      }
+    ],
     "DescribeVideoGenerationTask": [
       {
         "document": "",
@@ -122,6 +258,22 @@
         "title": "查询录制视频生成回调地址"
       }
     ],
+    "DescribeWhiteboardApplicationConfig": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: tiw.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeWhiteboardApplicationConfig\n<公共请求参数>\n\n{\n    \"SdkAppId\": 1400000001,\n    \"TaskTypes\": [\n        \"transcode\",\n        \"recording\"\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"Configs\": [\n            {\n                \"BucketLocation\": \"ap-nanjing\",\n                \"BucketName\": \"example-120000001\",\n                \"BucketPrefix\": \"video\",\n                \"Callback\": \"http://www.test.com\",\n                \"CallbackKey\": \"\",\n                \"ResultDomain\": \"example-120000001.cos.ap-nanjing.myqcloud.com\",\n                \"TaskType\": \"recording\",\n                \"SdkAppId\": 1400127140\n            },\n            {\n                \"BucketLocation\": \"ap-nanjing\",\n                \"BucketName\": \"example-120000001\",\n                \"BucketPrefix\": \"\",\n                \"Callback\": \"http://www.test.com/qcapi\",\n                \"CallbackKey\": \"abcde\",\n                \"ResultDomain\": \"example-120000001.cos.ap-nanjing.myqcloud.com\",\n                \"TaskType\": \"transcode\",\n                \"SdkAppId\": 1400127140\n            }\n        ],\n        \"SdkAppId\": 1400127140,\n        \"RequestId\": \"9f5a59d6-2b77-41b2-a945-78084577e225\"\n    }\n}",
+        "title": "查询应用资源配置"
+      }
+    ],
+    "DescribeWhiteboardBucketConfig": [
+      {
+        "document": "",
+        "input": "https://tiw.tencentcloudapi.com/?Action=DescribeWhiteboardBucketConfig\n&SdkAppId=1400000001\n&TaskType=recording\n&<公共请求参数>",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\"\n    }\n}",
+        "title": "查询应用资源配置"
+      }
+    ],
     "DescribeWhiteboardPush": [
       {
         "document": "",
@@ -144,6 +296,46 @@
         "title": "查询白板推流回调地址"
       }
     ],
+    "DescribeWhiteboardPushSearch": [
+      {
+        "document": "",
+        "input": "https://tiw.tencentcloudapi.com/?Action=DescribeWhiteboardPushSearch\n&Offset=0\n&Limit=1\n&RoomId=101069223\n&<公共请求参数>",
+        "output": "{\n    \"Response\": {\n        \"WhiteboardPushTaskSet\": [\n            {\n                \"CreateTime\": \"2021-01-15T12:43:57+08:00\",\n                \"RoomId\": 101069223,\n                \"TaskId\": \"01bjgeeigsh31f3rh00c\",\n                \"Status\": \"STOPPED\",\n                \"SdkAppId\": 1400313729,\n                \"PushUserId\": \"tic_push_user_101069223_107991\",\n                \"Result\": {\n                    \"RoomId\": 101069223,\n                    \"GroupId\": \"101069223\",\n                    \"FinishReason\": \"USER_CALL\",\n                    \"ExceptionCnt\": 0,\n                    \"PushStartTime\": 1610685839,\n                    \"PushStopTime\": 1610685852,\n                    \"IMSyncTime\": 0,\n                    \"ErrorCode\": 0,\n                    \"ErrorMsg\": \"\"\n                }\n            }\n        ],\n        \"TotalCount\": 1,\n        \"RequestId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\"\n    }\n}",
+        "title": "成功"
+      }
+    ],
+    "ModifyApplication": [
+      {
+        "document": "创建白板应用",
+        "input": "https://tiw.tencentcloudapi.com/?Action=ModifyApplication\n&SdkAppId=1400000001\n&AppName=ForTest\n&<公共请求参数>",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\"\n    }\n}",
+        "title": "修改白板应用"
+      }
+    ],
+    "ModifyAutoRenewFlag": [
+      {
+        "document": "",
+        "input": "https://tiw.tencentcloudapi.com/?Action=ModifyAutoRenewFlag\n&SubProduct=sp_tiw_package\n&ResourceId=sp_tiw_package-251006355-prepaid-1\n&AutoRenewFlag=1\n&<公共请求参数>",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\"\n    }\n}",
+        "title": "设置白板月功能费自动续费"
+      }
+    ],
+    "ModifyWhiteboardApplicationConfig": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: tiw.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyWhiteboardApplicationConfig\n<公共请求参数>\n\n{\n    \"Configs\": [\n        {\n            \"AdminUserId\": \"abcde\",\n            \"BucketPrefix\": \"doc\",\n            \"ResultDomain\": \"xxx\",\n            \"AdminUserSig\": \"abcde\",\n            \"Callback\": \"http://www.example.com/callback\",\n            \"BucketName\": \"test-120000001\",\n            \"SdkAppId\": 1400000001,\n            \"TaskType\": \"recording\",\n            \"BucketLocation\": \"ap-guangzhou\",\n            \"CallbackKey\": \"abcde\"\n        }\n    ],\n    \"SdkAppId\": 1400000001\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\"\n    }\n}",
+        "title": "修改白板应用任务相关配置"
+      }
+    ],
+    "ModifyWhiteboardBucketConfig": [
+      {
+        "document": "",
+        "input": "https://tiw.tencentcloudapi.com/?Action=ModifyWhiteboardBucketConfig\n&SdkAppId=1400000001\n&TaskType=recording\n&BucketLocation=ap-guangzhou\n&BucketName=test-120000001\n&BucketPrefix=doc\n&ResultDomain=https://bucket.com\n&<公共请求参数>",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\"\n    }\n}",
+        "title": "设置应用资源配置"
+      }
+    ],
     "PauseOnlineRecord": [
       {
         "document": "",
@@ -160,6 +352,14 @@
         "title": "恢复实时录制任务"
       }
     ],
+    "SetOfflineRecordCallback": [
+      {
+        "document": "",
+        "input": "https://tiw.tencentcloudapi.com/?Action=SetOfflineRecordCallback\n&SdkAppId=1400000001\n&Callback=https://example.com/offline/callback\n&<公共请求参数>",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"eac6b301-a322-493a-8e36-83b295459397\"\n    }\n}",
+        "title": "设置课后录制回调地址"
+      }
+    ],
     "SetOnlineRecordCallback": [
       {
         "document": "",

tccli/services/trtc/v20190722/api.json

@@ -225,7 +225,7 @@
       "status": "online"
     },
     "StartPublishCdnStream": {
-      "document": "接口说明：启动旁路以及混流转推任务。TRTC 的房间中可能会同时存在多路音视频流，您可以通过此API接口，实现以下几种效果：\n1、支持将单个主播的音视频流发布（也称作“转推”）到直播CDN上，请参考示例2（发起单流音视频旁路转推）和示例3（发起单流纯音频旁路转推）。\n2、支持将同个房间多个主播或者不同房间多个主播的音视频混合成1路后再发布到直播CDN上，您可以通过AudioParams.SubscribeAudioList和VideoParams.LayoutParams调整参与混音的用户列表以及指定各路混流画面的布局位置。请参考示例1（发起混流转推）。\n3、支持预先设置一个房间的混流模板，将该房间中的多个音视频混合成1路发布到直播CDN，腾讯云后台实时监控TRTC房间中的主播变化，自动按照混流模板调整布局。目前已经支持了如下几种混流预设模板：\n     - 悬浮模板：第一个进入房间的用户的视频画面会铺满整个屏幕，其他用户的视频画面从左下角依次水平排列，显示为小画面，最多4行，每行4个，小画面悬浮于大画面之上。最多支持1个大画面和15个小画面。\n     - 九宫格模板：所有用户的视频画面大小一致，平分整个屏幕，人数越多，每个画面的尺寸越小，最多支持16个画面。\n     - 屏幕分享模板：适合视频会议和在线教育场景的布局，屏幕分享（或者主讲的摄像头）始终占据屏幕左侧的大画面位置，其他用户依次垂直排列于右侧，最多两列，每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时，左侧大画面为了保持内容的完整性采用缩放方式处理，右侧小画面采用裁剪方式处理。\n4、支持同时将音视频流发布到最多10个直播CDN上。您可以通过PublishCdnParams.PublishCdnUrl指定转推CDN的url，如果您想转推到腾讯云CDN，PublishCdnParams.IsTencentCdn填为1。\n5、支持通过配置服务端回调，实时将转推状态以HTTP/HTTPS POST 请求发送给您的服务器，如果您需要接入转推事件回调，请联系腾讯云技术支持。\n6、云API调用支持广州、上海、北京、香港四个地域，如果您想转推海外，请选择香港地域。\n7、国内站默认只支持转推腾讯云CDN，如您有转推第三方CDN的需求，请联系腾讯云技术支持，由后台进行评估。\n注意：\n1、**混流转码为收费功能，调用接口将产生云端混流转码费用，详见[云端混流转推计费说明](https://cloud.tencent.com/document/product/647/49446)。**\n2、**转推非腾讯云CDN将产生云端转推费用，详见[云端混流转推计费说明](https://cloud.tencent.com/document/product/647/82155)。**\n\n其他使用说明如下：\n1、使用混流转推接口时，您需要先调用启动转推任务接口（StartPublishCdnStream），获取启动转推任务响应中的任务ID标识（TaskId）。后续传入任务ID标识（TaskId）来更新转推任务（UpdatePublishCdnStream）和停止转推任务（StopPublishCdnStream）。\n2、为了确保转推链接的稳定，同一个转推任务不支持纯音频、音视频、纯视频之间的切换。\n3、为了确保转推链接的稳定，更新转推任务接口（UpdatePublishCdnStream）不支持时更改视频参数（codec）和音频参数（codec、采样率、码率、声道数），其余参数建议全量带齐。\n4、发起单流旁路任务时，AudioParams和VideoParams都填写表示音视频旁路，如果仅填写AudioParams表示纯音频旁路，任务进行过程中不支持纯音频到音视频的切换。音视频旁路时，VideoParams中的Width、Height、Fps、BitRate、Gop需要按照真实上行参数填写。\n5、更新转推任务（UpdatePublishCdnStream）必须携带SequenceNumber参数，用于防止请求乱序。客户保证对同一个任务更新时的SequenceNumber参数递增：腾讯云返回InternalError错误码时，需重试请求（不换SequenceNumber）；腾讯云返回FailedOperation.OutdateRequest过期错误码时，无需处理即可。\n6、您可以在主播进房前，提前创建转推任务，结束转推任务时需要主动调用停止接口。如果您没有调用停止转推任务接口时，腾讯云后台会按照所有参与混流的用户没有任何数据上行的时间算起，直到超过启动转推任务时设置的超时时间（AgentParams.MaxIdleTime）为止，自动停止混流转推任务。",
+      "document": "接口说明：启动旁路以及混流转推任务。TRTC 的房间中可能会同时存在多路音视频流，您可以通过此API接口，实现以下几种效果：\n1、支持将单个主播的音视频流发布（也称作“转推”）到直播CDN上，请参考示例2（发起单流音视频旁路转推）和示例3（发起单流纯音频旁路转推）。\n2、支持将同个房间多个主播或者不同房间多个主播的音视频混合成1路后再发布到直播CDN上，您可以通过AudioParams.SubscribeAudioList和VideoParams.LayoutParams调整参与混音的用户列表以及指定各路混流画面的布局位置。请参考示例1（发起混流转推）。\n3、支持预先设置一个房间的混流模板，将该房间中的多个音视频混合成1路发布到直播CDN，腾讯云后台实时监控TRTC房间中的主播变化，自动按照混流模板调整布局。目前已经支持了如下几种混流预设模板：\n     - 悬浮模板：第一个进入房间的用户的视频画面会铺满整个屏幕，其他用户的视频画面从左下角依次水平排列，显示为小画面，最多4行，每行4个，小画面悬浮于大画面之上。最多支持1个大画面和15个小画面。\n     - 九宫格模板：所有用户的视频画面大小一致，平分整个屏幕，人数越多，每个画面的尺寸越小，最多支持16个画面。\n     - 屏幕分享模板：适合视频会议和在线教育场景的布局，屏幕分享（或者主讲的摄像头）始终占据屏幕左侧的大画面位置，其他用户依次垂直排列于右侧，最多两列，每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时，左侧大画面为了保持内容的完整性采用缩放方式处理，右侧小画面采用裁剪方式处理。\n4、支持同时将音视频流发布到最多10个直播CDN上。您可以通过PublishCdnParams.PublishCdnUrl指定转推CDN的url，如果您想转推到腾讯云CDN，PublishCdnParams.IsTencentCdn填为1。\n5、支持通过配置服务端回调，实时将转推状态以HTTP/HTTPS POST 请求发送给您的服务器，如果您需要接入转推事件回调，请联系腾讯云技术支持。\n6、云API调用支持广州、上海、北京、香港四个地域，如果您想转推海外，请选择香港地域。\n7、国内站默认只支持转推腾讯云CDN，如您有转推第三方CDN的需求，请联系腾讯云技术支持，由后台进行评估。\n注意：\n1、**混流转码为收费功能，调用接口将产生云端混流转码费用，详见[云端混流转推计费说明](https://cloud.tencent.com/document/product/647/49446)。**\n2、**转推非腾讯云CDN将产生云端转推费用，详见[云端混流转推计费说明](https://cloud.tencent.com/document/product/647/82155)。**\n\n其他使用说明如下：\n1、使用混流转推接口时，您需要先调用启动转推任务接口（StartPublishCdnStream），获取启动转推任务响应中的任务ID标识（TaskId）。后续传入任务ID标识（TaskId）来更新转推任务（UpdatePublishCdnStream）和停止转推任务（StopPublishCdnStream）。\n2、为了确保转推链接的稳定，同一个转推任务不支持纯音频、音视频、纯视频之间的切换。\n3、为了确保转推链接的稳定，更新转推任务接口（UpdatePublishCdnStream）不支持时更改视频参数（codec）和音频参数（codec、采样率、码率、声道数），其余参数建议全量带齐，如您有转码/非转码切换，其余参数则必须全量带齐。\n4、发起单流旁路任务时，AudioParams和VideoParams都填写表示音视频旁路，如果仅填写AudioParams表示纯音频旁路，任务进行过程中不支持纯音频到音视频的切换。音视频旁路时，VideoParams中的Width、Height、Fps、BitRate、Gop需要按照真实上行参数填写。\n5、更新转推任务（UpdatePublishCdnStream）必须携带SequenceNumber参数，用于防止请求乱序。客户保证对同一个任务更新时的SequenceNumber参数递增：腾讯云返回InternalError错误码时，需重试请求（不换SequenceNumber）；腾讯云返回FailedOperation.OutdateRequest过期错误码时，无需处理即可。\n6、您可以在主播进房前，提前创建转推任务，结束转推任务时需要主动调用停止接口。如果您没有调用停止转推任务接口时，腾讯云后台会按照所有参与混流的用户没有任何数据上行的时间算起，直到超过启动转推任务时设置的超时时间（AgentParams.MaxIdleTime）为止，自动停止混流转推任务。",
       "input": "StartPublishCdnStreamRequest",
       "name": "启动转推任务",
       "output": "StartPublishCdnStreamResponse",
@@ -1873,7 +1873,32 @@
     },
     "DescribeTrtcRoomUsageRequest": {
       "document": "DescribeTrtcRoomUsage请求参数结构体",
-      "members": [],
+      "members": [
+        {
+          "document": "TRTC的SdkAppId，和房间所对应的SdkAppId相同。",
+          "example": "1400017192",
+          "member": "uint64",
+          "name": "SdkAppid",
+          "required": true,
+          "type": "int"
+        },
+        {
+          "document": "查询开始时间，格式为YYYY-MM-DD HH:MM，精确到分钟级。",
+          "example": "2023-01-06 00:00",
+          "member": "string",
+          "name": "StartTime",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "document": "查询结束时间，格式为YYYY-MM-DD HH:MM，单次查询不超过24h。",
+          "example": "2023-01-06 10:00",
+          "member": "string",
+          "name": "EndTime",
+          "required": true,
+          "type": "string"
+        }
+      ],
       "type": "object"
     },
     "DescribeTrtcRoomUsageResponse": {
@@ -2859,6 +2884,16 @@
           "required": false,
           "type": "object",
           "value_allowed_null": false
+        },
+        {
+          "default": "",
+          "document": "屏幕分享模板、悬浮模板、九宫格模版有效，画面在输出时的显示模式：0为裁剪，1为缩放，2为缩放并显示黑底",
+          "example": "0",
+          "member": "uint64",
+          "name": "RenderMode",
+          "required": false,
+          "type": "int",
+          "value_allowed_null": false
         }
       ],
       "usage": "in"
@@ -4684,7 +4719,6 @@
       "document": "StartPublishCdnStream请求参数结构体",
       "members": [
         {
-          "default": "",
           "document": "TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和转推的房间所对应的SdkAppId相同。",
           "example": "1400188366",
           "member": "uint64",
@@ -4693,7 +4727,6 @@
           "type": "int"
         },
         {
-          "default": "",
           "document": "主房间信息RoomId，转推的TRTC房间所对应的RoomId。",
           "example": "room_1234",
           "member": "string",
@@ -4702,7 +4735,6 @@
           "type": "string"
         },
         {
-          "default": "",
           "document": "主房间信息RoomType，必须和转推的房间所对应的RoomId类型相同，0为整形房间号，1为字符串房间号。",
           "example": "1",
           "member": "uint64",
@@ -4711,7 +4743,6 @@
           "type": "int"
         },
         {
-          "default": "",
           "document": "转推服务加入TRTC房间的机器人参数。",
           "example": "AgentParams",
           "member": "AgentParams",
@@ -4720,8 +4751,7 @@
           "type": "object"
         },
         {
-          "default": "",
-          "document": "是否转码，0表示无需转码，1表示需要转码。",
+          "document": "是否转码，0表示无需转码，1表示需要转码。是否收取转码费是由WithTranscoding参数决定的，WithTranscoding为0，表示旁路转推，不会收取转码费用，WithTranscoding为1，表示混流转推，会收取转吗费用。",
           "example": "1",
           "member": "uint64",
           "name": "WithTranscoding",
@@ -4729,8 +4759,7 @@
           "type": "int"
         },
         {
-          "default": "",
-          "document": "转推流的音频编码参数。",
+          "document": "转推流的音频编码参数。由于音频是必转码的（不会收取转码费用），所以启动任务的时候，必须填写。",
           "example": "AudioParams",
           "member": "McuAudioParams",
           "name": "AudioParams",
@@ -4738,7 +4767,6 @@
           "type": "object"
         },
         {
-          "default": "",
           "document": "转推流的视频编码参数，不填表示纯音频转推。",
           "example": "VideoParams",
           "member": "McuVideoParams",
@@ -4747,7 +4775,6 @@
           "type": "object"
         },
         {
-          "default": "",
           "document": "需要单流旁路转推的用户上行参数，单流旁路转推时，WithTranscoding需要设置为0。",
           "example": "SingleSubscribeParams",
           "member": "SingleSubscribeParams",
@@ -4756,8 +4783,7 @@
           "type": "object"
         },
         {
-          "default": "",
-          "document": "转推的CDN参数。",
+          "document": "转推的CDN参数。和回推房间参数必须要有一个。",
           "example": "PublishCdnParams",
           "member": "McuPublishCdnParam",
           "name": "PublishCdnParams",
@@ -4765,7 +4791,6 @@
           "type": "list"
         },
         {
-          "default": "",
           "document": "混流SEI参数",
           "example": "SeiParams",
           "member": "McuSeiParams",
@@ -4774,8 +4799,7 @@
           "type": "object"
         },
         {
-          "default": "",
-          "document": "回推房间信息",
+          "document": "回推房间信息，和转推CDN参数必须要有一个。",
           "example": "FeedBackRoomParams",
           "member": "McuFeedBackRoomParams",
           "name": "FeedBackRoomParams",
@@ -4793,7 +4817,6 @@
           "example": "5df46eb2-8e4b-490e-9c3c-dbd3b84faefc",
           "member": "string",
           "name": "TaskId",
-          "required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -5331,7 +5354,6 @@
       "document": "UpdatePublishCdnStream请求参数结构体",
       "members": [
         {
-          "default": "",
           "document": "TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和转推的房间所对应的SdkAppId相同。",
           "example": "1400188366",
           "member": "uint64",
@@ -5340,7 +5362,6 @@
           "type": "int"
         },
         {
-          "default": "",
           "document": "唯一标识转推任务。",
           "example": "xxxxxxxx",
           "member": "string",
@@ -5349,7 +5370,6 @@
           "type": "string"
         },
         {
-          "default": "",
           "document": "客户保证同一个任务，每次更新请求中的SequenceNumber递增，防止请求乱序。",
           "example": "2",
           "member": "uint64",
@@ -5358,7 +5378,6 @@
           "type": "int"
         },
         {
-          "default": "",
           "document": "是否转码，0表示无需转码，1表示需要转码。",
           "example": "1",
           "member": "uint64",
@@ -5367,7 +5386,6 @@
           "type": "int"
         },
         {
-          "default": "",
           "document": "更新相关参数，只支持更新参与混音的主播列表参数。不填表示不更新此参数。",
           "example": "AudioParams",
           "member": "McuAudioParams",
@@ -5376,7 +5394,6 @@
           "type": "object"
         },
         {
-          "default": "",
           "document": "更新视频相关参数，转码时支持更新除编码类型之外的编码参数，视频布局参数，背景图片和背景颜色参数，水印参数。不填表示不更新此参数。",
           "example": "VideoParams",
           "member": "McuVideoParams",
@@ -5385,7 +5402,6 @@
           "type": "object"
         },
         {
-          "default": "",
           "document": "更新单流转推的用户上行参数，仅在非转码时有效。不填表示不更新此参数。",
           "example": "SingleSubscribeParams",
           "member": "SingleSubscribeParams",
@@ -5394,7 +5410,6 @@
           "type": "object"
         },
         {
-          "default": "",
           "document": "更新转推的CDN参数。不填表示不更新此参数。",
           "example": "PublishCdnParams",
           "member": "McuPublishCdnParam",
@@ -5403,7 +5418,6 @@
           "type": "list"
         },
         {
-          "default": "",
           "document": "混流SEI参数",
           "example": "SeiParams",
           "member": "McuSeiParams",
@@ -5412,7 +5426,6 @@
           "type": "object"
         },
         {
-          "default": "",
           "document": "回推房间信息",
           "example": "FeedBackRoomParams",
           "member": "McuFeedBackRoomParams",
@@ -5431,7 +5444,6 @@
           "example": "xxxx",
           "member": "string",
           "name": "TaskId",
-          "required": true,
           "type": "string",
           "value_allowed_null": false
         },

tccli/services/trtc/v20190722/examples.json

@@ -154,8 +154,8 @@
     ],
     "DescribeTrtcRoomUsage": [
       {
-        "document": "",
-        "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTrtcRoomUsage\n<公共请求参数>\n\n{}",
+        "document": "查询TRTC音视频房间维度用量",
+        "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTrtcRoomUsage\n<公共请求参数>\n\n{\n    \"StartTime\": \"2023-01-06 00:00\",\n    \"EndTime\": \"2023-01-06 10:00\",\n    \"SdkAppid\": 1400017192\n}",
         "output": "{\n    \"Response\": {\n        \"RequestId\": \"68fccf1c-c2c7-466a-9f14-1db4bed6054b\"\n    }\n}",
         "title": "查询TRTC音视频房间维度用量"
       }
@@ -258,32 +258,32 @@
     ],
     "StartPublishCdnStream": [
       {
-        "document": "",
+        "document": "无",
         "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StartPublishCdnStream\n<公共请求参数>\n\n{\n    \"AudioParams\": {\n        \"SubscribeAudioList\": [\n            {\n                \"UserInfo\": {\n                    \"RoomIdType\": 0,\n                    \"RoomId\": \"195044\",\n                    \"UserId\": \"Trtc_User_0\"\n                }\n            },\n            {\n                \"UserInfo\": {\n                    \"RoomIdType\": 0,\n                    \"RoomId\": \"195044\",\n                    \"UserId\": \"Trtc_User_1\"\n                }\n            },\n            {\n                \"UserInfo\": {\n                    \"RoomIdType\": 0,\n                    \"RoomId\": \"195044\",\n                    \"UserId\": \"Trtc_User_2\"\n                }\n            },\n            {\n                \"UserInfo\": {\n                    \"RoomIdType\": 0,\n                    \"RoomId\": \"195044\",\n                    \"UserId\": \"Trtc_User_3\"\n                }\n            }\n        ],\n        \"AudioEncode\": {\n            \"SampleRate\": 48000,\n            \"Codec\": 0,\n            \"BitRate\": 64,\n            \"Channel\": 2\n        }\n    },\n    \"AgentParams\": {\n        \"MaxIdleTime\": 30,\n        \"UserSig\": \"eJw1zV8LgjAUBfCvInsO2dStGfQSQUb2pFJvsnLJJZW1LekPffdc6X08v8O5b5Snmd9LjRYeCnyMZt4vgUp2Fi7wB6vtuVRC207q0kpjSzIVTXUVSkE11EiEMeE8ZGw0*VCg5SCcDeRuBAutiwkLeRRwOo*nMajduy5O*gIaus9qel9vX*lJbHJmyDMxuKFFI27tsT*I1S6pl*jzBb*IOTE_\",\n        \"UserId\": \"trtc_partner_test_1\"\n    },\n    \"VideoParams\": {\n        \"VideoEncode\": {\n            \"Height\": 720,\n            \"Width\": 1280,\n            \"Fps\": 15,\n            \"BitRate\": 512,\n            \"Gop\": 2\n        },\n        \"LayoutParams\": {\n            \"PureAudioHoldPlaceMode\": 0,\n            \"MixLayoutMode\": 4,\n            \"MixLayoutList\": [\n                {\n                    \"LocationX\": 0,\n                    \"LocationY\": 0,\n                    \"UserMediaStream\": {\n                        \"StreamType\": 0,\n                        \"UserInfo\": {\n                            \"RoomIdType\": 0,\n                            \"RoomId\": \"195044\",\n                            \"UserId\": \"Trtc_User_0\"\n                        }\n                    },\n                    \"ZOrder\": 0,\n                    \"ImageHeight\": 360,\n                    \"ImageWidth\": 640,\n                    \"RenderMode\": 0\n                },\n                {\n                    \"LocationX\": 640,\n                    \"LocationY\": 0,\n                    \"UserMediaStream\": {\n                        \"StreamType\": 0,\n                        \"UserInfo\": {\n                            \"RoomIdType\": 0,\n                            \"RoomId\": \"195044\",\n                            \"UserId\": \"Trtc_User_1\"\n                        }\n                    },\n                    \"ZOrder\": 0,\n                    \"ImageHeight\": 360,\n                    \"ImageWidth\": 640,\n                    \"RenderMode\": 0\n                },\n                {\n                    \"LocationX\": 0,\n                    \"LocationY\": 360,\n                    \"UserMediaStream\": {\n                        \"StreamType\": 0,\n                        \"UserInfo\": {\n                            \"RoomIdType\": 0,\n                            \"RoomId\": \"195044\",\n                            \"UserId\": \"Trtc_User_2\"\n                        }\n                    },\n                    \"ZOrder\": 0,\n                    \"ImageHeight\": 360,\n                    \"ImageWidth\": 640,\n                    \"RenderMode\": 0\n                },\n                {\n                    \"LocationX\": 640,\n                    \"LocationY\": 360,\n                    \"UserMediaStream\": {\n                        \"StreamType\": 0,\n                        \"UserInfo\": {\n                            \"RoomIdType\": 0,\n                            \"RoomId\": \"195044\",\n                            \"UserId\": \"Trtc_User_3\"\n                        }\n                    },\n                    \"ZOrder\": 0,\n                    \"ImageHeight\": 360,\n                    \"ImageWidth\": 640,\n                    \"RenderMode\": 0\n                }\n            ]\n        },\n        \"BackGroundColor\": \"0xFF0000\",\n        \"WaterMarkList\": [\n            {\n                \"WaterMarkType\": 0,\n                \"WaterMarkImage\": {\n                    \"LocationX\": 64,\n                    \"LocationY\": 64,\n                    \"WaterMarkHeight\": 64,\n                    \"WaterMarkWidth\": 64,\n                    \"WaterMarkUrl\": \"https://xkt-course-1304449343.cos.ap-beijing.myqcloud.com/test/mark/37f9eb62-ca72-430e-bfca-e700b59b20e0.png\",\n                    \"ZOrder\": 3\n                }\n            }\n        ]\n    },\n    \"PublishCdnParams\": [\n        {\n            \"PublishCdnUrl\": \"rtmp://3891.livepush.myqcloud.com/live/trtc_publishcdn_test1\",\n            \"IsTencentCdn\": 0\n        },\n        {\n            \"PublishCdnUrl\": \"rtmp://3891.livepush.myqcloud.com/live/trtc_publishcdn_test2\",\n            \"IsTencentCdn\": 0\n        }\n    ],\n    \"RoomIdType\": 0,\n    \"SdkAppId\": 1400188366,\n    \"WithTranscoding\": 1,\n    \"RoomId\": \"195044\"\n}",
         "output": "{\n    \"Response\": {\n        \"TaskId\": \"-m97l2ZU7vxyBSmXYsRx1Xy9Kf4bVVfbbhSKC4K-4pycoZWKv542xbi139uTvGt1zAHoAQ..\",\n        \"RequestId\": \"b934c535-8d82-4f52-bd52-a1cbb043c4be\"\n    }\n}",
         "title": "发起混流转推"
       },
       {
-        "document": "",
+        "document": "无",
         "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StartPublishCdnStream\n<公共请求参数>\n\n{\n    \"AudioParams\": {\n        \"AudioEncode\": {\n            \"SampleRate\": 48000,\n            \"Codec\": 0,\n            \"BitRate\": 64,\n            \"Channel\": 2\n        }\n    },\n    \"AgentParams\": {\n        \"MaxIdleTime\": 30,\n        \"UserSig\": \"eJw1zV8LgjAUBfCvInsO2dStGfQSQUb2pFJvsnLJJZW1LekPffdc6X08v8O5b5Snmd9LjRYeCnyMZt4vgUp2Fi7wB6vtuVRC207q0kpjSzIVTXUVSkE11EiEMeE8ZGw0*VCg5SCcDeRuBAutiwkLeRRwOo*nMajduy5O*gIaus9qel9vX*lJbHJmyDMxuKFFI27tsT*I1S6pl*jzBb*IOTE_\",\n        \"UserId\": \"trtc_partner_test_1\"\n    },\n    \"VideoParams\": {\n        \"VideoEncode\": {\n            \"Height\": 720,\n            \"Width\": 1280,\n            \"Fps\": 15,\n            \"BitRate\": 512,\n            \"Gop\": 2\n        }\n    },\n    \"SingleSubscribeParams\": {\n        \"UserMediaStream\": {\n            \"StreamType\": 0,\n            \"UserInfo\": {\n                \"RoomIdType\": 0,\n                \"RoomId\": \"195044\",\n                \"UserId\": \"Trtc_User_0\"\n            }\n        }\n    },\n    \"PublishCdnParams\": [\n        {\n            \"PublishCdnUrl\": \"rtmp://3891.livepush.myqcloud.com/live/trtc_publishcdn_test1\",\n            \"IsTencentCdn\": 0\n        }\n    ],\n    \"RoomIdType\": 0,\n    \"SdkAppId\": 1400188366,\n    \"WithTranscoding\": 0,\n    \"RoomId\": \"195044\"\n}",
         "output": "{\n    \"Response\": {\n        \"TaskId\": \"-m97l2ZU7tq6nEsHR89259B8aCDblqnbGhWKC4K-4pycoZWpyHnld1jC9aCD+EU7V8WRAQ..\",\n        \"RequestId\": \"f23d95bf-ddaf-4d0c-86c0-6bf50c74c0a0\"\n    }\n}",
         "title": "发起单流音视频旁路转推"
       },
       {
-        "document": "",
+        "document": "无",
         "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StartPublishCdnStream\n<公共请求参数>\n\n{\n    \"AudioParams\": {\n        \"AudioEncode\": {\n            \"SampleRate\": 48000,\n            \"Codec\": 0,\n            \"BitRate\": 64,\n            \"Channel\": 2\n        }\n    },\n    \"AgentParams\": {\n        \"MaxIdleTime\": 30,\n        \"UserSig\": \"eJw1zV8LgjAUBfCvInsO2dStGfQSQUb2pFJvsnLJJZW1LekPffdc6X08v8O5b5Snmd9LjRYeCnyMZt4vgUp2Fi7wB6vtuVRC207q0kpjSzIVTXUVSkE11EiEMeE8ZGw0*VCg5SCcDeRuBAutiwkLeRRwOo*nMajduy5O*gIaus9qel9vX*lJbHJmyDMxuKFFI27tsT*I1S6pl*jzBb*IOTE_\",\n        \"UserId\": \"trtc_partner_test_1\"\n    },\n    \"SingleSubscribeParams\": {\n        \"UserMediaStream\": {\n            \"StreamType\": 0,\n            \"UserInfo\": {\n                \"RoomIdType\": 0,\n                \"RoomId\": \"195044\",\n                \"UserId\": \"Trtc_User_0\"\n            }\n        }\n    },\n    \"PublishCdnParams\": [\n        {\n            \"PublishCdnUrl\": \"rtmp://3891.livepush.myqcloud.com/live/trtc_publishcdn_test1\",\n            \"IsTencentCdn\": 0\n        }\n    ],\n    \"RoomIdType\": 0,\n    \"SdkAppId\": 1400188366,\n    \"WithTranscoding\": 0,\n    \"RoomId\": \"195044\"\n}",
         "output": "{\n    \"Response\": {\n        \"TaskId\": \"-m97l2ZU7r57nZBesMa84KgzxhH0OBbbCRaKC4K-4pycoZW7yFPtusNuZOen1Ca0qtQQAQ..\",\n        \"RequestId\": \"ef089f8b-d0d1-4131-894d-4edd68d61605\"\n    }\n}",
         "title": "发起单流纯音频旁路转推"
       },
       {
-        "document": "",
-        "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StartPublishCdnStream\n<公共请求参数>\n\n{\n    \"AudioParams\": {\n        \"SubscribeAudioList\": [\n            {\n                \"UserInfo\": {\n                    \"RoomIdType\": \"0\",\n                    \"RoomId\": \"295066\",\n                    \"UserId\": \"57906\"\n                }\n            }\n        ],\n        \"AudioEncode\": {\n            \"SampleRate\": \"48000\",\n            \"Codec\": \"0\",\n            \"BitRate\": \"64\",\n            \"Channel\": \"2\"\n        }\n    },\n    \"AgentParams\": {\n        \"MaxIdleTime\": \"10\",\n        \"UserSig\": \"eJw1zV8LgjAUBfCvInsO2dStGfQSQUb2pFJvsnLJJZW1LekPffdc6X08v8O5b5Snmd9LjRYeCnyMZt4vgUp2Fi7wB6vtuVRC207q0kpjSzIVTXUVSkE11EiEMeE8ZGw0*VCg5SCcDeRuBAutiwkLeRRwOo*nMajduy5O*gIaus9qel9vX*lJbHJmyDMxuKFFI27tsT*I1S6pl*jzBb*IOTE_\",\n        \"UserId\": \"trtc_partner_test_1\"\n    },\n    \"VideoParams\": {\n        \"VideoEncode\": {\n            \"Height\": \"720\",\n            \"Width\": \"1280\",\n            \"Fps\": \"15\",\n            \"BitRate\": \"512\",\n            \"Gop\": \"2\"\n        },\n        \"LayoutParams\": {\n            \"MixLayoutMode\": \"4\",\n            \"MixLayoutList\": [\n                {\n                    \"LocationX\": \"0\",\n                    \"LocationY\": \"0\",\n                    \"UserMediaStream\": {\n                        \"StreamType\": \"0\",\n                        \"UserInfo\": {\n                            \"RoomIdType\": \"0\",\n                            \"RoomId\": \"295066\",\n                            \"UserId\": \"57906\"\n                        }\n                    },\n                    \"ZOrder\": \"0\",\n                    \"ImageHeight\": \"0\",\n                    \"ImageWidth\": \"0\",\n                    \"RenderMode\": \"0\"\n                }\n            ]\n        }\n    },\n    \"PublishCdnParams\": [\n        {\n            \"PublishCdnUrl\": \"rtmp://3891.livepush.myqcloud.com/live/1400188366_owen_main_1\"\n        }\n    ],\n    \"RoomIdType\": \"0\",\n    \"SdkAppId\": \"1400188366\",\n    \"WithTranscoding\": \"1\",\n    \"RoomId\": \"295066\"\n}",
+        "document": "无",
+        "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StartPublishCdnStream\n<公共请求参数>\n\n{\n    \"AudioParams\": {\n        \"SubscribeAudioList\": [\n            {\n                \"UserInfo\": {\n                    \"RoomIdType\": 0,\n                    \"RoomId\": \"295066\",\n                    \"UserId\": \"57906\"\n                }\n            }\n        ],\n        \"AudioEncode\": {\n            \"SampleRate\": 48000,\n            \"Codec\": 0,\n            \"BitRate\": 64,\n            \"Channel\": 2\n        }\n    },\n    \"AgentParams\": {\n        \"MaxIdleTime\": 10,\n        \"UserSig\": \"eJw1zV8LgjAUBfCvInsO2dStGfQSQUb2pFJvsnLJJZW1LekPffdc6X08v8O5b5Snmd9LjRYeCnyMZt4vgUp2Fi7wB6vtuVRC207q0kpjSzIVTXUVSkE11EiEMeE8ZGw0*VCg5SCcDeRuBAutiwkLeRRwOo*nMajduy5O*gIaus9qel9vX*lJbHJmyDMxuKFFI27tsT*I1S6pl*jzBb*IOTE_\",\n        \"UserId\": \"trtc_partner_test_1\"\n    },\n    \"VideoParams\": {\n        \"VideoEncode\": {\n            \"Height\": 720,\n            \"Width\": 1280,\n            \"Fps\": 15,\n            \"BitRate\": 512,\n            \"Gop\": 2\n        },\n        \"LayoutParams\": {\n            \"MixLayoutMode\": 4,\n            \"MixLayoutList\": [\n                {\n                    \"LocationX\": 0,\n                    \"LocationY\": 0,\n                    \"UserMediaStream\": {\n                        \"StreamType\": 0,\n                        \"UserInfo\": {\n                            \"RoomIdType\": 0,\n                            \"RoomId\": \"295066\",\n                            \"UserId\": \"57906\"\n                        }\n                    },\n                    \"ZOrder\": 0,\n                    \"ImageHeight\": 0,\n                    \"ImageWidth\": 0,\n                    \"RenderMode\": 0\n                }\n            ]\n        }\n    },\n    \"PublishCdnParams\": [\n        {\n            \"PublishCdnUrl\": \"rtmp://3891.livepush.myqcloud.com/live/1400188366_owen_main_1\"\n        }\n    ],\n    \"RoomIdType\": 0,\n    \"SdkAppId\": 1400188366,\n    \"WithTranscoding\": 1,\n    \"RoomId\": \"295066\"\n}",
         "output": "{\n    \"Response\": {\n        \"TaskId\": \"-m9liFNU7m+nWPL+icY53kcSoQ+-czzbEhD2AYK-4pycoZXmj3cMGzreW5xwhHTpcPRNAQ..\",\n        \"RequestId\": \"6774662b-64a0-4aec-8389-0513873585b4\"\n    }\n}",
         "title": "音视频上行，只混纯音频，和透传上行SEI"
       },
       {
-        "document": "",
-        "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StartPublishCdnStream\n<公共请求参数>\n\n{\n    \"AudioParams\": {\n        \"AudioEncode\": {\n            \"SampleRate\": \"48000\",\n            \"Codec\": \"0\",\n            \"BitRate\": \"64\",\n            \"Channel\": \"2\"\n        }\n    },\n    \"AgentParams\": {\n        \"MaxIdleTime\": \"10\",\n        \"UserSig\": \"eJw1zV8LgjAUBfCvInsO2dStGfQSQUb2pFJvsnLJJZW1LekPffdc6X08v8O5b5Snmd9LjRYeCnyMZt4vgUp2Fi7wB6vtuVRC207q0kpjSzIVTXUVSkE11EiEMeE8ZGw0*VCg5SCcDeRuBAutiwkLeRRwOo*nMajduy5O*gIaus9qel9vX*lJbHJmyDMxuKFFI27tsT*I1S6pl*jzBb*IOTE_\",\n        \"UserId\": \"trtc_partner_test_1\"\n    },\n    \"VideoParams\": {\n        \"VideoEncode\": {\n            \"Height\": \"720\",\n            \"Width\": \"1280\",\n            \"Fps\": \"15\",\n            \"BitRate\": \"512\",\n            \"Gop\": \"2\"\n        },\n        \"LayoutParams\": {\n            \"MixLayoutMode\": \"4\",\n            \"MixLayoutList\": [\n                {\n                    \"LocationX\": \"0\",\n                    \"LocationY\": \"0\",\n                    \"UserMediaStream\": {\n                        \"StreamType\": \"0\",\n                        \"UserInfo\": {\n                            \"RoomIdType\": \"0\",\n                            \"RoomId\": \"295066\",\n                            \"UserId\": \"57906\"\n                        }\n                    },\n                    \"ZOrder\": \"0\",\n                    \"ImageHeight\": \"640\",\n                    \"ImageWidth\": \"1280\",\n                    \"RenderMode\": \"0\"\n                }\n            ]\n        }\n    },\n    \"PublishCdnParams\": [\n        {\n            \"PublishCdnUrl\": \"rtmp://3891.livepush.myqcloud.com/live/1400188366_owen_main_1\"\n        }\n    ],\n    \"RoomIdType\": \"0\",\n    \"SdkAppId\": \"1400188366\",\n    \"WithTranscoding\": \"1\",\n    \"RoomId\": \"295066\"\n}",
+        "document": "无",
+        "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StartPublishCdnStream\n<公共请求参数>\n\n{\n    \"AudioParams\": {\n        \"AudioEncode\": {\n            \"SampleRate\": 48000,\n            \"Codec\": 0,\n            \"BitRate\": 64,\n            \"Channel\": 2\n        }\n    },\n    \"AgentParams\": {\n        \"MaxIdleTime\": 10,\n        \"UserSig\": \"eJw1zV8LgjAUBfCvInsO2dStGfQSQUb2pFJvsnLJJZW1LekPffdc6X08v8O5b5Snmd9LjRYeCnyMZt4vgUp2Fi7wB6vtuVRC207q0kpjSzIVTXUVSkE11EiEMeE8ZGw0*VCg5SCcDeRuBAutiwkLeRRwOo*nMajduy5O*gIaus9qel9vX*lJbHJmyDMxuKFFI27tsT*I1S6pl*jzBb*IOTE_\",\n        \"UserId\": \"trtc_partner_test_1\"\n    },\n    \"VideoParams\": {\n        \"VideoEncode\": {\n            \"Height\": 720,\n            \"Width\": 1280,\n            \"Fps\": 15,\n            \"BitRate\": 512,\n            \"Gop\": 2\n        },\n        \"LayoutParams\": {\n            \"MixLayoutMode\": 4,\n            \"MixLayoutList\": [\n                {\n                    \"LocationX\": 0,\n                    \"LocationY\": 0,\n                    \"UserMediaStream\": {\n                        \"StreamType\": 0,\n                        \"UserInfo\": {\n                            \"RoomIdType\": 0,\n                            \"RoomId\": \"295066\",\n                            \"UserId\": \"57906\"\n                        }\n                    },\n                    \"ZOrder\": 0,\n                    \"ImageHeight\": 640,\n                    \"ImageWidth\": 1280,\n                    \"RenderMode\": 0\n                }\n            ]\n        }\n    },\n    \"PublishCdnParams\": [\n        {\n            \"PublishCdnUrl\": \"rtmp://3891.livepush.myqcloud.com/live/1400188366_owen_main_1\"\n        }\n    ],\n    \"RoomIdType\": 0,\n    \"SdkAppId\": 1400188366,\n    \"WithTranscoding\": 1,\n    \"RoomId\": \"295066\"\n}",
         "output": "{\n    \"Response\": {\n        \"TaskId\": \"-m9liFNU7qjpXnrk6cloz8KXukyLKjzbLhP2AYK-4pycoZVbtyt6U21l9vJOqqeIfwR5AQ..\",\n        \"RequestId\": \"97dae8e4-4778-45c8-9abe-cdce33c1a450\"\n    }\n}",
         "title": "混一个人的音视频，和房间所有人的声音"
       }
@@ -320,7 +320,7 @@
         "title": "更新混音和布局参数"
       },
       {
-        "document": "",
+        "document": "无",
         "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdatePublishCdnStream\n<公共请求参数>\n\n{\n    \"SdkAppId\": 1400188366,\n    \"TaskId\": \"-m97l2ZU7kOlV5cTRMoU6yoGp2nDYkzbJ13EC4K-4pycoZXVv+XVrNoUXQ8++8Z2PwUlAQ..\",\n    \"SequenceNumber\": 20,\n    \"WithTranscoding\": 1,\n    \"PublishCdnParams\": [\n        {\n            \"IsTencentCdn\": 1,\n            \"PublishCdnUrl\": \"rtmp://3891.livepush.myqcloud.com/live/trtc_publishcdn_test2?bizid=3891&txSecret=23aeb6ec16fd275af0d00a447b2282f7&txTime=62635BDE\"\n        }\n    ]\n}",
         "output": "{\n    \"Response\": {\n        \"RequestId\": \"71993312-6ab8-4768-9124-118e0a20c45f\",\n        \"TaskId\": \"xxxx\"\n    }\n}",
         "title": "更新转推参数"