支持 聯繫支持 | 系統狀況 系統狀態

CMS API 視頻場參考

這是對由 CMS API.

視頻領域

視頻場
類型 產品描述
account_id Video Cloud 帳戶ID
ad_keys 字符串,代表分配給視頻的廣告鍵/值對。 鍵/值對的格式設置為鍵=值,並用與號分隔。 例如: "adKeys": "category=sports&live=true"
clip_source_video_id 裁剪產生該視頻的源視頻的ID或 null 如果該視頻不是另一個視頻的剪輯。
complete 布爾 處理是否完成-注意:創建新視頻時,complete屬性將自動設置為 false。 視頻存在一個副本時,complete屬性將自動設置為 true
created_at 數字,從紀元開始的毫秒數 在視頻中創建視頻時 Video Cloud 系統
created_by 對象 有關創建視頻的人的信息(如果有)
cue_points 地圖陣列 提示點圖數組
custom_fields 字段-值對映射(字符串) 為視頻設置了自定義字段值-請注意, 該視頻的價值未包含在此地圖中; 自定義字段值的最大長度為1024個單字節字符
dash_manifest_id DASH清單的系統ID
delivery_type 視頻的投放類型:
  • dynamic_origin -動態交付
  • live_origin -來自Brightcove的直播 Live
  • remote -資產
  • static_origin -舊版攝取系統
  • unknown -無法確定(可能意味著視頻沒有可播放的演繹形式)
description 串; 代替舊的簡短描述 視頻的簡短描述(最大長度:248個單字節字符)
digital_master_id 數字主站的系統ID
drm_disabled 布爾 對於啟用DRM的帳戶,將其設置為true將防止視頻被DRM打包。 如果帳戶未啟用DRM,則不會顯示此字段。
duration 數,毫秒 視頻的持續時間(以毫秒為單位)
economics 字符串,必須是有效的枚舉值之一 “ AD_SUPPORTED”(默認)或“ FREE”
folder_id 視頻所屬文件夾的ID
geo [1-3] 屬性值對映射 視頻的地理限制屬性
has_digital_master 布爾 視頻是否具有可用於重新轉碼的存檔母帶。 請注意,如果您使用此字段測試視頻是否可以重新轉碼,則共享視頻不可靠。 如果視頻已共享到帳戶,則需要同時測試 has_digital_master = truesharing.by_external_acct = false
id 影片編號
images 屬性值對映射 有關海報和縮略圖的信息圖
link 屬性值對映射 相關鏈接屬性的地圖
long_description 詳細說明(最多5000個字符)
name 視頻名稱(最大長度:248個單字節字符)
offline_enabled 布爾 視頻是否已啟用離線播放
original_filename 提取的視頻文件的名稱-對於遠程資產視頻將為空
projection 360°視頻的映射投影,例如“矩形”
published_at ISO-8601日期時間字符串,指示視頻何時發布-請注意,此字段可寫; 默認情況下,它設置為視頻首次激活的日期。
reference_id 用戶指定的ID 唯一地標識視頻,限制為150個字符。 referenceId可以用作在另一個系統中標識此視頻的外鍵。 參考ID不得包含空格,逗號或特殊字符。
schedule [1-1] 屬性值對映射 視頻可用性的開始和結束日期時間圖
sharing 屬性值對映射 視頻共享屬性的地圖
smooth_client_manifest_id 平滑清單的系統ID
smooth_server_manifest_id 平滑清單服務器的系統標識
state [1-4] 活動,不活動,待處理,已刪除
tags [1-5] 標籤數組(字符串) 分配給視頻的標籤數組
text_tracks HTML5樣式的文本軌道的數組 分配給視頻的文本軌道(WebVTT文件)的數組
updated_at 日期時間字符串 視頻的上次修改日期 [1-2]
updated_by 對象 有關誰最後更新了視頻的信息(如果有)

筆記

  • [1-1] 請注意,預定視頻是 在計劃的可用性時段之外處於非活動狀態
  • [1-2] 修改可能已由用戶或 Video Cloud 系統
  • [1-3] 地理位置限制是付費的附加功能 Video Cloud; 如果您想購買地理過濾功能,請聯繫您的客戶經理
  • [1-4] state 可以設置為 ACTIVE or INACTIVE,但 PENDING or 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 配置文件-僅適用於DASH源
codec 視頻編解碼器-僅適用於MP4源
container 視頻容器-僅適用於MP4源
duration 整型 持續時間(以毫秒為單位)-僅適用於MP4來源
encoding_rate 整型 BPS中的編碼率-僅適用於MP4來源
height 整型 幀高(以像素為單位)-僅適用於MP4源
size 整數 文件大小(以字節為單位)-僅適用於MP4源
uploaded_at 以ISO-8601日期格式上傳視頻的日期
width 整型 幀寬度(以像素為單位)-僅適用於MP4源

舊版攝取源(翻譯)

類型
src 字符串網址, 僅適用於PD網站資產和HLS資產
app_name 串, 僅適用於流媒體網絡資產
stream_name 串, 僅適用於流媒體網絡資產
codec
container
duration 長?
encoding_rate 長?
height 整型
id
size
uploaded_at ISO-8601日期格式的字符串
width 整型

舊版攝取HLS清單

類型
src 字串網址
type 字符串(application / x-mpegURL)
codec
container

舊版攝取HDS清單

類型
asset_id
src 字串網址
type 字符串(應用程序/ f4m)

舊版攝取Dash清單

類型
asset_id
SRC 字串網址
type 字符串(application / dash + xml)

舊版攝取平滑清單(服務器和客戶端)

類型
asset_id
src 字串網址
type 字符串(application / vnd.ms-sstr + xml)

提示點字段

下表顯示了提示點的字段。

提示點字段
類型 產品描述
id 提示點的系統ID
force_stop 布爾 視頻是否應在提示點停止
metadata 串; 僅代碼點 與提示點關聯的元數據字符串
name 提示點名稱
time 浮球 從視頻開始算起的提示點時間(以秒為單位)
type 提示點類型( AD or DATA)

地理領域

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

地理過濾字段
類型 產品描述
countries 國家/地區代碼字符串數組 允許或不允許播放視頻的國家/地區的ISO 3166 2字母代碼列表(https://www.iso.org/obp/ui/)的數組
exclude_countries 布爾 如果為true,則將國家/地區數組視為被排除在外的國家/地區列表
restricted 布爾 是否為此視頻啟用了地理過濾

圖像場

下表顯示圖像對象字段

海報領域

類型 產品描述
images.thumbnail 地圖 映射縮略圖屬性
poster 對象 視頻海報的屬性(又稱視頻靜止圖像)
poster.asset_id 默認海報的系統ID
poster.src 字串網址 默認海報的URL
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 字串網址 縮略圖的URL
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 文字跟踪項的系統ID
src 跟踪文件的地址(URL)
srclang 曲目的語言,例如“ en”
label 文本軌道集的用戶可讀標題
kind 軌道的使用方式:“字幕”,“字幕”,“描述”,“章節”,“元數據”
mime_type 文本軌道的mime類型,例如“ text / vtt”
asset_id 跟踪文件的系統ID; 如果資產是遠程的,則為null
in_band_metadata_track_dispatch_type 跟踪文件的系統ID; 如果資產是遠程的,則為null
sources 排列 唯讀
src 跟踪文件的地址(URL)
default 布爾 指示默認情況下應啟用該軌道。 只能在一條軌道上為真。

由字段創建

下表顯示了 created_by 對象字段。

由字段創建
類型 產品描述
type 更新程序的類型-可以是:
  • user -Studio中的用戶
  • api-key -通過API的用戶
id 中的用戶ID Video Cloud 系統
email 用戶的電子郵件地址在 Video Cloud 系統

按字段更新

下表顯示了 updated_by 對象字段。

由字段更新
類型 產品描述
type 更新程序的類型-可以是:
  • user -Studio中的用戶
  • api-key -通過API的用戶
id 中的用戶ID Video Cloud 系統
email 用戶的電子郵件地址在 Video Cloud 系統

頁面最後更新於12年2020月XNUMX日