視訊欄位參考

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

主要欄位

表 1:主要欄位
欄位 類型 預設 描述
id 字串 視訊識別碼
account_id 字串 帳號的ID
created_at ISO 8601 日期時間字符串 視頻添加到帳戶的日期時間;例:“2014-12-09T06:07:11.877Z”
cue_points 陣列的cue_point 對象 空數組 插播廣告請求標記或通過播放器API創建的其他操作
custom_fields 物件 空物體 自定義字段名稱:值對的映射;僅包含具有值的字段
description 字串 視頻的簡短描述-最多250個單字節字符
duration 編號 視頻長度(以毫秒為單位)
economics 字串 AD_SUPPORTED 指示是否允許視頻請求廣告。價值觀:AD_SUPPORTED或者FREE
labels 字符串數組 分配給視頻的 標籤 數組
link 鏈接對象 相關鏈接
long_description 字串 最多5000個單字節字符
name 字串 視頻標題-必填字段(最多256個單字節字符)
poster 字串 海報圖片網址
poster_sources 陣列 [] 與視頻海報對應的對像數組。當前只有一個海報,因此只有一個對象。該對象具有單個屬性src其值是海報圖像的 URL。
published_at ISO 8601 日期時間字符串 視頻發布的日期時間;例:“2014-12-09T06:07:11.877Z”
reference_id 字串 帳戶中唯一的任何值(最多150個單字節字符)
sources 陣列 空陣列 陣列的視頻源對象
tags 陣列 空陣列 添加到視頻中的標籤(字符串)數組(每個標籤最多128個單字節字符)
text_tracks 陣列的text_track 對象 空陣列 與視頻關聯的WebVTT字幕的數據
thumbnail 字串 縮略圖網址
thumbnail_sources 陣列 [] 與視頻縮略圖相對應的對像數組。當前只有一個縮略圖,因此只有一個對象。該對象具有單個屬性src其值為縮略圖的 URL。
updated_at ISO 8601 日期時間字符串 上次修改視頻的日期時間; [1-2]例子:“2015-01-13T17:45:21.977Z”
variants 陣列 [] 包含視頻的多語言元數據的對像數組

注意事項

  • [1-2]修改可能是由用戶或視頻雲系統進行的

源對象

表2:源對象字段
欄位 類型 預設 描述
asset_id 字串 Video Cloud中的演繹ID
app_name 字串 RTMP流的RTMP地址
avg_bitrate 整數 演繹的平均比特率
codec 字串 視頻編解碼器
container 字串 視頻容器類型
duration 整數 持續時間(以毫秒為單位)
key_systems 物件 DRM規範對象 -如果定義了此對象,則其源受內容保護
size 整數 大小(以字節為單位)
src 字串 源URL
stream_name 字串 RTMP流的流名稱
type 字串 定義使用的通信協議的視頻MIME類型-值:
  • 高低層:application/x-mpegURL
  • 高低層:application/vnd.apple.mpegurl
  • 短跑:application/dash+xml
  • MP4: video/mp4
width 整數 再現的像素寬度

cue_point對象

表3:提示點物件欄位
欄位 類型 預設 描述
id 字串 提示點編號
name 字串 提示點的可選名稱(最多128個單字節字符)
type 字串 AD 價值觀:AD或者CODE
time 編號 提示點的時間,以秒為單位;例:+10.527
metadata 字串 可選的元數據字符串(最多512個單字節字符)
force-stop 布林值 false 視頻是否在提示點被強制停止
表4:鏈接對象字段
欄位 類型 預設 描述
text 字串 顯示鏈接的文字
url 字串 鏈接的URL

text_track對象

表5:文字追蹤欄位
欄位 類型 預設 描述
src 字串(URL) .vtt文件所在的URL
srclang ISO-639-1語言代碼 字幕語言
label 字串 播放器菜單中要使用的標籤-應該與字幕使用相同的語言
kind 字串

如何使用軌道:subtitles , captions , descriptions , chapters , metadata

有關這些值的詳細信息,請參閱 使用媒體模塊文檔向視頻添加字幕
mime_type 弦樂 字幕的 mime_type [9-1]
default 布林值 false 將此設置為true會使其成為播放器菜單中的默認字幕文件

注意事項

  • [9-1]設置 mime_type 是可選的,但字幕應該是 UTF-8 編碼的,並且 mime_type 為“text/vtt”

key_systems目的

key_systems 對象包含一個對象列表,每個對像對應一個 DRM 密鑰名稱。如果定義了此對象,則其源受內容保護。

表4:key_systems對象
欄位 類型 預設 描述
鍵名 物件 指定 DRM 類型的對象的名稱 - 有效密鑰包括:

* 公平競爭:com.apple.fps.1_0
* 播放就緒:com.microsoft.playready
* 維維文:com.widevine.alpha
FairPlay 使用key_request_urlcertificate_url
別人用license_url
字串 DRM許可證或證書所在的URL
 

範例 1:

    "key_systems": {
      "com.apple.fps.1_0": {
        "key_request_url": "https://....",
        "certificate_url": "https://..."
      }
    }

範例 2:

    "key_systems": {
      "com.microsoft.playready": {
        "license_url": "https://..."
      },
      "com.widevine.alpha": {
        "license_url": "https://..."
      }
    },

variant目的

每個variant包含特定語言的視頻元數據版本。

表 5:變體對象
欄位 類型 預設 描述
language 字串 language-COUNTRY 形式的變體語言,例如ja-JA
name 字串 翻譯的標題
description 翻譯的描述
long_description 翻譯後的 long_description
custom_fields 對象 {} 自定義字段的鍵值對映射

範例

{
  "language": "ja-JA",
  "name": "バーゼル:ライン川",
  "description": "スイス、バーゼルの中心部にあるライン川のパノラマビュー。",
  "long_description": "スイス、バーゼルの中心部にあるライン川のパノラマビュー。",
  "custom_fields": {
    "language": "Japanese"
  }
}