All Products
Search

This Product

    ApsaraVideo Live:AddLiveStreamWatermark

    Document Center

    ApsaraVideo Live:AddLiveStreamWatermark

    Last Updated:Dec 17, 2025

    The AddLiveStreamWatermark operation adds a watermark template.

    Operation description

    • This operation adds a watermark template for live streaming. A watermark template defines the content, layout, and other information for a watermark.

    • After you add a watermark template, you must also call the AddLiveStreamWatermarkRule operation to add a watermark rule. The watermark appears on the stream after you restart the stream ingest.

    QPS limit

    The queries per second (QPS) limit for a single user is 60. API calls that exceed this limit are throttled. This may affect your business. Plan your calls accordingly.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    live:AddLiveStreamWatermark

    create

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    The region ID.

    cn-shanghai
    Type

    integer

    Yes

    The type of the watermark. Valid values:

    • 0: image.

    • 1: text. (Only image watermarks are supported.)

    0
    Name

    string

    Yes

    The name of the watermark.

    livewatermark****
    RefWidth

    integer

    Yes

    The width of the reference background video, in pixels.

    1920
    RefHeight

    integer

    Yes

    The height of the reference background video, in pixels.

    1080
    XOffset

    number

    Yes

    The offset of the watermark on the x-axis, in pixels.

    Note

    The offset is relative to the width of the reference background (RefWidth). If you set OffsetCorner to TopLeft, XOffset is the horizontal distance between the top-left corner of the watermark and the top-left corner of the background video. The positive direction of the x-axis is to the right.

    50.0
    YOffset

    number

    Yes

    The offset of the watermark on the y-axis, in pixels.

    Note

    The offset is relative to the height of the reference background (RefHeight). If you set OffsetCorner to TopLeft, YOffset is the vertical distance between the top-left corner of the watermark and the top-left corner of the background video. The positive direction of the y-axis is downward.

    100.0
    Height

    integer

    Yes

    The height of the watermark image, in pixels. The watermark is scaled in proportion to the height of the reference background (RefHeight).

    200
    Transparency

    integer

    Yes

    The transparency of the watermark. A smaller value indicates a higher transparency. Valid values: 0 to 255.

    255
    OffsetCorner

    string

    Yes

    The position of the watermark. Valid values:

    • TopLeft: The top-left corner.

    • TopRight: The top-right corner.

    • BottomLeft: The bottom-left corner.

    • BottomRight: The bottom-right corner.

    TopRight
    PictureUrl

    string

    Yes

    The URL of the watermark image.

    http://example.com
    Description

    string

    No

    The description of the watermark.

    my watermark
    Domain

    string

    No

    The streaming domain.

    example.aliyundoc.com

    Response elements

    Element

    Type

    Description

    Example

    object

    TemplateId

    string

    The ID of the watermark template.

    445409ec-7eaa-461d-8f29-4bec2eb9****
    RequestId

    string

    The request ID.

    5c6a2a0df228-4a64- af62-20e91b96****

    Examples

    Success response

    JSON format

    {
  "TemplateId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
  "RequestId": "5c6a2a0df228-4a64- af62-20e91b96****"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParameters %s Please check and try again later. Exception parameter exists, please check and try again.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.