Um recurso watermark identifica uma imagem que aparece durante a reprodução dos vídeos de um canal específico. Você também pode especificar um canal de destino ao qual a imagem será vinculada, além dos detalhes de sincronismo que determinam quando uma marca d'água aparece durante reproduções de vídeo e o período em que ela estará visível.
Métodos
A API é compatível com os seguintes métodos para recursos watermarks:
- set
- Envia uma imagem de marca-d'água para o YouTube e a define para um canal.
- unset
- Exclui a imagem de marca-d'água de um canal. Faça um teste agora.
Representação de recurso
A estrutura JSON abaixo mostra o formato de um recurso watermarks:
{
"timing": {
"type": string,
"offsetMs": unsigned long,
"durationMs": unsigned long
},
"position": {
"type": string,
"cornerPosition": string
},
"imageUrl": string,
"imageBytes": bytes,
"targetChannelId": string
}Propriedades
A tabela a seguir define as propriedades que aparecem neste recurso:
| Propriedades | |
|---|---|
timing |
objectO objeto timing encapsula informações sobre o momento durante a reprodução de um vídeo em que a imagem da marca-d'água de um canal será exibida. |
timing.type |
stringO método de marcação de tempo que determina quando a imagem da marca-d'água é exibida durante a reprodução do vídeo. Se o valor for offsetFromStart, o campo offsetMs representará um ajuste desde o início do vídeo. Se o valor for offsetFromEnd, o campo offsetMs representará um deslocamento do final do vídeo. |
timing.offsetMs |
unsigned longO ajuste de horário, especificado em milissegundos, que determina quando o item promovido aparece durante as reproduções de vídeo. O valor da propriedade type determina se o deslocamento é medido do início ou do fim do vídeo. |
timing.durationMs |
unsigned longO período, em milissegundos, em que a imagem da marca d'água deve ser exibida. |
position |
objectO objeto position encapsula informações sobre a posição espacial no vídeo em que a imagem da marca-d'água será exibida. |
position.type |
stringA maneira como o item promovido é posicionado no player de vídeo. Os valores válidos para essa propriedade são:
|
position.cornerPosition |
stringO canto do player em que o item promovido vai aparecer. O item sempre aparece no canto superior direito do player. Os valores válidos para essa propriedade são:
|
imageUrl |
stringO URL da imagem da marca-d'água do canal. O YouTube vai gerar esse URL e retorná-lo na resposta da API a uma solicitação watermark.set. |
imageBytes |
bytesO tamanho da imagem da marca-d'água, em bytes. |
targetChannelId |
stringO ID do canal do YouTube a que a imagem da marca-d'água está vinculada. |