tccli 3.0.1224.1__py2.py3-none-any.whl → 3.0.1225.1__py2.py3-none-any.whl

tccli/services/live/v20180801/api.json

@@ -14,6 +14,20 @@
       "output": "AddCasterLayoutInfoResponse",
       "status": "online"
     },
+    "AddCasterMarkPicInfo": {
+      "document": "该接口用来新增图片水印。",
+      "input": "AddCasterMarkPicInfoRequest",
+      "name": "新增图片水印信息",
+      "output": "AddCasterMarkPicInfoResponse",
+      "status": "online"
+    },
+    "AddCasterMarkWordInfo": {
+      "document": "为导播台添加文本配置。",
+      "input": "AddCasterMarkWordInfoRequest",
+      "name": "增加导播台文本配置",
+      "output": "AddCasterMarkWordInfoResponse",
+      "status": "online"
+    },
     "AddCasterOutputInfo": {
       "document": "该接口用来新增导播台推流信息。导播台主监启动后，将会将主监画面推向该接口设置的地址。",
       "input": "AddCasterOutputInfoRequest",
@@ -259,6 +273,20 @@
       "output": "DeleteCasterLayoutInfoResponse",
       "status": "online"
     },
+    "DeleteCasterMarkPicInfo": {
+      "document": "该接口用来删除导播台某个Index对应的水印。",
+      "input": "DeleteCasterMarkPicInfoRequest",
+      "name": "删除导播台水印信息",
+      "output": "DeleteCasterMarkPicInfoResponse",
+      "status": "online"
+    },
+    "DeleteCasterMarkWordInfo": {
+      "document": "该接口用来删除导播台的文本配置。",
+      "input": "DeleteCasterMarkWordInfoRequest",
+      "name": "删除导播台文本配置",
+      "output": "DeleteCasterMarkWordInfoResponse",
+      "status": "online"
+    },
     "DeleteCasterOutputInfo": {
       "document": "该接口用来删除导播台的推流信息。\n注：若删除推流到腾讯云直播源站配置，即OutputIndex为0，OutputType为1的推流配置，在重新启动主监后，系统会自动重新生成一个推流到腾讯云直播源站配置。",
       "input": "DeleteCasterOutputInfoRequest",
@@ -483,6 +511,20 @@
       "output": "DescribeCasterListResponse",
       "status": "online"
     },
+    "DescribeCasterMarkPicInfos": {
+      "document": "该接口用来查询某个导播台的水印列表。",
+      "input": "DescribeCasterMarkPicInfosRequest",
+      "name": "查询导播台的水印信息列表",
+      "output": "DescribeCasterMarkPicInfosResponse",
+      "status": "online"
+    },
+    "DescribeCasterMarkWordInfos": {
+      "document": "该接口用来查询某个导播台的文本列表。",
+      "input": "DescribeCasterMarkWordInfosRequest",
+      "name": "查询导播台的文本列表",
+      "output": "DescribeCasterMarkWordInfosResponse",
+      "status": "online"
+    },
     "DescribeCasterOutputInfos": {
       "document": "该接口用来查询某个导播台的推流信息列表。",
       "input": "DescribeCasterOutputInfosRequest",
@@ -1085,6 +1127,20 @@
       "output": "ModifyCasterLayoutInfoResponse",
       "status": "online"
     },
+    "ModifyCasterMarkPicInfo": {
+      "document": "该接口用来修改导播台水印信息。\n注意，修改的Index对应的水印需已存在",
+      "input": "ModifyCasterMarkPicInfoRequest",
+      "name": "修改导播台水印信息",
+      "output": "ModifyCasterMarkPicInfoResponse",
+      "status": "online"
+    },
+    "ModifyCasterMarkWordInfo": {
+      "document": "该接口用来修改导播台文本配置。",
+      "input": "ModifyCasterMarkWordInfoRequest",
+      "name": "修改导播台文本配置",
+      "output": "ModifyCasterMarkWordInfoResponse",
+      "status": "online"
+    },
     "ModifyCasterOutputInfo": {
       "document": "该接口用来修改导播台的推流信息。\n注：只有在主监启动前设置才生效，主监启动后设置，下次推流生效。",
       "input": "ModifyCasterOutputInfoRequest",
@@ -1402,6 +1458,78 @@
       ],
       "type": "object"
     },
+    "AddCasterMarkPicInfoRequest": {
+      "document": "AddCasterMarkPicInfo请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "导播台ID",
+          "example": "1234",
+          "member": "uint64",
+          "name": "CasterId",
+          "required": true,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "图片水印详细参数。",
+          "example": "无",
+          "member": "CasterMarkPicInfo",
+          "name": "MarkPicInfo",
+          "required": true,
+          "type": "object"
+        }
+      ],
+      "type": "object"
+    },
+    "AddCasterMarkPicInfoResponse": {
+      "document": "AddCasterMarkPicInfo返回参数结构体",
+      "members": [
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "AddCasterMarkWordInfoRequest": {
+      "document": "AddCasterMarkWordInfo请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "导播台ID。",
+          "example": "1234",
+          "member": "uint64",
+          "name": "CasterId",
+          "required": true,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "文本的详细配置。",
+          "example": "无",
+          "member": "CasterMarkWordInfo",
+          "name": "MarkWordInfo",
+          "required": true,
+          "type": "object"
+        }
+      ],
+      "type": "object"
+    },
+    "AddCasterMarkWordInfoResponse": {
+      "document": "AddCasterMarkWordInfo返回参数结构体",
+      "members": [
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "AddCasterOutputInfoRequest": {
       "document": "AddCasterOutputInfo请求参数结构体",
       "members": [
@@ -2900,6 +3028,249 @@
       ],
       "usage": "both"
     },
+    "CasterMarkPicInfo": {
+      "document": "导播台水印信息。",
+      "members": [
+        {
+          "disabled": false,
+          "document": "水印图片Index。",
+          "example": "1",
+          "member": "int64",
+          "name": "MarkPicIndex",
+          "output_required": true,
+          "required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "注：该字段已废弃。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "0",
+          "member": "int64",
+          "name": "MarkPicId",
+          "output_required": true,
+          "required": false,
+          "type": "int",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "水印图片在输出时的宽度。\n当该值为大于1的整数值时，单位为像素，允许范围[1,1920]。 \n当该值为小于1大于0的小数时，单位为百分比，表示水印在最终画面上所占的比例值。",
+          "example": "1.0",
+          "member": "float",
+          "name": "MarkPicWidth",
+          "output_required": true,
+          "required": false,
+          "type": "float",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "水印图片在输出时的高度。\n当该值为大于1的整数值时，单位为像素，允许范围[1,1080]。 \n当该值为小于1大于0的小数时，单位为百分比，表示水印在输出上所占的比例值。",
+          "example": "1.0",
+          "member": "float",
+          "name": "MarkPicHeight",
+          "output_required": true,
+          "required": false,
+          "type": "float",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "水印图片在输出时的X轴坐标。\n当该值为大于1的整数值时，单位为像素，允许范围[1,1920]。 \n当该值为小于1大于0的小数时，单位为百分比，表示水印在最终画面上x坐标所占的比例值。",
+          "example": "0.5",
+          "member": "float",
+          "name": "MarkPicLocationX",
+          "output_required": true,
+          "required": false,
+          "type": "float",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "水印图片在输出时的Y坐标。\n当该值为大于1的整数值时，单位为像素，允许范围[1,1080]。 \n当该值为小于1大于0的小数时，单位为百分比，表示水印在最终画面Y坐标上所占的比例值。",
+          "example": "0.5",
+          "member": "float",
+          "name": "MarkPicLocationY",
+          "output_required": true,
+          "required": false,
+          "type": "float",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "水印地址。\n最大长度256字符，且url需以jpg、jpeg、png、bmp、gif后缀结尾。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "http://www.example.com/pic.jpg",
+          "member": "string",
+          "name": "MarkPicUrl",
+          "output_required": true,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "水印描述。\n最大允许长度为256。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "example",
+          "member": "string",
+          "name": "Description",
+          "output_required": true,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "是否启用了等比例缩放。\n注：该字段仅做状态保存，无实际效果。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "true",
+          "member": "bool",
+          "name": "IsEqualProportion",
+          "output_required": true,
+          "required": false,
+          "type": "bool",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "both"
+    },
+    "CasterMarkWordInfo": {
+      "document": "导播台文字水印配置。",
+      "members": [
+        {
+          "disabled": false,
+          "document": "文字水印Index。",
+          "example": "1",
+          "member": "int64",
+          "name": "MarkWordIndex",
+          "output_required": true,
+          "required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "文字水印内容。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "示例文字",
+          "member": "string",
+          "name": "MarkWordText",
+          "output_required": true,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "文字水印的字号。\n范围[16, 60]\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "12",
+          "member": "uint64",
+          "name": "MarkWordFontSize",
+          "output_required": true,
+          "required": false,
+          "type": "int",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "文字水印的颜色，值为HEX颜色代码\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "0xffffff",
+          "member": "string",
+          "name": "MarkWordFontColor",
+          "output_required": true,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "文字水印的字体类型。\n范围[1,2]。\n1. 宋体\n2. 黑体\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "1",
+          "member": "uint64",
+          "name": "MarkWordFontType",
+          "output_required": true,
+          "required": false,
+          "type": "int",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "文字水印的x坐标位置，单位百分比。\n范围[0.0, 1.0]\n\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "0.1",
+          "member": "float",
+          "name": "MarkWordLocationX",
+          "output_required": true,
+          "required": false,
+          "type": "float",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "文字水印的Y坐标位置，单位百分比。\n范围[0.0, 1.0]\n\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "0.1",
+          "member": "float",
+          "name": "MarkWordLocationY",
+          "output_required": true,
+          "required": false,
+          "type": "float",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "是否开启文字跑马灯功能。\n默认为false。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "0",
+          "member": "bool",
+          "name": "MarkWordRollEnable",
+          "output_required": true,
+          "required": false,
+          "type": "bool",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "跑马灯文字显示一遍的时间，单位为秒。\n默认为5s。\n范围[5, 600]。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "5",
+          "member": "uint64",
+          "name": "MarkWordRollOnceTime",
+          "output_required": true,
+          "required": false,
+          "type": "int",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "跑马灯文字的方向。\n默认值为0。\n范围[0,1]。\n0 从左到右\n1 从右到左\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "0",
+          "member": "int64",
+          "name": "MarkWordRollDirection",
+          "output_required": true,
+          "required": false,
+          "type": "int",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "跑马灯文字显示的起始x坐标，单位百分比。\n范围[0.0, 1.0]\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "0.0",
+          "member": "float",
+          "name": "MarkWordRollStartLocationX",
+          "output_required": true,
+          "required": false,
+          "type": "float",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "跑马灯文字显示的截止x坐标，单位百分比。\n范围[0.0, 1.0]\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "1.0",
+          "member": "float",
+          "name": "MarkWordRollEndLocationX",
+          "output_required": true,
+          "required": false,
+          "type": "float",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "both"
+    },
     "CasterOutputInfo": {
       "document": "导播台推流信息。\n当导播台主监启动后，系统将自动将主监推流到腾讯云和其他第三方平台。",
       "members": [
@@ -6189,6 +6560,78 @@
       ],
       "type": "object"
     },
+    "DeleteCasterMarkPicInfoRequest": {
+      "document": "DeleteCasterMarkPicInfo请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "导播台ID。",
+          "example": "1234",
+          "member": "uint64",
+          "name": "CasterId",
+          "required": true,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "需要删除的水印Index。",
+          "example": "1",
+          "member": "int64",
+          "name": "MarkPicIndex",
+          "required": true,
+          "type": "int"
+        }
+      ],
+      "type": "object"
+    },
+    "DeleteCasterMarkPicInfoResponse": {
+      "document": "DeleteCasterMarkPicInfo返回参数结构体",
+      "members": [
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DeleteCasterMarkWordInfoRequest": {
+      "document": "DeleteCasterMarkWordInfo请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "导播台ID。",
+          "example": "1234",
+          "member": "uint64",
+          "name": "CasterId",
+          "required": true,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "需要删除的文字水印Index。",
+          "example": "1",
+          "member": "int64",
+          "name": "MarkWordIndex",
+          "required": true,
+          "type": "int"
+        }
+      ],
+      "type": "object"
+    },
+    "DeleteCasterMarkWordInfoResponse": {
+      "document": "DeleteCasterMarkWordInfo返回参数结构体",
+      "members": [
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "DeleteCasterOutputInfoRequest": {
       "document": "DeleteCasterOutputInfo请求参数结构体",
       "members": [
@@ -7578,6 +8021,80 @@
       ],
       "type": "object"
     },
+    "DescribeCasterMarkPicInfosRequest": {
+      "document": "DescribeCasterMarkPicInfos请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "导播台ID。",
+          "example": "1234",
+          "member": "uint64",
+          "name": "CasterId",
+          "required": true,
+          "type": "int"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeCasterMarkPicInfosResponse": {
+      "document": "DescribeCasterMarkPicInfos返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "导播台的水印信息列表。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "CasterMarkPicInfo",
+          "name": "MarkPicInfos",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": true
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeCasterMarkWordInfosRequest": {
+      "document": "DescribeCasterMarkWordInfos请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "导播台ID。",
+          "example": "1234",
+          "member": "uint64",
+          "name": "CasterId",
+          "required": true,
+          "type": "int"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeCasterMarkWordInfosResponse": {
+      "document": "DescribeCasterMarkWordInfos返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "导播台的文本信息列表。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "CasterMarkWordInfo",
+          "name": "MarkWordInfos",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": true
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "DescribeCasterOutputInfosRequest": {
       "document": "DescribeCasterOutputInfos请求参数结构体",
       "members": [
@@ -14436,6 +14953,78 @@
       ],
       "type": "object"
     },
+    "ModifyCasterMarkPicInfoRequest": {
+      "document": "ModifyCasterMarkPicInfo请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "导播台ID。",
+          "example": "1234",
+          "member": "uint64",
+          "name": "CasterId",
+          "required": true,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "新的水印信息。",
+          "example": "无",
+          "member": "CasterMarkPicInfo",
+          "name": "MarkPicInfo",
+          "required": true,
+          "type": "object"
+        }
+      ],
+      "type": "object"
+    },
+    "ModifyCasterMarkPicInfoResponse": {
+      "document": "ModifyCasterMarkPicInfo返回参数结构体",
+      "members": [
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "ModifyCasterMarkWordInfoRequest": {
+      "document": "ModifyCasterMarkWordInfo请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "导播台ID。",
+          "example": "1234",
+          "member": "uint64",
+          "name": "CasterId",
+          "required": true,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "修改的文本配置。",
+          "example": "无",
+          "member": "CasterMarkWordInfo",
+          "name": "MarkWordInfo",
+          "required": true,
+          "type": "object"
+        }
+      ],
+      "type": "object"
+    },
+    "ModifyCasterMarkWordInfoResponse": {
+      "document": "ModifyCasterMarkWordInfo返回参数结构体",
+      "members": [
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "ModifyCasterOutputInfoRequest": {
       "document": "ModifyCasterOutputInfo请求参数结构体",
       "members": [
@@ -18175,7 +18764,7 @@
         {
           "disabled": false,
           "document": "推流路径，与推流和播放地址中的AppName保持一致，默认为 live。",
-          "example": "",
+          "example": "live",
           "member": "string",
           "name": "AppName",
           "required": true,
@@ -18184,7 +18773,7 @@
         {
           "disabled": false,
           "document": "您的推流域名。",
-          "example": "",
+          "example": "5000.livepush.com",
           "member": "string",
           "name": "DomainName",
           "required": true,
@@ -18193,7 +18782,7 @@
         {
           "disabled": false,
           "document": "流名称。",
-          "example": "",
+          "example": "test",
           "member": "string",
           "name": "StreamName",
           "required": true,