全部产品
Search

搜索本产品

    媒体处理：SearchWaterMarkTemplate - 搜索水印模板

    文档中心

    媒体处理：SearchWaterMarkTemplate - 搜索水印模板

    更新时间：Dec 26, 2024

    搜索水印模板。

    接口说明

    本接口通过指定状态搜索水印模板，如不指定则默认搜索全部模板。

    QPS 限制

    本接口的单用户 QPS 限制为 100 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    mts:SearchWaterMarkTemplateget
    *全部资源
    *
      无
    		无

    请求参数

    名称类型必填描述示例值
    PageSizelong否

    分页查询时设置的每页大小。

    • 上限值：100。
    • 默认值：10。
    		10
    PageNumberlong否

    当前页号。默认值：1。

    		1
    Statestring否

    水印模板状态。

    • All：表示所有，默认值。
    • Normal：表示正常。
    • Deleted：表示已删除。
    		Normal

    返回参数

    名称类型描述示例值
    object

    返回参数。

    TotalCountlong

    总条数。

    		1
    PageSizelong

    分页大小。

    		10
    RequestIdstring

    请求 ID。

    		FC029D04-8F47-57FF-A759-23383C15617D
    PageNumberlong

    当前页码。

    		1
    WaterMarkTemplateListarray<object>

    模板列表。

    WaterMarkTemplateobject

    返回参数。

    Typestring

    水印类型。取值：

    • Image：图片。

    • Text：文本。

    说明 目前仅支持 Image。
    		Image
    RatioReferobject

    取值为百分比是参考的边。当 Height、Width、Dx、Dy 的取值处于（0，1）时，这个百分比是参考哪个边得到的（按顺序）：

    • Width：宽。

    • Height：高。

    • Long：长边。

    • Short：短边。

    Dxstring

    水印图片相对输出视频的水平偏移量。默认值：0（无偏移）。 值有两种形式：

    • 整数型：代表偏移像素，绝对位置，单位：px。
    • 小数型：代表水平偏移量与输出分辨率宽的比率，相对比例，按照视频尺寸变化，支持 4 位小数，如 0.9999，超出部分系统自动丢弃。
    		0.51
    Widthstring

    输出视频上水印图片宽。值有两种形式：

    • 整数型：代表水印图片宽的像素值，绝对位置，单位：px。
    • 小数型：代表相对输出视频分辨率宽的比率，相对比例，按照视频尺寸变动，支持 4 位小数，如 0.9999，超出部分系统自动丢弃。
    		0.36
    Heightstring

    输出视频上水印图片高。值有两种形式：

    • 整数型：代表水印图片高的像素值，绝对位置，单位：px。
    • 小数型：代表相对输出视频分辨率高的比率，相对比例，按照视频尺寸变动，支持 4 位小数，如 0.9999，超出部分系统自动丢弃。
    		0.33
    Dystring

    水印图片相对输出视频的垂直偏移量。默认值：0（无偏移）。值有两种形式：

    • 整数型：代表偏移像素，绝对位置，单位：px。
    • 小数型：代表垂直偏移量与输出分辨率高的比率，相对比例，按照视频尺寸变动，支持 4 位小数，如 0.9999，超出部分系统自动丢弃。
    		0.2
    ReferPosstring

    水印的位置。取值：

    • TopRight：右上。

    • TopLeft：左上。

    • BottomRight：右下。

    • BottomLeft：左下。

    		TopRight
    Statestring

    水印模板的状态。取值：

    • Normal：正常。

    • Deleted：已删除。

    		Normal
    Dxstring

    水平偏移量。单位：px。

    		100
    Widthstring

    宽。单位：px。

    		8
    Heightstring

    高。单位：px。

    		8
    Timelineobject

    动态水印。

    Startstring

    水印开始出现时间。

    • 单位：秒。
    • 默认值：0。
    		0
    Durationstring

    水印持续时间。默认值：ToEND（直至视频结束）。

    		ToEND
    Namestring

    水印模板名称。

    		example-watermark
    Dystring

    垂直偏移量。单位：px。

    		100
    Idstring

    水印模板 ID。

    		88c6ca184c0e4578645b665e2a12****

    示例

    正常返回示例

    JSON格式

    {
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "FC029D04-8F47-57FF-A759-23383C15617D",
  "PageNumber": 1,
  "WaterMarkTemplateList": {
    "WaterMarkTemplate": [
      {
        "Type": "Image",
        "RatioRefer": {
          "Dx": "0.51",
          "Width": "0.36",
          "Height": "0.33",
          "Dy": "0.2"
        },
        "ReferPos": "TopRight",
        "State": "Normal",
        "Dx": "100",
        "Width": "8",
        "Height": "8",
        "Timeline": {
          "Start": "0",
          "Duration": "ToEND"
        },
        "Name": "example-watermark",
        "Dy": "100",
        "Id": "88c6ca184c0e4578645b665e2a12****"
      }
    ]
  }
}

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    暂无变更历史