tccli 3.0.1221.1__py2.py3-none-any.whl → 3.0.1223.1__py2.py3-none-any.whl

tccli/services/trtc/v20190722/api.json

@@ -573,7 +573,7 @@
         {
           "disabled": false,
           "document": "转推服务加入TRTC房间的用户签名，当前 UserId 对应的验证签名，相当于登录密码，具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。",
-          "example": "xxxx",
+          "example": "无",
           "member": "string",
           "name": "UserSig",
           "required": false,
@@ -3461,12 +3461,11 @@
         {
           "disabled": false,
           "document": "用户媒体流参数。",
-          "example": "UserMediaStream",
+          "example": "无",
           "member": "UserMediaStream",
           "name": "UserMediaStream",
           "required": true,
-          "type": "object",
-          "value_allowed_null": false
+          "type": "object"
         }
       ],
       "usage": "in"
@@ -3477,32 +3476,29 @@
         {
           "disabled": false,
           "document": "音频编码参数。",
-          "example": "AudioEncode",
+          "example": "无",
           "member": "AudioEncode",
           "name": "AudioEncode",
           "required": false,
-          "type": "object",
-          "value_allowed_null": false
+          "type": "object"
         },
         {
           "disabled": false,
           "document": "音频用户白名单，start时，为空或不填表示混所有主播音频，填具体值表示混指定主播音频；update时，不填表示不更新，为空表示更新为混所有主播音频，填具体值表示更新为混指定主播音频。\n使用黑白名单时，黑白名单必须同时填写。都不填写时表示不更新。同一个用户同时在黑白名单时，以黑名单为主。",
-          "example": "SubscribeAudioList",
+          "example": "无",
           "member": "McuUserInfoParams",
           "name": "SubscribeAudioList",
           "required": false,
-          "type": "list",
-          "value_allowed_null": false
+          "type": "list"
         },
         {
           "disabled": false,
           "document": "音频用户黑名单，为空或不填表示无黑名单，填具体值表示不混指定主播音频。update时，不填表示不更新，为空表示更新为清空黑名单，填具体值表示更新为不混指定主播音频。\n使用黑白名单时，黑白名单必须同时填写。都不填写时表示不更新。同一个用户同时在黑白名单时，以黑名单为主。",
-          "example": "UnSubscribeAudioList",
+          "example": "无",
           "member": "McuUserInfoParams",
           "name": "UnSubscribeAudioList",
           "required": false,
-          "type": "list",
-          "value_allowed_null": false
+          "type": "list"
         }
       ],
       "usage": "in"
@@ -3611,8 +3607,7 @@
           "member": "string",
           "name": "RoomId",
           "required": true,
-          "type": "string",
-          "value_allowed_null": false
+          "type": "string"
         },
         {
           "disabled": false,
@@ -3621,8 +3616,7 @@
           "member": "uint64",
           "name": "RoomIdType",
           "required": true,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         },
         {
           "disabled": false,
@@ -3631,18 +3625,16 @@
           "member": "string",
           "name": "UserId",
           "required": true,
-          "type": "string",
-          "value_allowed_null": false
+          "type": "string"
         },
         {
           "disabled": false,
           "document": "回推房间UserId对应的用户签名，相当于登录密码，具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。",
-          "example": "xxxx",
+          "example": "无",
           "member": "string",
           "name": "UserSig",
           "required": true,
-          "type": "string",
-          "value_allowed_null": false
+          "type": "string"
         }
       ],
       "usage": "in"
@@ -3653,7 +3645,7 @@
         {
           "disabled": false,
           "document": "用户媒体流参数。不填时腾讯云后台按照上行主播的进房顺序自动填充。",
-          "example": "UserMediaStream",
+          "example": "无",
           "member": "UserMediaStream",
           "name": "UserMediaStream",
           "required": false,
@@ -3725,7 +3717,7 @@
         {
           "disabled": false,
           "document": "子画面的背景图url，填写该参数，当用户关闭摄像头或未进入TRTC房间时，会在布局位置填充为指定图片。若指定图片与布局位置尺寸比例不一致，则会对图片进行拉伸处理，优先级高于BackGroundColor。支持png、jpg、jpeg、bmp、gif、webm格式。图片大小限制不超过5MB。\n注：您需要确保图片链接的可访问性，后台单次下载超时时间为10秒，最多重试3次，若最终图片下载失败，子画面的背景图将不会生效。",
-          "example": "xxxx",
+          "example": "无",
           "member": "string",
           "name": "BackgroundImageUrl",
           "required": false,
@@ -3734,7 +3726,7 @@
         {
           "disabled": false,
           "document": "客户自定义裁剪，针对原始输入流裁剪",
-          "example": "xxx",
+          "example": "无",
           "member": "McuCustomCrop",
           "name": "CustomCrop",
           "required": false,
@@ -3752,7 +3744,7 @@
         {
           "disabled": false,
           "document": "子画面的透明模版url，指向一张包含透明通道的模板图片。填写该参数，后台混流时会提取该模板图片的透明通道，将其缩放作为目标画面的透明通道，再和其他画面进行混合。您可以通过透明模版实现目标画面的半透明效果和任意形状裁剪（如圆角、星形、心形等）。 支持png格式。图片大小限制不超过5MB。\n注：1，模板图片宽高比应接近目标画面宽高比，以避免缩放适配目标画面时出现模板效果变形；2，透明模版只有RenderMode为0（裁剪）时才生效；3，您需要确保图片链接的可访问性，后台单次下载超时时间为10秒，最多重试3次，若最终图片下载失败，透明模版将不会生效。",
-          "example": "xxxx",
+          "example": "无",
           "member": "string",
           "name": "TransparentUrl",
           "required": false,
@@ -3761,7 +3753,7 @@
         {
           "disabled": false,
           "document": "子背景图的自定义渲染参数，当BackgroundRenderMode为4时必须配置。",
-          "example": "BackgroundCustomRender",
+          "example": "无",
           "member": "McuBackgroundCustomRender",
           "name": "BackgroundCustomRender",
           "required": false,
@@ -3770,7 +3762,7 @@
         {
           "disabled": false,
           "document": "子背景色生效模式，默认值为0表示均不生效。\nbit0:占位图缩放是否生效。\nbit1:上行流缩放是否生效。\n您可以将相应bit位置1启动生效，例如：\n0(00)表示子背景色不生效。\n1(01)表示子背景色只在占位图缩放时生效。\n2(10)表示子背景色只在上行流缩放时生效。\n3(11)表示子背景色在占位图缩放和上行流缩放时均生效。\n",
-          "example": "BackGroundColorMode",
+          "example": "无",
           "member": "uint64",
           "name": "BackGroundColorMode",
           "required": false,
@@ -3803,7 +3795,7 @@
         {
           "disabled": false,
           "document": "自定义模板中有效，指定用户视频在混合画面中的位置，最多支持设置16个输入流。",
-          "example": "MixLayoutList",
+          "example": "无",
           "member": "McuLayout",
           "name": "MixLayoutList",
           "required": false,
@@ -3812,7 +3804,7 @@
         {
           "disabled": false,
           "document": "指定动态布局中悬浮布局和屏幕分享布局的大画面信息，只在悬浮布局和屏幕分享布局有效。",
-          "example": "MaxVideoUser",
+          "example": "无",
           "member": "MaxVideoUser",
           "name": "MaxVideoUser",
           "required": false,
@@ -3836,12 +3828,11 @@
         {
           "disabled": false,
           "document": "AppData的内容，会被写入自定义SEI中的app_data字段，长度需小于4096。",
-          "example": "xxxx",
+          "example": "无",
           "member": "string",
           "name": "AppData",
           "required": false,
-          "type": "string",
-          "value_allowed_null": false
+          "type": "string"
         },
         {
           "disabled": false,
@@ -3850,8 +3841,7 @@
           "member": "uint64",
           "name": "PayloadType",
           "required": false,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         },
         {
           "disabled": false,
@@ -3860,8 +3850,7 @@
           "member": "uint64",
           "name": "Interval",
           "required": false,
-          "type": "int",
-          "value_allowed_null": true
+          "type": "int"
         },
         {
           "disabled": false,
@@ -3870,8 +3859,7 @@
           "member": "uint64",
           "name": "FollowIdr",
           "required": false,
-          "type": "int",
-          "value_allowed_null": true
+          "type": "int"
         }
       ],
       "usage": "in"
@@ -3882,7 +3870,7 @@
         {
           "disabled": false,
           "document": "透传SEI的payload内容。",
-          "example": "xxxx",
+          "example": "无",
           "member": "string",
           "name": "PayloadContent",
           "required": true,
@@ -3900,7 +3888,7 @@
         {
           "disabled": false,
           "document": "PayloadType为5，PayloadUuid必须填写。PayloadType不是5时，不需要填写，填写会被后台忽略。该值必须是32长度的十六进制。",
-          "example": "xxxx",
+          "example": "无",
           "member": "string",
           "name": "PayloadUuid",
           "required": false,
@@ -3933,7 +3921,7 @@
         {
           "disabled": false,
           "document": "CDN转推URL，只支持rtmp链接。\n注：若更新转推时，URL有任何变化，都会断流重推。",
-          "example": "xxxx",
+          "example": "无",
           "member": "string",
           "name": "PublishCdnUrl",
           "required": true,
@@ -4035,22 +4023,20 @@
         {
           "disabled": false,
           "document": "音量布局SEI",
-          "example": "LayoutVolume",
+          "example": "无",
           "member": "McuLayoutVolume",
           "name": "LayoutVolume",
           "required": false,
-          "type": "object",
-          "value_allowed_null": false
+          "type": "object"
         },
         {
           "disabled": false,
           "document": "透传SEI",
-          "example": "PassThrough",
+          "example": "无",
           "member": "McuPassThrough",
           "name": "PassThrough",
           "required": false,
-          "type": "object",
-          "value_allowed_null": false
+          "type": "object"
         }
       ],
       "usage": "in"
@@ -4154,7 +4140,7 @@
         {
           "disabled": false,
           "document": "用户参数。",
-          "example": "UserInfo",
+          "example": "无",
           "member": "MixUserInfo",
           "name": "UserInfo",
           "required": true,
@@ -4178,7 +4164,7 @@
         {
           "disabled": false,
           "document": "输出流视频编码参数。",
-          "example": "VideoEncode",
+          "example": "无",
           "member": "VideoEncode",
           "name": "VideoEncode",
           "required": false,
@@ -4187,7 +4173,7 @@
         {
           "disabled": false,
           "document": "混流布局参数。",
-          "example": "LayoutParams",
+          "example": "无",
           "member": "McuLayoutParams",
           "name": "LayoutParams",
           "required": false,
@@ -4205,7 +4191,7 @@
         {
           "disabled": false,
           "document": "整个画布的背景图url，优先级高于BackGroundColor。支持png、jpg、jpeg格式。图片大小限制不超过5MB。\n注：您需要确保图片链接的可访问性，后台单次下载超时时间为10秒，最多重试3次，若最终图片下载失败，背景图将不会生效。",
-          "example": "xxxx",
+          "example": "无",
           "member": "string",
           "name": "BackgroundImageUrl",
           "required": false,
@@ -4214,7 +4200,7 @@
         {
           "disabled": false,
           "document": "混流布局的水印参数。",
-          "example": "WaterMarkList",
+          "example": "无",
           "member": "McuWaterMarkParams",
           "name": "WaterMarkList",
           "required": false,
@@ -5202,8 +5188,8 @@
         },
         {
           "disabled": true,
-          "document": "目前已不支持",
-          "example": "无",
+          "document": "填写则翻译，目前支持的语言：\n中文: zh\n英语: en\n越南语: vi\n日语: ja\n韩语: ko\n印度尼西亚语: id\n泰语: th\n葡萄牙语: pt\n土耳其语: tr\n阿拉伯语: ar\n西班牙语: es\n印地语: hi\n法语: fr\n马来语: ms\n菲律宾语: fil\n德语: de\n意大利语: it\n俄语: ru\n瑞典语: sv\n挪威语: no\n丹麦语: da",
+          "example": "ja",
           "member": "string",
           "name": "TranslationLanguage",
           "required": false,
@@ -5807,12 +5793,11 @@
         {
           "disabled": false,
           "document": "用户媒体流参数。",
-          "example": "UserMediaStream",
+          "example": "无",
           "member": "UserMediaStream",
           "name": "UserMediaStream",
           "required": true,
-          "type": "object",
-          "value_allowed_null": false
+          "type": "object"
         }
       ],
       "usage": "in"
@@ -6215,7 +6200,7 @@
         {
           "disabled": false,
           "document": "TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和转推的房间所对应的SdkAppId相同。",
-          "example": "1400188366",
+          "example": "1400000000",
           "member": "uint64",
           "name": "SdkAppId",
           "required": true,
@@ -6242,7 +6227,7 @@
         {
           "disabled": false,
           "document": "转推服务加入TRTC房间的机器人参数。",
-          "example": "AgentParams",
+          "example": "无",
           "member": "AgentParams",
           "name": "AgentParams",
           "required": true,
@@ -6260,7 +6245,7 @@
         {
           "disabled": false,
           "document": "转推流的音频编码参数。由于音频是必转码的（不会收取转码费用），所以启动任务的时候，必须填写。",
-          "example": "AudioParams",
+          "example": "无",
           "member": "McuAudioParams",
           "name": "AudioParams",
           "required": false,
@@ -6269,7 +6254,7 @@
         {
           "disabled": false,
           "document": "转推流的视频编码参数，不填表示纯音频转推。",
-          "example": "VideoParams",
+          "example": "无",
           "member": "McuVideoParams",
           "name": "VideoParams",
           "required": false,
@@ -6278,7 +6263,7 @@
         {
           "disabled": false,
           "document": "需要单流旁路转推的用户上行参数，单流旁路转推时，WithTranscoding需要设置为0。",
-          "example": "SingleSubscribeParams",
+          "example": "无",
           "member": "SingleSubscribeParams",
           "name": "SingleSubscribeParams",
           "required": false,
@@ -6287,7 +6272,7 @@
         {
           "disabled": false,
           "document": "转推的CDN参数，一个任务最多支持10个推流URL。和回推房间参数必须要有一个。",
-          "example": "PublishCdnParams",
+          "example": "无",
           "member": "McuPublishCdnParam",
           "name": "PublishCdnParams",
           "required": false,
@@ -6296,7 +6281,7 @@
         {
           "disabled": false,
           "document": "混流SEI参数",
-          "example": "SeiParams",
+          "example": "无",
           "member": "McuSeiParams",
           "name": "SeiParams",
           "required": false,
@@ -6305,7 +6290,7 @@
         {
           "disabled": false,
           "document": "回推房间信息，一个任务最多支持回推10个房间，和转推CDN参数必须要有一个。注：回推房间需使用10.4及以上SDK版本，如您有需求，请联系腾讯云技术支持。",
-          "example": "FeedBackRoomParams",
+          "example": "无",
           "member": "McuFeedBackRoomParams",
           "name": "FeedBackRoomParams",
           "required": false,
@@ -6314,7 +6299,7 @@
         {
           "disabled": false,
           "document": "转推录制参数，[参考文档](https://cloud.tencent.com/document/product/647/111748)。",
-          "example": "RecordParams",
+          "example": "无",
           "member": "McuRecordParams",
           "name": "RecordParams",
           "required": false,
@@ -7622,12 +7607,11 @@
         {
           "disabled": false,
           "document": "TRTC用户参数。",
-          "example": "MixUserInfo",
+          "example": "无",
           "member": "MixUserInfo",
           "name": "UserInfo",
           "required": false,
-          "type": "object",
-          "value_allowed_null": false
+          "type": "object"
         },
         {
           "disabled": false,
@@ -7636,8 +7620,7 @@
           "member": "uint64",
           "name": "StreamType",
           "required": false,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         }
       ],
       "usage": "in"