Todos os produtos
Search
Central de documentação

ApsaraVideo Media Processing:AddWaterMarkTemplate

Última atualização: Jun 28, 2026

Cria um modelo de marca d'água.

Descrição da operação

Após criar um modelo de marca d'água chamando esta operação, você pode especificar o modelo de marca d'água e o ativo de marca d'água ao enviar um trabalho de transcodificação. Isso permite adicionar informações de marca d'água ao vídeo de saída.

Limite de QPS

Você pode chamar esta operação até 100 vezes por segundo por conta. As solicitações que excederem esse limite serão descartadas e você sofrerá interrupções no serviço. Recomendamos que você observe esse limite ao chamar esta operação. Para mais informações, consulte Limite de QPS.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

  • Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.

  • API: A API que você pode chamar para executar a ação.

  • Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.

  • Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.

    • Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.

    • Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.

  • Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.

  • Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

mts:AddWaterMarkTemplate

create

*All Resource

*

Nenhuma Nenhuma

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Name

string

Sim

O nome do modelo de marca d'água. O valor pode conter letras e dígitos e ter até 128 bytes de tamanho.

example-watermark-****

Config

string

Sim

A configuração do modelo de marca d'água. O valor é um objeto JSON. Para mais informações, consulte a seção "WaterMarks" do tópico Detalhes dos parâmetros.

Nota

Se você não precisar de uma correlação positiva entre o tamanho do texto na marca d'água e a resolução, poderá ativar a adaptação para a marca d'água. Para fazer isso, adicione ['adaptive']=true ao parâmetro TextWaterMark.

{"Width":"10","Height":"30","Dx":"10","Dy":"5","ReferPos":"TopRight","Type":"Image","Timeline":{"Start":"0","Duration":"10"}}

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

Os parâmetros de resposta.

WaterMarkTemplate

object

Os detalhes do modelo de marca d'água.

Type

string

O tipo da marca d'água. Valores válidos:

  • Image: uma marca d'água de imagem.

  • Text: uma marca d'água de texto.

Image

RatioRefer

object

Os valores dos parâmetros Height, Width, Dx e Dy em relação às bordas de referência. Se os valores dos parâmetros Height, Width, Dx e Dy forem decimais entre 0 e 1, os valores serão calculados referindo-se às seguintes bordas em sequência:

  • Width: a borda da largura.

  • Height: a borda da altura.

  • Long: a borda longa.

  • Short: a borda curta.

Dx

string

The horizontal offset of the watermark relative to the output video image. Default value: 0. The default value indicates no offset. The value can be an integer or a decimal.

  • Integer: the vertical offset. This indicates the absolute position. Unit: pixel.

  • Decimal: the ratio of the horizontal offset to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.

0.51

Width

string

The width of the watermark image in the output video. The value can be an integer or a decimal.

  • Integer: the width of the watermark image. This indicates the absolute position. Unit: pixel.

  • Decimal: the ratio of the width of the watermark image to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.

0.36

Height

string

The height of the watermark image in the output video. The value can be an integer or a decimal.

  • Integer: the height of the watermark image. This indicates the absolute position. Unit: pixel.

  • Decimal: the ratio of the height of the watermark image to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.

0.33

Dy

string

The vertical offset of the watermark relative to the output video image. Default value: 0. The default value indicates no offset. The value can be an integer or a decimal.

  • Integer: the vertical offset. This indicates the absolute position. Unit: pixel.

  • Decimal: the ratio of the vertical offset to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.

0.28

ReferPos

string

A posição da marca d'água. Valores válidos:

  • TopRight: o canto superior direito.

  • TopLeft: o canto superior esquerdo.

  • BottomRight: o canto inferior direito.

  • BottomLeft: o canto inferior esquerdo.

TopRight

State

string

O status do modelo de marca d'água.

  • Normal: O modelo de marca d'água está normal.

  • Deleted: O modelo de marca d'água foi excluído.

Normal

Dx

string

O deslocamento horizontal. Unidade: pixel.

10

Width

string

A largura da imagem da marca d'água. Unidade: pixel.

10

Height

string

A altura da imagem da marca d'água. Unidade: pixel.

30

Timeline

object

A linha do tempo da marca d'água.

Start

string

The beginning of the time range during which the watermark is displayed.

  • Unit: seconds.

  • Default value: 0.

0

Duration

string

The display duration of the watermark. Default value: ToEND. The default value indicates that the watermark is displayed until the video ends.

ToEND

Name

string

O nome do modelo de marca d'água.

example-watermark-****

Dy

string

O deslocamento vertical. Unidade: pixel.

5

Id

string

O ID do modelo de marca d'água. Recomendamos que você guarde este ID para chamadas de operação subsequentes.

3780bd69b2b74540bc7b1096f564****

RequestId

string

O ID da solicitação.

54BB917F-DD35-4F32-BABA-E60E31B21W63

Exemplos

Resposta de sucesso

JSON formato

{
  "WaterMarkTemplate": {
    "Type": "Image",
    "RatioRefer": {
      "Dx": "0.51",
      "Width": "0.36",
      "Height": "0.33",
      "Dy": "0.28"
    },
    "ReferPos": "TopRight",
    "State": "Normal",
    "Dx": "10",
    "Width": "10",
    "Height": "30",
    "Timeline": {
      "Start": "0",
      "Duration": "ToEND"
    },
    "Name": "example-watermark-****",
    "Dy": "5",
    "Id": "3780bd69b2b74540bc7b1096f564****"
  },
  "RequestId": "54BB917F-DD35-4F32-BABA-E60E31B21W63"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.