media processing parameter description for vod api - ApsaraVideo VOD: Central de Documentação do Alibaba Cloud

EncryptConfig: Configurações de criptografia HLS

Nome do campo	Tipo	Obrigatório	Descrição
CipherText	String	Sim	Texto cifrado da chave. Use este valor para obter a chave em texto simples.
DecryptKeyUri	String	Sim	URI para obter a chave de descriptografia com base no texto cifrado da chave. Exemplo: `http://example.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk****`.
KeyServiceType	String	Sim	Tipo de serviço de chave. Valor padrão: `KMS`. KMS é a abreviação de Alibaba Cloud Key Management Service.

Exemplo de parâmetros EncryptConfig

{
  "CipherText":"ZjJmZGViNzUtZWY1Mi00Y2RlLTk****",
  "DecryptKeyUri":"http://example.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk****",
  "KeyServiceType":"KMS"
}

OverrideParams: Configurações de substituição de parâmetros do job de transcodificação

Nome do campo	Tipo	Obrigatório	Descrição
Watermarks	Watermark[]	Não	Necessário para substituir marcas d'água.
SubtitleSetting	SubtitleSetting	Não	Necessário para substituir legendas. Nota O modelo de transcodificação deve ter parâmetros de legenda configurados previamente. Caso contrário, os parâmetros de legenda não serão sobrescritos. Para mais informações sobre configurações de legenda, consulte SubtitleConfig. A URL do arquivo de legenda substituto deve ser uma URL HTTP (não HTTPS) do OSS. URLs de nomes de domínio acelerados por CDN não são suportadas. Exemplo: `http://out-dda****.cn-shanghai.aliyuncs.com/subtitle/subtitle.ass`
PackageSubtitleSetting	PackageSubtitleSetting[]	Não	Necessário para sobrescrever a URL da legenda durante o empacotamento de streaming com taxa de bits adaptativa.
TranscodeTemplateList	TranscodeTemplate[]	Não	Necessário para substituir parâmetros do modelo. Permite sobrescrever os parâmetros Video, Audio, Clip, Rotate e TranscodeFileRegular no modelo de transcodificação. Não é possível sobrescrever parâmetros de modelos de qualidade original. O parâmetro TranscodeTemplateId é obrigatório para sobrescrever outros parâmetros.

Nota

Atualmente, é possível substituir apenas o arquivo de imagem ou o conteúdo de texto de uma marca d'água.

Exemplo de TranscodeTemplateList

        [
                {
                  "TranscodeTemplateId":"9580424e49b28c952a46544e3e8f****",
                  "Video":{
                          "Width":720,
                          "Height":480,
                          "Bitrate":"600"
                  },
                  "Audio":{
                          "Bitrate":128
                  },
                  "Clip":{
                          "TimeSpan":{
                                "Seek":"1",
                                "Duration":"5"
                        },
                  "Rotate":"270",
                  "TranscodeFileRegular":"{MediaId}/{JobId}/{PlayDefinition}"
                  }
                }
        ]

Watermark: Configurações de substituição de parâmetros de marca d'água

Nome do campo	Tipo	Obrigatório	Descrição
WatermarkId	String	Sim	ID da marca d'água associada ao modelo de transcodificação. Encontre esse ID no console do ApsaraVideo VOD. Para mais informações, consulte Gerenciamento de marcas d'água.
FileUrl	String	Não	URL do OSS do arquivo de marca d'água. Este parâmetro é obrigatório para marcas d'água de imagem. Para mais informações sobre como obter a URL do OSS de um arquivo, consulte CreateUploadAttachedMedia.
Content	String	Não	Conteúdo da marca d'água de texto. Este parâmetro é obrigatório para marcas d'água de texto.

Importante

A FileUrl deve corresponder ao local de armazenamento da source de vídeo.

SubtitleSetting: Configurações de substituição de parâmetros de legenda

Nome do campo	Tipo	Obrigatório	Descrição
SubtitleList	Subtitle	Sim	Lista de legendas substitutas.

Configuração de legenda

Nome do campo

Tipo

Obrigatório

Descrição

SubtitleUrl

String

Sim

URL do OSS do arquivo de legenda. URLs HTTPS não são suportadas.

CharEncode

String

Sim

Formato de codificação do conteúdo da legenda. Valores válidos:

auto (detecção automática)
UTF-8
GBK
BIG5

Nota

Defina CharEncode com um formato de codificação específico. Se você definir este parâmetro como auto, o formato de codificação poderá ser detectado incorretamente.

PackageSubtitleSetting: Parâmetros de substituição de legenda empacotada

Nome do campo	Tipo	Obrigatório	Descrição
PackageSubtitleList	PackageSubtitle[]	Sim	Necessário para substituir legendas.

PackageSubtitle: Parâmetros de substituição de legenda empacotada

Nome do campo	Tipo	Obrigatório	Descrição
SubtitlePackageTemplateId	String	Sim	ID do modelo de empacotamento de legenda.
Language	String	Sim	Idioma. Para mais informações, consulte RFC 5646. Exemplo: en-US. Nota O parâmetro Language serve apenas para recuperar o arquivo de legenda a ser substituído. O idioma em si não é alterado.
SubtitleUrl	String	Sim	URL da legenda. Apenas URLs HTTP do OSS são suportadas. URLs HTTP de CDN e URLs HTTPS não são suportadas. Nota Atualmente, apenas uma URL HTTP é suportada. Os arquivos de legenda só podem ser armazenados nos buckets do sistema alocados pelo ApsaraVideo VOD.

Nota

Os parâmetros SubtitlePackageTemplateId e Language servem para recuperar a URL da legenda a ser substituída. Não é possível alterar o idioma em si.

Exemplo de parâmetros OverrideParams

{
  "Watermarks":[
    {
      "WatermarkId":"watermark1",
      "FileUrl":"http://****.bucket.aliyuncs.com/image/replace.png"
    },
    {
      "WatermarkId":"watermark2",
      "Content":"Watermark test"
    }
  ],
  "SubtitleSetting":{
          "SubtitleList":[
                {
                "SubtitleUrl":"http://outin-****.oss-cn-shanghai.aliyuncs.com/subtitles/7b850b-724c-4011-b885-dd16c****.ass",
                "CharEncode":"UTF-8"
                },
                {
                "SubtitleUrl":"http://outin-****.oss-cn-shanghai.aliyuncs.com/subtitles/7b86db-724c-4011-b885-dd161d****.srt",
                "CharEncode":"auto"
                }
        ]
  },
  "PackageSubtitleSetting": {
    "PackageSubtitleList": [
      {
        "Language": "en-US",
        "SubtitlePackageTemplateId": "32d665807c08d25d4a5d513395****", 
        "SubtitleUrl": "http://outin-****.oss-cn-shanghai.aliyuncs.com/789679188D1F36A00AEB****.vtt" 
      },
      {
        "Language": "ja",  
        "SubtitlePackageTemplateId": "32d665807c08d25d4a5d513395ad****",
        "SubtitleUrl": "http://outin-****.oss-cn-shanghai.aliyuncs.com/F43FD90FF4B936A00AEB****.vtt"
      }
    ]
  }
}

WatermarkConfig: Configurações de marca d'água

Se o tipo de marca d'água for Imagem

Nome do parâmetro	Tipo do parâmetro	Obrigatório	Descrição
Dx	String	Sim	O deslocamento horizontal aceita dois formatos. Valor em pixels: [8,4096] Porcentagem da tela: (0,1). O valor 0 representa 0%, o valor 1 representa 100% e o valor 0,5 representa 50%. Outros valores são interpretados proporcionalmente.
Dy	String	Sim	O deslocamento vertical aceita dois formatos. Valor em pixels: [8,4096] Proporção da tela: (0,1). O valor 0 representa 0% da tela, 1 representa 100% e 0,5 representa 50%. Outros valores seguem a mesma lógica de interpretação.
Width	String	Sim	A largura da marca d'água aceita dois formatos. Valor em pixels: [8,4096] Proporção da tela: (0,1). O valor 0 representa 0% da tela, o valor 1 representa 100% e o valor 0,5 representa 50%. Outros valores seguem a mesma lógica de interpretação.
Height	String	Sim	A altura da marca d'água aceita dois formatos de valor. Valor em pixels: [8,4096] Proporção da imagem: (0,1). O valor 0 representa 0% da área da imagem, 1 representa 100% e 0,5 representa 50%. Outros valores são interpretados proporcionalmente.
ReferPos	String	Sim	Posição da marca d'água: BottomRight (canto inferior direito) BottomLeft (canto inferior esquerdo) TopRight (canto superior direito) TopLeft (canto superior esquerdo)
Timeline	Timeline	Não	Linha do tempo da marca d'água. Especifica os horários de início e fim da exibição da marca d'água. O valor é uma string JSON.

Importante

O parâmetro Timeline é válido apenas para marcas d'água de imagem.

Se o tipo de marca d'água for Texto

Nome do parâmetro	Tipo do parâmetro	Obrigatório	Descrição
Content	String	Sim	Conteúdo da marca d'água de texto. Exemplo: "Marca d'água de texto".
FontName	String	Não	Nome da fonte
FontColor	String	Não	Cor da fonte
FontAlpha	String	Não	Transparência da fonte. Valores válidos: (0, 1]. Valor padrão: 1,0.
BorderColor	String	Não	Cor do contorno
Top	Integer	Não	Margem superior do texto. Apenas valores inteiros são suportados. Unidade: px. Valor padrão: 0. Valores válidos: [0, 4096].
Left	Integer	Não	Margem esquerda do texto. Apenas valores inteiros são suportados. Unidade: px. Valor padrão: 0. Valores válidos: [0, 4096].
FontSize	Integer	Não	Tamanho da fonte. Apenas valores inteiros são suportados. Valor padrão: 16. Valores válidos: (4, 120).
BorderWidth	Integer	Não	Largura do contorno. Apenas valores inteiros são suportados. Unidade: px. Valor padrão: 0. Valores válidos: (0, 4096].

Linha do tempo da marca d'água

Nome do parâmetro	Tipo	Obrigatório	Descrição
Start	String	Sim	Momento em que a marca d'água começa a aparecer. Unidade: segundos. O valor deve ser numérico. Valor padrão: 0.
Duration	String	Sim	Duração da exibição da marca d'água. Unidade: segundos. Valores válidos: um número ou `ToEND`. Valor padrão: `ToEND`, que indica o final do vídeo.

Importante

O parâmetro Timeline é válido apenas para marcas d'água de imagem.

Nome da fonte

Nome da fonte	Descrição
SimSun	Fonte Song
WenQuanYi Zen Hei	WenQuanYi Zen Hei
WenQuanYi Zen Hei Mono	WenQuanYi Zen Hei Monospace
WenQuanYi Zen Hei Sharp	WenQuanYi Zen Hei Bitmap
Yuanti SC	Redonda Simplificada, Regular

Snapshots de vídeo

Configurações do modelo de snapshot

SnapshotTemplateConfig

Nome

Tipo

Obrigatório

Descrição

SnapshotType

String

Sim

Tipo de snapshot. Valores válidos:

NormalSnapshot: snapshot normal.
SpriteSnapshot: sprite.
WebVttSnapshot: snapshot WebVTT.

SnapshotConfig

JSON

Sim

Configurações do modelo de snapshot. As definições variam conforme o valor de SnapshotType. Para mais informações, consulte SnapshotConfig abaixo.

SnapshotConfig

Nota

Um sprite é criado capturando snapshots normais e combinando-os posteriormente. Portanto, o parâmetro SnapshotConfig é necessário tanto para snapshots normais quanto para sprites.

Nome do parâmetro	Tipo	Obrigatório	Descrição
FrameType	String	Sim	Tipo de quadro para os snapshots. Valores válidos: intra: quadro-chave. normal: quadro normal.
Count	Long	Sim	Quantidade de snapshots a serem capturados.
Interval	Long	Sim	Intervalo entre as capturas de snapshots. O valor deve ser maior ou igual a 0. Unidade: segundos. Um valor igual a 0 indica que os snapshots são capturados em intervalos uniformes com base na duração do vídeo e no valor de Count.
SpecifiedOffsetTime	Long	Sim	Horário inicial para a captura dos snapshots. Unidade: milissegundos.
Width	Integer	Não	Largura do snapshot. Valores válidos: [8, 4096]. Valor padrão: largura do vídeo original. Unidade: px.
Height	Integer	Não	Altura do snapshot. Valores válidos: [8, 4096]. Valor padrão: altura do vídeo original. Unidade: px.
SpriteSnapshotConfig	JSON	Não	Configurações do sprite. Este parâmetro é obrigatório se SnapshotType estiver definido como SpriteSnapshot. Para mais informações, consulte SpriteSnapshotConfig abaixo.
Format	String	Não	Formato do arquivo de snapshot de saída. Defina o valor como `vtt`. Este parâmetro é válido apenas se SnapshotType estiver definido como `WebVttSnapshot`.
SubOut	JSON	Não	Controla como os snapshots são exibidos quando SnapshotType está definido como WebVttSnapshot. Para mais informações, consulte SubOut abaixo.

SpriteSnapshotConfig

Nome do parâmetro	Tipo	Obrigatório	Descrição
CellWidth	String	Não	Largura de cada pequena imagem no sprite. Valor padrão: largura de um snapshot normal. Unidade: px.
CellHeight	String	Não	Altura de cada pequena imagem no sprite. Valor padrão: altura de um snapshot normal. Unidade: px.
Padding	String	Sim	Preenchimento interno de cada pequena imagem. Unidade: px.
Margin	String	Sim	Margem externa de cada pequena imagem. Unidade: px.
Color	String	Sim	Cor de fundo do sprite. Para mais informações, consulte Configurações de cor. Nota Não há suporte para definir a cor usando valores RGB.
Columns	String	Sim	Número de colunas de pequenas imagens. Valores válidos: [1, 10000].
Lines	String	Sim	Número de linhas de pequenas imagens. Valores válidos: [1, 10000].
KeepCellPic	String	Sim	Especifica se as pequenas imagens devem ser mantidas. Valores válidos: keep: Manter. delete: Remover o item.

SubOut

Nome do parâmetro

Tipo

Obrigatório

Descrição

IsSptFrag

String

Sim

Valores válidos:

false: Armazenar cada snapshot como uma imagem separada.
true: Combinar os snapshots em uma imagem grande, semelhante a um sprite, antes de armazenar.

Exemplo de modelo de snapshot

{
  "SnapshotConfig": {
    "Count": 10,
    "SpecifiedOffsetTime": 0,
    "Interval": 1
  },
  "SnapshotType": "NormalSnapshot"
}

Imagens animadas a partir de vídeos

Configurações do modelo de imagem animada

DynamicImageTemplateConfig

Nome do parâmetro	Tipo	Obrigatório	Descrição
Name	String	Sim	Nome do modelo de imagem animada.
Video	JSON	Sim	Configurações de vídeo para a imagem animada. Para mais informações, consulte Video abaixo.
Container	JSON	Sim	Configurações de formato de contêiner para a imagem animada. Para mais informações, consulte Container abaixo.
Clip	JSON	Sim	Configurações de recorte para a imagem animada. Para mais informações, consulte Clip abaixo.
SetDefaultCover	String	Sim	Especifica se a imagem animada gerada deve ser definida como miniatura padrão do vídeo. Valores válidos: true: Definir como miniatura padrão. false: Não definir como miniatura padrão.

Video

Nota

Se você não definir Width e Height, a imagem animada de saída terá as mesmas dimensões do vídeo original.
Se você definir apenas Width, a altura será dimensionada proporcionalmente com base na proporção de aspecto do vídeo original.
Se você definir apenas Height, a largura será dimensionada proporcionalmente com base na proporção de aspecto do vídeo original.

Nome do parâmetro	Tipo	Obrigatório	Descrição
Width	String	Não	Largura da imagem animada de saída. Valores válidos: [128, 4096].
Height	String	Não	Altura da imagem animada de saída. Valores válidos: [128, 4096].
Fps	String	Sim	Taxa de quadros. Valores válidos: (0, 60].

Container

Nome do parâmetro

Tipo

Obrigatório

Descrição

Format

String

Sim

Formato da imagem animada de saída. Valores válidos:

webp
gif

Clip

Nome do parâmetro	Tipo	Obrigatório	Descrição
TimeSpan	JSON	Sim	Configurações de linha do tempo para o recorte. Para mais informações, consulte TimeSpan abaixo.

TimeSpan

Nota

Para recortar o vídeo com base em uma duração, especifique os parâmetros Seek e Duration. Para recortar o vídeo aparando o início e o fim, especifique os parâmetros Seek e End.
Se você especificar Seek, Duration e End simultaneamente, os parâmetros Seek e End terão prioridade.

Nome do parâmetro	Tipo	Obrigatório	Descrição
Seek	String	Sim	Horário inicial do recorte para a imagem animada. Formato 1: sssss[.SSS]. Valores válidos: [0.000, 86399.999]. Exemplo: 0 Formato 2: hh:mm:ss[.SSS]. Valores válidos: [00:00:00.000, 23:59:59.999]. Exemplo: 00:00:05.003
Duration	String	Não	Duração do recorte. Formato 1: sssss[.SSS]. Valores válidos: [0.000, 86399.999]. Exemplo: 15 Formato 2: hh:mm:ss[.SSS]. Valores válidos: [00:00:00.000, 23:59:59.999]. Exemplo: 00:00:10.003
End	String	Não	Duração da parte final do vídeo a ser descartada. Se você especificar este parâmetro, o parâmetro Duration torna-se inválido. Formato 1: sssss[.SSS]. Valores válidos: [0.000, 86399.999]. Exemplo: 12000.55 Formato 2: hh:mm:ss[.SSS]. Valores válidos: [00:00:00.000, 23:59:59.999]. Exemplo: 00:00:15.003

Exemplo de modelo de imagem animada

{
  "Video": {
    "Fps": 5,
    "Width": 1024
  },
  "Clip": {
    "TimeSpan": {
      "Seek": 0,
      "Duration": 15
    }
  },
  "Container": {
    "Format": "gif"
  },
  "SetDefaultCover": "false"
}