CMS 應用程式介面影片欄位參考

這是 CMS API 傳回的視訊欄位的參考資料。

視訊欄位

視訊欄位
欄位 類型 描述
account_id 字串 視訊雲端帳戶 ID
ad_keys 字串 代表指派給影片之廣告鍵/值配對的字串。鍵/值對被格式化為鍵 = 值，並由 ＆ 符號分隔。例如："adKeys": "category=sports&live=true"
clip_source_video_id 字串 為了製作這個視頻，或者null如果這個視頻不是另一個視頻的剪輯來源視頻的 ID。
complete 布林值 處理是否完成 — 注意：當您建立新視訊時，完整屬性會自動設定為false。一旦視頻存在一個節目，完整的屬性將自動設置為true
created_at 數字，從紀元的毫秒 影片是在視訊雲端系統中建立的時候
建立者 物件 影片建立者的相關資訊 (如果有的話)
提示點 地圖陣列 提示點對應陣列
custom_fields 字段值對映（字符串） 為視訊設定的自訂欄位值-請注意，沒有此視訊值的自訂欄位不會包含在此對應中；自訂欄位值的長度上限為 1024 個單一位元組字元
dash_manifest_id 字串 DASH 資訊清單的系統識別碼
delivery_type 字串 視訊的傳送類型：
  • dynamic_origin -動態交付
  • live_origin -從布萊特灣直播直播
  • remote -資產
  • static_origin -舊式攝入系統
  • unknown -無法確定 (可能表示影片沒有可播放的轉譯)
description 字串；取代舊的簡短描述 視訊的簡短描述 (最大長度：248 個單位元組字元)
digital_master_id 字串 數位主機的系統識別碼
drm_disabled 布林值 對於已啟用 DRM 的帳戶，將此設定為 true 會防止影片遭到 DRM 封裝。如果帳戶未啟用 DRM，則不會顯示此欄位。
duration 數字，毫秒 視頻的持續時間（以毫秒為單位）
economics 字符串，必須是有效的枚舉值之一 可以是「AD_ 支持」（默認）或「免費」
folder_id 字串 影片所屬資料夾的 ID
forensic_watermarking 字串 ACTIVE表示該視頻帶有取證水印。UNAVAILBLE表示未添加取證水印。null表示該帳戶未啟用取證水印。
地理位址 [1-3] 屬性值對的地圖 視訊的地理限制屬性
has_digital_master 布林值 視訊是否有可用於重新轉碼的封存主畫面。請注意，如果您使用此欄位來測試視訊是否可以重新轉碼，則對於共用的視訊來說並不可靠。如果影片has_digital_master = true與帳戶分享，您需要測試sharing.by_external_acct = false
id 字串 視訊識別碼
影像 屬性值對的地圖 關於海報和縮圖圖像的地圖
連結 屬性值對的地圖 相關連結屬性的地圖
long_description 字串 完整描述 (最多 5000 個字元)
name 字串 視訊名稱 (最大長度：248 個單位元組字元)
offline_enabled 布林值 視訊是否已啟用離線播放
original_filename 字串 擷取的視訊檔案名稱-遠端資產視訊將為空
playback_rights_id 字串 Playback Rights API中定義的播放限制的唯一標識符。
projection 字串 360° 影片的映射投影，例如「等距矩形」
published_at 字串 ISO-8601 日期-時間字符串，指示視頻發布時間-請注意，這個字段是可寫的; 默認情況下，它被設置為視頻首次激活的日期。
reference_id 字串 使用者指定的 ID，唯一識別視訊，限制為 150 個字元。參照 ID 可以用作外鍵，以在另一個系統中識別此視頻。
排程 [1-1] 屬性值對的地圖 視訊可用性的開始與結束日期時間地圖
sharing 屬性值對的地圖 視訊共用屬性的地圖
smooth_client_manifest_id 字串 平滑資訊清單的系統識別碼
smooth_server_manifest_id 字串 平滑資訊清單伺服器的系統識別碼
state[ 1-4] 字串 作用中、非作用中、擱置中、已刪除
tags[ 1-5] 標籤陣列 (字串) 指派給視訊的標籤陣列
文字軌 HTML5 風格的文本軌道的數組 指派給視訊的文字軌道 (WebVTT 檔案) 陣列
成績單 純文本成績單數組 分配給視頻的成績單數組（純文本文件）
updated_at 日期時間字串 上次修改視訊的日期-時間 [1-2]
更新 (_S) 物件 上次更新影片的人資訊 (如果有的話)
變體 陣列的variant元數據對象 不同語言的元數據變體
ingestion_profile_id 字串 用於轉碼此視頻的 Ingestion Profile 的 ID。只讀。

注意事項

  • [ 1-1] 請注意，排程的影片不會在預定的上市期間以外停用
  • [ 1-2] 可能是由用戶或視頻雲端系統進行的修改
  • [1-3] Geo-restriction 是 Video Cloud 的付費插件；如果您想購買地理過濾功能，請聯繫您的客戶成功經理
  • [ 1-4] state可以設定為ACTIVE或INACTIVE，但不能設定為PENDING或DELETED。

    狀態的平均值如下：

    • ACTIVE - 視頻可以播放
    • INACTIVE - 視頻已停用或缺少必需的元數據字段，因此無法播放
    • PENDING - 這與媒體共享有關；該視頻已從另一個帳戶共享，但尚未被該帳戶接受
    • DELETED - 視頻已被刪除
  • [ 1-5] 請注意下列標籤的限制：
    • 標籤最多可包含 128 個字元。如果任何標籤的字元超過 128 個字元，當您嘗試儲存變更時會顯示錯誤
    • 標籤不能包含逗號；例如，不支援roof, attic + front yard的標籤
    • 一個視頻可以有不超過 1200 個標籤
    • 僅在大小寫（小寫，大寫）的標籤作為相同的標籤處理，並且大小寫將自動匹配原始標籤的標籤-區分大小寫的問題需要在外部處理 Video Cloud，例如，使用 JavaScript 方法來修改字符串

視訊來源欄位

下表顯示來源 (轉譯) 的欄位。

動態傳送來源

欄位 類型 描述
src 字串 來源的網址
type 字串 分段視訊類型，通常application/x-mpegURL (針對 HLS) 或application/dash+xml (適用於 DASH)
ext_x_version 字串 HLS 版本-僅適用於 HLS 來源
profiles 字串 設定檔-僅適用於破折號來源
codec 字串 視訊轉碼器-僅適用於 MP4 來源
container 字串 視頻容器-僅適用於 MP4 來源
duration 整數 持續時間 (以毫秒為單位)-僅適用於 MP4 來源
encoding_rate 整數 BPS 編碼速率-僅適用於 MP4 來源
height 整數 框架高度 (以像素為單位)-僅適用於 MP4 來源
size 整數 檔案大小 (以位元組為單位)-僅適用於 MP4 來源
uploaded_at 字串 以 ISO-8601 日期格式上傳影片的日期
width 整數 框架寬度 (以像素為單位)-僅適用於 MP4 來源

舊式內嵌來源 (轉譯)

欄位 類型
src 字串 URL，僅適用於 PD 網頁資產和 HLS 資產
app_name 字串，僅用於串流網路資產
stream_name 字串，僅用於串流網路資產
codec 字串
container 字串
duration 很久？
encoding_rate 很久？
height 整數
id 字串
size 長
uploaded_at 以 ISO-8601 日期格式表示的字串
width 整數

舊版內嵌 HLS 資訊清單

欄位 類型
src 字串網址
type 字符串（應用程序/X 字符串）
codec 字串
container 字串

舊版內嵌 HDS 資訊清單

欄位 類型
asset_id 字串
src 字串網址
type 字符串（應用程序 /f4m）

舊式內嵌破折號資訊清單

欄位 類型
asset_id 字串
SRC 字串網址
type 字符串（應用程序/破折號 + XML）

傳統內嵌平滑資訊清單 (伺服器和用戶端)

欄位 類型
asset_id 字串
src 字串網址
type 字符串（應用程序 /vnd.ms-sstr+xml）

提示點欄位

下表顯示了提供點的欄位。

提供點欄位
欄位 類型 描述
id 字串 提示點的系統 ID
force_stop 布林 視訊是否應該停止在提示點
metadata 字串；僅限代碼點 與提示點相關聯的中繼資料字串
name 字串 提示點名稱
time 浮動 從影片開始開始測量的提示點時間 (以秒為單位)
type 字串 提示點類型 ( AD或DATA )

地理位置欄位

下表顯示了地理對象字段。

地理篩選欄位
欄位 類型 描述
countries 國家代碼字串陣列 ISO 3166 兩個字母代碼 (https://www.iso.org/obp/ui/) 清單，適用於允許或不允許播放影片的國家
exclude_countries 布林值 如果為 true，則會將國家陣列視為排除在檢視之外的國家清單
restricted 布林值 此視訊是否已啟用地理篩選功能

影像欄位

下表顯示了圖像對象字段

海報欄位

欄位 類型 描述
   images.thumbnail 地圖 對映縮圖影像屬性
poster 物件 視頻海報的屬性（又名視頻靜態）
   poster.asset_id 字串 預設海報的系統 ID
   poster.src 字串網址 預設海報的網址
   poster.sources 地圖陣列 海報的地圖陣列
     poster.sources.asset_id 字串 海報的系統 ID
     poster.sources.src 字串網址 海報的網址
     poster.sources.height 編號 海報高度以像素為單位
     poster.sources.width 編號 以像素為單位的海報寬

縮圖欄位

欄位 類型 描述
thumbnail 物件 視訊縮圖的屬性
   thumbnail.asset_id 字串 預設縮圖影像的系統 ID
   thumbnail.src 字串網址 預設縮圖的來源 URL
   thumbnail.sources 地圖陣列 縮圖影像的地圖陣列
     thumbnail.sources.asset_id 字串 縮圖的系統 ID
     thumbnail.sources.src 字串網址 縮圖的網址
     thumbnail.sources.height 編號 影像高度 (像素)
     thumbnail.sources.width 編號 以像素為單位的影像寬

下表顯示連結物件欄位。

連結欄位
欄位 類型 描述
url 字串 相關連結網址
text 字串 相關連結文字

明細表欄位

下表顯示排程物件的欄位

明細表欄位
欄位 類型 描述
ends_at 以 ISO-8601 日期格式表示的字串 影片無法觀看的日期-時間
starts_at 以 ISO-8601 日期格式表示的字串 影片可供觀賞的日期與時間

共享字段

下表顯示了共享對象字段

共享字段
欄位 類型 描述
by_external_acct 布林值 如果這個視頻是從一些其他帳戶分享的，則為 true。
by_id 字串 產生共用的帳號 ID
source_id 字串 原始影片的視訊 ID (分享者的副本)
to_external_acct 布林值 如果此影片分享給其他帳戶，則為 True
by_reference 布林值 確實是這個視頻是通過參考分享（一律用true於通過 CMS API 分享的視頻）

文字追蹤欄位

下表顯示文字追蹤欄位。

欄位 類型 描述
id 字串 文字追蹤項目的系統識別碼
src 字串 追蹤檔案的位址 (URL)
srclang 字串 賽道的語言，例如「en」
label 字串 使用者可讀取的文字軌目集標題
kind 字串 如何使用軌道：subtitles , captions , descriptions , chapters , metadata
mime_type 字串 MIME 類型的文本軌道，例如「文本/Vtt」
asset_id 字串 追蹤檔案的系統識別碼；如果資產是遠端的，則為 null
in_band_metadata_track_dispatch_type 字串 追蹤檔案的系統識別碼；如果資產是遠端的，則為 null
status 字串 軌道狀態：published , draft， 或者null
sources 陣列 唯讀
   src 字串 追蹤檔案的位址 (URL)
default 布林值 表示該軌道預設為啟用。應該只在一個軌道上是真實的。

成績單字段

下表顯示了成績單字段。

欄位 類型 描述
id 字串 文字追蹤項目的系統識別碼
account_id 字串 系統帳號id
src 字串 追蹤檔案的位址 (URL)
srclang 字串 曲目語言，例如“en”或“ex-MX” - 此字段可以更新
label 字串 文本軌道集的用戶可讀標題 - 該字段可以更新
status 字串 轉錄的狀態，要么published或者draft - 該字段可以更新
sources 陣列 只讀 - 客戶端可以在其中檢索記錄的 URL 數組 - 將有一個http和https每個成績單的 URL
default 布林值 表示該軌道預設為啟用。應該只在一個軌道上是真實的。

由欄位建立

下表顯示了對created_by象字段。

由欄位建立
欄位 類型 描述
type 字串 更新程式的類型-可以是：
  • user -工作室中的用戶
  • api-key -通過 API 的用戶
id 字串 視訊雲端系統中的使用者 ID
email 字串 視訊雲端系統中使用者的電子郵件地址

依欄位更新

下表顯示了對updated_by象字段。

依欄位更新
欄位 類型 描述
type 字串 更新程式的類型-可以是：
  • user -工作室中的用戶
  • api-key -通過 API 的用戶
id 字串 視訊雲端系統中的使用者 ID
email 字串 視訊雲端系統中使用者的電子郵件地址

變體字段

下表顯示了對variant象字段。

依欄位更新
欄位 類型 描述
language 字串 此變體的語言採用語言國家/地區代碼格式（示例：en-US、es-ES）。注意language僅在您創建變體時包含 - 更新變體時不得包含它
name 字串 該語言的視頻標題
description 字串 該語言的視頻標題
long_description 字串 該語言的視頻標題
custom_fields 物件 的地圖fieldname: value 對，其中值適用於該語言；值的最大長度為 1024 個單字節字符。注意：務必使用字段的 內部 名稱，而不是顯示名稱/td>