使用 CMS API 管理文本軌道

在本主題中，您將了解如何使用 CMS API 更新視頻的 WebVTT 文本軌道。

簡介

無論是攝取文本軌道（靜態或動態）還是遠程，您都可以使用PATCH請求更新與文本軌道關聯的元數據。

注意事項

授權

對 CMS API 的請求需要一個包含您的訪問令牌的授權標頭。如需有關如何取得用戶端認證並使用它們來擷取存取權杖的詳細資訊，請參閱 Brightcove OAuth 概觀。

您需要更新視頻元數據的操作是video-cloud/video/update要么video-cloud/video/all。

語法

我們建議首先發出以下請求以獲取完整的數組：


GET
https://cms.api.brightcove.com/v1/accounts/{account_id}/videos/{video_ID}

更新文本軌道

更新 Text Tracks 時， Text Tracks Fields 中的某些字段可以根據其類型進行不同的處理。

文字追蹤欄位
欄位 類型 遠程文本軌道 靜態攝取的文本軌道 動態攝取的文本軌道
id 字串 只讀值。需要標識需要更新的 TT。
account_id 字串 該字段的更新將被忽略。
src 字串 必需且限制為 255 個字符。 該字段的更新將被忽略。
srclang 字串 限制為 32 個字符。
label 字串 限制為 255 個字符。
kind 枚舉 有效值為：
  • subtitles
  • captions
  • descriptions
  • chapters
  • metadata
status 枚舉 有效值（區分大小寫）：
  • published - 文本軌道將提供給觀眾
  • draft - 觀眾將無法使用文字軌道
  • null -（默認）文本軌道將對觀眾可用
mime_type 字串 限制為 32 個字符。 該字段的更新將被忽略。
asset_id 字串 只讀值。 字段不適用於此類型。該字段的更新將被忽略。
in_band_metadata_track_dispatch_type 字串 字段不適用於此類型。 該字段的更新將被忽略。
sources 陣列 只讀值。
default 布林值 true或者false .場default對於攝取的文本軌道，遠程和攝取的文本軌道具有相同的行為。您不能添加多個default=true以不同的文本軌道srclang .  

請求

適用於遠程、靜態和動態文本軌道。


PATCH
https://cms.api.brightcove.com/v1/accounts/{account_id}/videos/{video_ID}

請求正文示例

遠程文本軌道

請求主體將是一個JSON對象，其中包含文本軌道數組：

        
          {
  "text_tracks" : 
  [ 
    { 
      "id" : "1234-1234-1234"
      "src" :     "https://some.site.com/captions/bc_smart_ja.vtt",
      "srclang" : "ja", 
      "label" : "日本人", 
      "kind" : "captions", 
      "mime_type" : null, 
      "default" : true,
      "status": "published"
    }, 
    { 
      "id" : "5678-5678-5678"
      "src" : "https://some.site.com/captions/bc_smart_es.vtt",  
      "srclang" : "es", 
      "label" : "español", 
      "kind" : "descriptions",
      "mime_type" : null,
      "default" : false,
      "status": "published"
    } 
  ] 
}
靜態文本軌道

請求主體將是一個JSON對象，其中包含文本軌道數組：

        
          {
  "text_tracks" : 
  [ 
    { 
      "id" : "1234-1234-1234"
      "srclang" : "ja", 
      "label" : "日本人", 
      "kind" : "captions", 
      "mime_type" : null, 
      "default" : true,
      "status": "published"
    }, 
    { 
      "id" : "5678-5678-5678"  
      "srclang" : "es", 
      "label" : "español", 
      "kind" : "descriptions",
      "mime_type" : null,
      "default" : false,
      "status": "published"
    } 
  ] 
}
動態文本軌道

請求主體將是一個JSON對象，其中包含文本軌道數組：

        
          {
  "text_tracks" : 
  [ 
    { 
      "id" : "1234-1234-1234"
      "srclang" : "ja", 
      "label" : "日本人", 
      "kind" : "captions", 
      "mime_type" : null, 
      "default" : true,
      "status": "published" 
    }, 
    { 
      "id" : "5678-5678-5678"  
      "srclang" : "es", 
      "label" : "español", 
      "kind" : "descriptions",
      "mime_type" : null,
      "default" : false,
      "status": "published" 
    } 
  ] 
}