watermark 資源會識別在指定頻道影片播放期間顯示的圖片。你也可以指定圖片連結的目標頻道,以及決定浮水印在影片播放期間的顯示時機和顯示時間長度。
方法
這個 API 支援 watermarks 資源的下列方法:
資源表示法
下方的 JSON 結構顯示 watermarks 資源的格式:
{
"timing": {
"type": string,
"offsetMs": unsigned long,
"durationMs": unsigned long
},
"position": {
"type": string,
"cornerPosition": string
},
"imageUrl": string,
"imageBytes": bytes,
"targetChannelId": string
}屬性
下表定義這個資源中顯示的屬性:
| 屬性 | |
|---|---|
timing |
objecttiming 物件會封裝資訊,說明頻道浮水印圖片在影片播放期間的顯示時間。呼叫 watermarks.set 時,必須提供這個物件。 |
timing.type |
string決定影片播放期間浮水印圖片顯示時間的方法。呼叫 watermarks.set 時,必須提供這個屬性。有效值包括:
|
timing.offsetMs |
unsigned long時間偏移量 (以毫秒為單位),決定影片播放期間宣傳項目出現的時間。呼叫 watermarks.set 時,必須提供這個屬性。如果 type 為 offsetFromEnd,offsetMs 必須至少為 1000 毫秒。 |
timing.durationMs |
unsigned long浮水印圖片的顯示時間長度 (以毫秒為單位)。這是選用屬性。如果指定,最短時間為 1000 毫秒。如果 type 為 offsetFromEnd,則 durationMs 不得超過 offsetMs。 |
position |
object已淘汰:YouTube 會忽略已淘汰的 position 物件。浮水印一律會顯示在影片播放器的右上角。 |
imageUrl |
string頻道浮水印圖片的網址。YouTube 會產生這個網址,並在 watermark.set 要求的 API 回應中傳回。 |
imageBytes |
bytes浮水印圖片的大小 (以位元組為單位)。 |
targetChannelId |
string浮水印圖片連結的頻道 YouTube 頻道 ID。 |