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

添加提示點

在此示例中,您將學習如何使用編程方式將提示點添加到視頻中 CMS API.

簡介

提示點是視頻時間軸上的指定位置。 播放視頻時,每次到達提示點時都會自動廣播一個事件-使用 Player API,您可以收聽這些事件並採取所需的任何措施。 此外,您還可以從存儲在廣告中的視頻元數據中讀取所有提示點信息 player mediainfo 對象,它使您能夠 在視頻時間軸上標記提示點 如果需要,可以某種方式。

提示點有兩種:

  • 廣告提示點:用於標記應提出廣告請求的位置(如果視頻和 player 已啟用廣告)。
  • 代碼提示點:這些提示點用於使用 Player API -一些典型的用途是顯示某種號召性用語(CTA)或顯示一些與視頻內容有關的圖像或文本,例如,作為視頻疊加層或在頁面周圍 player.

實施概述

您可以在以下位置添加提示點 Studio Media模塊。 您也可以使用 CMS API,這是我們在此示例中將使用的方法。

HTTP方法

提示點可以在您添加時 製作視頻 或以後 更新要求。 在此示例中,我們將通過將其添加到現有視頻中 視頻更新 請求,這意味著您將使用 PATCH 方法。

端點

更新視頻請求的端點是:

          https://cms.api.brightcove.com/v1/accounts/account_id/視頻/VIDEO_ID

請求正文

請求主體是一個JSON對象,可以包含許多視頻元數據項。 在這裡,我們只看一下 cue_points 字段,該字段設置為提示點對象的數組,如以下示例所示:

          {
          "cue_points": [
              {
                "name": "Ad Cue Point",
                "type": "AD",
                "time": 2.0,
                "metadata": null,
                "force_stop": false
              },
              {
                "name": "Code Cue Point",
                "type": "CODE",
                "time": 4.0,
                "metadata": "The metadata might be text or the url for an image to display",
                "force_stop": true
              }
            ]
          }

提示點對象字段

下面是提示點對象的字段的描述。

提示點對象字段
類型 需要的 產品描述
name 沒有 任意名稱-這可能有助於識別您的特定提示點 Player API 碼
type 一定是 AD or CODE
time 從視頻開始到提示點的時間(以秒為單位) [1]
metadata 沒有 最多128個單字節字符的任何字符串-這可能是對提示點事件處理程序有用的信息,例如疊加層的文本或要顯示的圖像的位置
force_stop 布爾 沒有 到達提示點時是否應暫停視頻( force_stop 被忽略 Brightcove Player 並且目前尚無計劃支持它,但是您可以在提示點事件處理程序中手動暫停視頻)

筆記

  • [1] 從技術上講,提示點一直處於活動狀態,直到到達下一個提示點-因此,您可以從提示點數組中檢索提示點數組。 Brightcove Player,你會看到一個 startTimeendTime 以及 time 提示點。

獲取憑證

要使用 CMS API 您將需要適當的憑據。

在大多數情況下,獲取憑據的最簡單方法是通過Studio Admin API身份驗證部分(需要您帳戶的管理員權限)。 看到 管理API身份驗證憑據 有關詳細信息。 在大多數情況下,您可能只想獲取所有權限 CMS API 操作:

CMS API 權限
CMS API 權限

如果您所需的權限在Studio中不可用,或者您希望直接從 OAuth API,請使用您的選擇 獲取客戶憑證 下面列出的文件。 無論選擇哪個選項,都需要詢問正確的操作權限。 以下內容可與cURL或Postman一起使用,以獲取對 CMS API:

          "operations": [
            "video-cloud/video/all",
            "video-cloud/playlist/all",
            "video-cloud/sharing-relationships/all",
            "video-cloud/notifications/all"
          ]

示例應用

在此找到與此樣本相關的所有代碼 GitHub存儲庫.

見筆 CMS API 樣本:添加提示點 通過Brightcove學習服務( @ rcrooks1969)上 CodePen.

使用CodePen

以下是有效使用上述CodePen的一些技巧:

  • 通過點擊來切換應用的實際顯示 結果 按鈕。
  • 點擊 HTML / CSS / JS 按鈕顯示一種代碼類型。
  • 點擊 在CodePen上編輯 在右上角將此CodePen分支到您自己的帳戶中。
  • 在此找到與此樣本相關的所有代碼 GitHub存儲庫.

代理代碼

為了在此頁面上構建自己的示例應用程序版本,您必須創建並託管自己的代理。 (Brightcove Learning Services使用的代理僅接受來自Brightcove域的請求。)一個示例代理與我們使用的代理非常相似,但是沒有可以阻止來自非Brightcove域的請求的檢查。 這個GitHub倉庫。 您還將在此處找到使用它的基本說明,以及有關在Proxy中構建應用的更詳盡的指南。 使用REST API.


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