tccli 3.0.1407.1__py2.py3-none-any.whl → 3.1.6.1__py2.py3-none-any.whl

tccli/services/trtc/v20190722/api.json

@@ -22,7 +22,7 @@
       "status": "online"
     },
     "CreateCloudRecording": {
-      "document": "接口说明：\n启动云端录制功能，完成房间内的音视频录制，并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制又或者多路视频画面合流混成一路。\n\n您可以通过此接口实现如下目标：\n* 指定订阅流参数（RecordParams）来指定需要录制的主播的黑名单或者白名单。\n* 指定录制存储参数（StorageParams）来指定上传到您希望的云存储，目前支持腾讯云（云点播VOD、对象存储COS）和第三方AWS\n* 指定合流模式下的音视频转码详细参数（MixTranscodeParams），包括视频分辨率、视频码率、视频帧率、以及声音质量等\n* 指定合流模式各路画面的位置和布局或者也可以指定自动模板的方式来配置。\n\n关键名词：\n* 单流录制：分别录制房间的订阅UserId的音频和视频，录制服务会实时将录制文件上传至您指定的云存储。\n* 合流录制：将房间内订阅UserId的音视频混录成一个视频文件，并将录制文件上传至您指定的云存储。（录制结束后可前往云点播控制台https://console.cloud.tencent.com/vod/media 或 对象存储COS控制台https://console.cloud.tencent.com/cos/bucket查看文件）。",
+      "document": "接口说明：\n启动云端录制功能，完成房间内的音视频录制，并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制又或者多路视频画面合流混成一路。\n在线上正式运营之前，请关注录制的最佳实践 [录制最佳实践](https://cloud.tencent.com/document/product/647/76497#e7e2f04c-6cde-43c9-9cd0-0f8d22dee68c)，配合最佳实践，可大大提高接口录制的可用性。\n\n您可以通过此接口实现如下目标：\n* 指定订阅流参数（RecordParams）来指定需要录制的主播的黑名单或者白名单。\n* 指定录制存储参数（StorageParams）来指定上传到您希望的云存储，目前支持腾讯云（云点播VOD、对象存储COS）和第三方AWS\n* 指定合流模式下的音视频转码详细参数（MixTranscodeParams），包括视频分辨率、视频码率、视频帧率、以及声音质量等\n* 指定合流模式各路画面的位置和布局或者也可以指定自动模板的方式来配置。\n\n关键名词：\n* 单流录制：分别录制房间的订阅UserId的音频和视频，录制服务会实时将录制文件上传至您指定的云存储。\n* 合流录制：将房间内订阅UserId的音视频混录成一个视频文件，并将录制文件上传至您指定的云存储。（录制结束后可前往云点播控制台https://console.cloud.tencent.com/vod/media 或 对象存储COS控制台https://console.cloud.tencent.com/cos/bucket查看文件）。",
       "input": "CreateCloudRecordingRequest",
       "name": "开始云端录制",
       "output": "CreateCloudRecordingResponse",
@@ -930,7 +930,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "生成的音频格式，默认pcm，目前支持的格式列表：[pcm]。",
+          "document": "生成的音频格式，默认pcm，目前支持的格式列表：流式：[pcm]，非流式 [pcm，wav]",
           "example": "pcm",
           "member": "string",
           "name": "Format",
@@ -938,6 +938,17 @@
           "required": false,
           "type": "string",
           "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "采样率，默认24000， 可选16000, 24000 ",
+          "example": "24000",
+          "member": "uint64",
+          "name": "SampleRate",
+          "output_required": false,
+          "required": false,
+          "type": "int",
+          "value_allowed_null": false
         }
       ],
       "usage": "both"
@@ -5667,7 +5678,7 @@
         },
         {
           "disabled": false,
-          "document": "图片的url地址， 只支持jpg, png, jpeg，大小限制不超过5M。注意，url必须携带格式后缀，url内只支持特定的字符串, 范围是a-z A-Z 0-9 '-', '.', '_', '~', ':', '/', '?', '#', '[', ']' '@', '!', '&', '(', ')', '*', '+', ',', '%', '='",
+          "document": "图片的url地址， 只支持jpg, png, jpeg，图片分辨率限制不超过2K，图片大小限制不超过5MB。注意，url必须携带格式后缀，url内只支持特定的字符串, 范围是a-z A-Z 0-9 '-', '.', '_', '~', ':', '/', '?', '#', '[', ']' '@', '!', '&', '(', ')', '*', '+', ',', '%', '='",
           "example": "https://xxxx/image.jpg,  https://xxxx/image.jpg?token=xxx",
           "member": "string",
           "name": "SubBackgroundImage",
@@ -5727,7 +5738,7 @@
         },
         {
           "disabled": false,
-          "document": "图片的url地址，只支持jpg, png, jpeg，大小限制不超过5M。注意，url必须携带格式后缀，url内只支持特定的字符串, 范围是a-z A-Z 0-9 '-', '.', '_', '~', ':', '/', '?', '#', '[', ']' '@', '!', '&', '(', ')', '*', '+', ',', '%', '='",
+          "document": "图片的url地址，只支持jpg, png, jpeg，图片分辨率限制不超过2K，图片大小限制不超过5MB。注意，url必须携带格式后缀，url内只支持特定的字符串, 范围是a-z A-Z 0-9 '-', '.', '_', '~', ':', '/', '?', '#', '[', ']' '@', '!', '&', '(', ')', '*', '+', ',', '%', '='",
           "example": "https://xxxx/image.jpg,  https://xxxx/image.jpg?token=xxx",
           "member": "string",
           "name": "BackgroundImageUrl",
@@ -5754,7 +5765,7 @@
         },
         {
           "disabled": false,
-          "document": "子画面占位图url地址，只支持jpg, png, jpeg，大小限制不超过5M。注意，url必须携带格式后缀，url内只支持特定的字符串, 范围是a-z A-Z 0-9 '-', '.', '_', '~', ':', '/', '?', '#', '[', ']' '@', '!', '&', '(', ')', '*', '+', ',', '%', '='",
+          "document": "子画面占位图url地址，只支持jpg, png, jpeg，图片分辨率限制不超过2K，图片大小限制不超过5MB。注意，url必须携带格式后缀，url内只支持特定的字符串, 范围是a-z A-Z 0-9 '-', '.', '_', '~', ':', '/', '?', '#', '[', ']' '@', '!', '&', '(', ')', '*', '+', ',', '%', '='",
           "example": "https://xxxx/image.jpg,  https://xxxx/image.jpg?token=xxx",
           "member": "string",
           "name": "DefaultSubBackgroundImage",
@@ -7358,6 +7369,15 @@
           "name": "AddHistory",
           "required": false,
           "type": "bool"
+        },
+        {
+          "disabled": false,
+          "document": "如果填写，会和字幕绑定发送到端上，注意确保内容为json字符串",
+          "example": "\"{\\\"custom_msg\\\": 100}\"",
+          "member": "string",
+          "name": "MetaInfo",
+          "required": false,
+          "type": "string"
         }
       ],
       "usage": "in"
@@ -8175,38 +8195,20 @@
       "members": [
         {
           "disabled": false,
-          "document": "需要录制的网页URL\n",
+          "document": "【必填】需要录制的网页URL",
           "example": "https://web-record-xxxx.cos.ap-xxx.xxx.com/test/xxx.mp4",
           "member": "string",
           "name": "RecordUrl",
           "required": true,
           "type": "string"
         },
-        {
-          "disabled": false,
-          "document": "录制最大时长限制， 单位 s, 合法取值范围[1800, 36000], 默认 36000s(10 小时)\n",
-          "example": "36000",
-          "member": "uint64",
-          "name": "MaxDurationLimit",
-          "required": false,
-          "type": "int"
-        },
         {
           "disabled": false,
           "document": "【必填】云存储相关的参数，目前支持腾讯云对象存储以及腾讯云云点播VOD，不支持第三方云存储；输出文件的存储格式仅支持hls或mp4",
           "example": "无",
           "member": "StorageParams",
           "name": "StorageParams",
-          "required": false,
-          "type": "object"
-        },
-        {
-          "disabled": false,
-          "document": "页面录制视频参数",
-          "example": "无",
-          "member": "WebRecordVideoParams",
-          "name": "WebRecordVideoParams",
-          "required": false,
+          "required": true,
           "type": "object"
         },
         {
@@ -8215,9 +8217,27 @@
           "example": "1600011111",
           "member": "int64",
           "name": "SdkAppId",
+          "required": true,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "录制最大时长限制， 单位 s, 合法取值范围[1800, 86400], 默认 86400s(24 小时)",
+          "example": "86400",
+          "member": "uint64",
+          "name": "MaxDurationLimit",
           "required": false,
           "type": "int"
         },
+        {
+          "disabled": false,
+          "document": "页面录制视频参数",
+          "example": "无",
+          "member": "WebRecordVideoParams",
+          "name": "WebRecordVideoParams",
+          "required": false,
+          "type": "object"
+        },
         {
           "disabled": false,
           "document": "当对重复任务敏感时，请关注此值： 为了避免任务在短时间内重复发起，导致任务重复\n传入录制RecordId来标识此次任务， 小于32字节，若携带RecordId发起两次以上的开始录制请求，任务只会启动一个，第二个报错FailedOperation.TaskExist。注意StartWebRecord调用失败时而非FailedOperation.TaskExist错误，请更换RecordId重新发起。",
@@ -8763,13 +8783,46 @@
         {
           "disabled": false,
           "document": "音色ID",
-          "example": "xiaoming",
+          "example": "v-female-R2s4N9qJ",
           "member": "string",
           "name": "VoiceId",
           "output_required": false,
           "required": true,
           "type": "string",
           "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "TTS 的模型，默认是：flow_01_turbo, 可选: [ flow_01_turbo, flow_01_ex]",
+          "example": "flow_01_turbo",
+          "member": "string",
+          "name": "Model",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "语速，范围 0.5-2.0，默认 1.0",
+          "example": "1.0",
+          "member": "float",
+          "name": "Speed",
+          "output_required": false,
+          "required": false,
+          "type": "float",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "(0, 10] 默认值1.0",
+          "example": "1.0",
+          "member": "float",
+          "name": "Volume",
+          "output_required": false,
+          "required": false,
+          "type": "float",
+          "value_allowed_null": false
         }
       ],
       "usage": "both"
@@ -8929,13 +8982,31 @@
           "type": "object"
         },
         {
-          "disabled": false,
+          "disabled": true,
           "document": "TTS的API密钥",
           "example": "sk-xxxxxx",
           "member": "string",
           "name": "APIKey",
           "required": false,
           "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "TTS的模型：flow_01_turbo，flow_01_ex",
+          "example": "flow_01_turbo",
+          "member": "string",
+          "name": "Model",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "语言参数，默认为空， 参考： (ISO 639-1) ",
+          "example": "zh",
+          "member": "string",
+          "name": "Language",
+          "required": false,
+          "type": "string"
         }
       ],
       "type": "object"
@@ -9009,6 +9080,24 @@
           "name": "APIKey",
           "required": false,
           "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "TTS的模型：flow_01_turbo，flow_01_ex",
+          "example": "flow_01_turbo",
+          "member": "string",
+          "name": "Model",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "语言参数，默认为空， 参考： (ISO 639-1) ",
+          "example": "zh",
+          "member": "string",
+          "name": "Language",
+          "required": false,
+          "type": "string"
         }
       ],
       "type": "object"
@@ -9857,6 +9946,39 @@
           "required": true,
           "type": "string",
           "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "语速，范围 0.5-2.0，默认 1.0",
+          "example": "1.0",
+          "member": "float",
+          "name": "Speed",
+          "output_required": false,
+          "required": false,
+          "type": "float",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "(0, 10]   默认值1.0 ",
+          "example": "1.0",
+          "member": "float",
+          "name": "Volume",
+          "output_required": false,
+          "required": false,
+          "type": "float",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "取值[-12,12],默认0",
+          "example": "0",
+          "member": "int64",
+          "name": "Pitch",
+          "output_required": false,
+          "required": false,
+          "type": "int",
+          "value_allowed_null": false
         }
       ],
       "usage": "both"
@@ -9908,6 +10030,24 @@
           "name": "PromptText",
           "required": false,
           "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "TTS的模型：flow_01_turbo，flow_01_ex",
+          "example": "flow_01_turbo",
+          "member": "string",
+          "name": "Model",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "语言参数，默认为空， 参考： (ISO 639-1) ",
+          "example": "zh",
+          "member": "string",
+          "name": "Language",
+          "required": false,
+          "type": "string"
         }
       ],
       "type": "object"

tccli/services/trtc/v20190722/examples.json

@@ -495,7 +495,7 @@
     "StartWebRecord": [
       {
         "document": "",
-        "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StartWebRecord\n<公共请求参数>\n\n{\n    \"RecordUrl\": \"https://web-record-xxxxx.cos.ap-xxx.myqcloud.com/xxxx/xxx.mp4\",\n    \"StorageParams\": {\n        \"CloudStorage\": {\n            \"Vendor\": 0,\n            \"Bucket\": \"webrecord-1234589\",\n            \"Region\": \"ap-chengdu\",\n            \"AccessKey\": \"AKxxxxxx\",\n            \"SecretKey\": \"Idxxxxxx\",\n            \"FileNamePrefix\": [\n                \"record\",\n                \"video\"\n            ]\n        }\n    },\n    \"MaxDurationLimit\": 3600,\n    \"WebRecordVideoParams\": {\n        \"Width\": 1280,\n        \"Height\": 720,\n        \"Format\": \"mp4\"\n    }\n}",
+        "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StartWebRecord\n<公共请求参数>\n\n{\n    \"RecordUrl\": \"https://web-record-xxxxx.cos.ap-xxx.myqcloud.com/xxxx/xxx.mp4\",\n    \"StorageParams\": {\n        \"CloudStorage\": {\n            \"Vendor\": 0,\n            \"Bucket\": \"webrecord-1234589\",\n            \"Region\": \"ap-chengdu\",\n            \"AccessKey\": \"AKxxxxxx\",\n            \"SecretKey\": \"Idxxxxxx\",\n            \"FileNamePrefix\": [\n                \"record\",\n                \"video\"\n            ]\n        }\n    },\n    \"SdkAppId\": 1600011111,\n    \"MaxDurationLimit\": 3600,\n    \"WebRecordVideoParams\": {\n        \"Width\": 1280,\n        \"Height\": 720,\n        \"Format\": \"mp4\"\n    }\n}",
         "output": "{\n    \"Response\": {\n        \"TaskId\": \"HMLm5HWNuUAXSb0gTEOx0z1x+nLMZNjXrY3keyUSvu7uu8mF9O656uNtbUtvaWLkpMY134jTN2Ix4vuqgOJ68nQ8tho3ri\",\n        \"RequestId\": \"2a76ee73-6579-42f0-8d57-1f6c9b9d7208\"\n    }\n}",
         "title": "启动一个页面录制任务"
       }
@@ -559,7 +559,7 @@
     "TextToSpeech": [
       {
         "document": "",
-        "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: TextToSpeech\n<公共请求参数>\n\n{\n  \"Text\": \"你好呀\",\n  \"SdkAppId\": 1466000000,\n  \"Voice\": {\n     \"VoiceId\": \"256\"\n  }\n}\n\n",
+        "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: TextToSpeech\n<公共请求参数>\n\n{\n    \"Text\": \"你好呀\",\n    \"SdkAppId\": 1466000000,\n    \"Voice\": {\n        \"VoiceId\": \"256\"\n    }\n}",
         "output": "{\n    \"Response\": {\n        \"Audio\": \"inxxx\",\n        \"RequestId\": \"3c140219-cfe9-470e-b241-907877d6fb03\"\n    }\n}",
         "title": "开始一个语音合成"
       }
@@ -567,7 +567,7 @@
     "TextToSpeechSSE": [
       {
         "document": "启动一个SSE流式语音合成，注意在解析时，音频的Type为chunk，其他的Type 非音频",
-        "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: TextToSpeechSSE\n<公共请求参数>\n\n{\n   \"Text\": \"你好呀\",\n    \"SdkAppId\": 14600000000,\n    \"Voice\": {\n        \"VoiceId\": \"256\"\n    }\n}\n\n",
+        "input": "POST / HTTP/1.1\nHost: trtc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: TextToSpeechSSE\n<公共请求参数>\n\n{\n    \"Text\": \"你好呀\",\n    \"SdkAppId\": 14600000000,\n    \"Voice\": {\n        \"VoiceId\": \"256\"\n    }\n}",
         "output": "data: {\"Type\": \"chunk\", \"RequestId\": \"456e7890-e12b-34d5-a678-426614174000\", \"ChunkId\": \"chunk_0\", \"Audio\": \"base64编码的音频数据...\", \"Seq\": 0, \"IsEnd\": false}\n\ndata: {\"Type\": \"chunk\", \"RequestId\": \"456e7890-e12b-34d5-a678-426614174000\", \"ChunkId\": \"chunk_1\", \"Audio\": \"base64编码的音频数据...\", \"Seq\": 1, \"IsEnd\": false}\n\ndata: {\"Type\": \"chunk\", \"RequestId\": \"456e7890-e12b-34d5-a678-426614174000\", \"ChunkId\": \"chunk_2\", \"Audio\": \"base64编码的音频数据...\", \"Seq\": 2, \"IsEnd\": true}",
         "title": "启动一个SSE流式语音合成"
       }