All Products
Search

This Product

    ApsaraVideo Live:AddLiveStreamWatermark

    Document Center

    ApsaraVideo Live:AddLiveStreamWatermark

    Last Updated:Dec 30, 2025

    Adds a watermark template.

    Operation description

    • This API creates a live stream watermark template, which defines the watermark's content, layout, and other properties.

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

    QPS limit

    You can call this operation up to 60 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions.

    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 value:

    • 0: image.

    0

    Name

    string

    Yes

    The name of the watermark template.

    livewatermark****

    RefWidth

    integer

    Yes

    The reference width of the video background, in pixels.

    1920

    RefHeight

    integer

    Yes

    The reference height of the video background, in pixels.

    1080

    XOffset

    number

    Yes

    The X-axis offset of the watermark, in pixels.

    Note

    Relative to RefWidth. If OffsetCorner is TopLeft, XOffset is the horizontal distance between the top‑left corner of the watermark and the top‑left corner of the background video. Positive X points to the right.

    50.0

    YOffset

    number

    Yes

    The Y-axis offset of the watermark, in pixels.

    Note

    Relative to RefHeight. If OffsetCorner is TopLeft, YOffset is the vertical distance between the top‑left corner of the watermark and the top‑left corner of the background video. Positive Y points downward.

    100.0

    Height

    integer

    Yes

    The height of the watermark image, in pixels. This value is relative to RefHeight and will be scaled proportionally with the actual video resolution.

    200

    Transparency

    integer

    Yes

    The opacity of the watermark. Value range: 0 (fully transparent) to 255 (fully opaque).

    255

    OffsetCorner

    string

    Yes

    The anchor point for the watermark's position. Valid values:

    • TopLeft

    • TopRight

    • BottomLeft

    • BottomRight

    TopRight

    PictureUrl

    string

    Yes

    The URL of the watermark image.

    http://example.com

    Description

    string

    No

    A custom description for 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.