サポート問い合わせ先
システムステータスデータの取得
Dynamic Ingest の通知には、あなたが知る必要があるすべての情報が動画の準備ができたときに表示されます - あなたはただ、どの情報を探しているかと..."ready" があなたのシステムにとってどう定義されているかを知る必要があります。こちらの図は、ワークフローをまとめたものです:
Dynamic Ingest の通知
Dynamic Ingest 通知サービスは、いくつかの種類のイベントの通知をあなたに送信します。ビデオがいつ "ready" なのか判断するために最も有用なことが三つあり、ひとつは特定のレンディションが作成されたことを示すものと、もうひとつはマニフェストが作成されたことを示すもの、そしてすべての処理が完了したことを示すものです。それぞれの例を以下に示します:
レンディション作成通知
{
"entity": "5002412132001",
"profileRefId": "ts7",
"accountId": "57838016001",
"entityType": "ASSET",
"videoId": "5002361893001",
"status": "SUCCESS",
"version": "1",
"action": "CREATE",
"jobId": "bb316631-c58b-4bd4-a686-13c5f7a3a779"
}
こちらの例の注意点：
- 挽き目
videoIdの値からレンディションがどの動画のものなのかがわかります（あなたが複数のインジェストジョブを実行している場合） - 挽き目
profileRefIdの値は、トランスコードプロファイルで指定されたレンディションの参照 ID です。 - もし
statusの値が "SUCCESS" の場合、レンディションは正常に作成されています - HLS や MPEG-DASH のようなセグメント化されたタイプの場合、レンディションの存在はそれを再生可能にはしません - 適適切なマニフェスト（次の例を参照）も必要です。 MP4 レンディションは作成されるとすぐに再生可能です。
マニフェストによって作成された通知
{
"jobId": "31f0b112-9890-4567-adb5-0f4ed1673701",
"status": "SUCCESS",
"version": "1",
"action": "CREATE",
"entityType": "ASSET",
"entity": "5002412528001",
"videoId": "5002361895001",
"profileRefId": "HlsManifest",
"accountId": "57838016001"
}
こちらの例の注意点：
- 挽き目
videoIdの値からレンディションがどの動画のものなのかがわかります（あなたが複数のインジェストジョブを実行している場合） - 挽き目
profileRefIdの値は特別なコードで、作成されたアセットが HLS マニフェストであることを伝えます（他の値はHdsManifest,DashManifestおよびSmoothIsmManifest) - HLS と HDS の場合、一つのマニフェストが作成されるので、一つの通知が表示されます。 DASH と SmoothIsm の場合、二つのマニフェストが作成されるので（ひとつは従来の Media API で使用するもの、もうひとつは CMS API で使用するもの）、こちらのタイプの二つの通知が表示されます。
- もし
status値が "SUCCESS"の場合、マニフェストは正常に作成されました - HLS や MPEG-DASH のようなセグメント化されたタイプの場合、レンディションとマニフェストの作成のための明確な順序はありません - これらのレンディションは、両方が作成されるまで（またはその動画が完全に処理されるまで - 次の例を参照してください）再生できません。
処理完了通知
{
"entityType": "TITLE",
"status": "SUCCESS",
"accountId": "57838016001",
"entity": "5002412652001",
"action": "CREATE",
"jobId": "3e98b3a0-f624-4f2d-81c1-4e43e1d04a0f",
"version": "1",
"videoId": "5002412652001"
}
こちらの例の注意点：
- 挽き目
videoIdの値からレンディションがどの動画のものなのかがわかります（あなたが複数のインジェストジョブを実行している場合） - 挽き目
profileRefIdis Studio上ではサポートされていません。 こちらの通知に含まれていません - もし
statusの値が "SUCCESS" の場合、動画は正常に処理されています
通知を受け取るには、一つまたはそれ以上のコールバックアドレスを指す "callbacks" フィールドを Dynamic Ingest API リクエストに含める必要があります:
{
"master": {
"url": "https://s3.amazonaws.com/bucket/mysourcevideo.mp4"
}, "profile": "high-resolution",
"callbacks": ["http://host1/path1”, “http://host2/path2”]
}
サンプルダッシュボード
こちらのセクションでは、Dynamic Ingest API 用のシンプルなダッシュボードを構築するために通知をまとめる方法を説明します。通知ハンドラは処理完了の通知を識別するために Dynamic Ingest API からの通知を解析します。そして動画の通知を JSON ファイル内にある各動画のオブジェクトの配列に追加します。ダッシュボード自体は HTML ページで、JSON ファイルをインポートして通知データを取得します。ID を使い、 CMS API にリクエストをし、動画のメタデータを取得します。こちらからダッシュボードを見ることができます ぜひこちらから皆様もその幸せなお客様の輪に加わりましょう。.
こちらのアプリケーションのすべてのファイルは、あなたのアカウント用の設定手順とともに、 こちらのリポジトリにあります。.
こちらはこのアプリケーションの高水準なアーキテクチャです:
アプリパーツ
通知のハンドラは PHP で構築されています - 処理完了の通知を探し、ビデオ ID を別の JavaScript ファイルの配列に追加します:
<?php
// var to log errors, if any
$problem = "No errors";
// var to store current video index
$videoIndex = -1;
// get input data
try {
$json = file_get_contents('php://input');
$decoded = json_decode($json, true);
} catch (Exception $e) {
$problem = $e->getMessage();
echo $problem;
}
// get the data file contents and parse them
try {
$notificationData = file_get_contents('di.json');
$notificationDataDecoded = json_decode($notificationData, true);
} catch (Exception $e) {
$problem = $e->getMessage();
echo $problem;
}
if (isset($decoded["entityType"])) {
$entityType = $decoded["entityType"];
// if the entity type is ASSET or TITLE, add it to notification data array
if ($entityType == "ASSET" || $entityType == "TITLE") {
array_push($notificationDataDecoded, $decoded);
}
// now we'll replace the contents of di.json with what we have
file_put_contents('di.json', json_encode($notificationDataDecoded));
}
echo "Dynamic Ingest callback app is running";
var_dump($notificationData);
?>
JSON ファイル：
JSON ファイルは、最初は空の配列 ([]) です - データは通知ハンドラによって追加されます。
ダッシュボード
ダッシュボードには HTML と JavaScript が含まれており、CMS API から通知データと追加のビデオデータを取得し、その結果を表に書き込みます:
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Dynamic Ingest Log</title>
<style>
body {
font-family: sans-serif;
margin: 5em;
}
.hide {
display: none;
}
.show {
display: block;
}
table {
border-collapse: collapse;
border: 1px #999999 solid;
}
th {
background-color: #666666;
color: #f5f5f5;
padding: .5em;
font-size: .7em;
}
td {
border: 1px #999999 solid;
font-size: .7em;
padding: .5em
}
.hidden {
display: none;
}
</style>
</head>
<body>
<h1>Dynamic Ingest Log</h1>
<h2>Account: Brightcove Learning (57838016001)</h2>
<p style="width:70%">
Videos are listed in order of processing completion time, newest to oldest. The reference id (generated by the <a href="./di-tester.html">Dynamic Ingest tester</a>) is a combination of the date/time that the Dynamic Ingest job was initiated and the ingest profile that was used. You can add additional videos using the <a href="./di-tester.html">Dynamic Ingest tester</a>. New videos will appear in this log after processing is complete.
</p>
<p>
<button id="clearLogBtn">Clear the log</button>
</p>
<div id="videoLogBlock">
<table>
<thead>
<tr>
<th>Video ID</th>
<th>Name</th>
<th>Reference ID</th>
<th>HLS Manifests Created</th>
<th>HLS Renditions Created</th>
<th>MP4 Renditions Created</th>
<th>Processing Complete</th>
</tr>
</thead>
<tbody id="logBody"></tbody>
</table>
<h4 id="loadingMessage">Loading data, please wait...</h4>
</div>
<script>
var BCLS = ( function (window, document) {
// to use another account, set the account_id value appropriately
// the client_id and client_secret will also need to be changed in the proxy
var my_account_id = 57838016001,
account_id = my_account_id,
logBody = document.getElementById('logBody'),
loadingMessage = document.getElementById('loadingMessage'),
clearLogBtn = document.getElementById('clearLogBtn'),
i = 0,
iMax,
// set the proxyURL to the location of the proxy app that makes Brightcove API requests
proxyURL = './brightcove-learning-proxy.php',
dataFileURL = './di.json',
videoDataArray = [],
requestOptions = {},
currentVideo,
currentIndex = 0;
/**
* Logging function - safe for IE
* @param {string} context - description of the data
* @param {*} message - the data to be logged by the console
* @return {}
*/
function bclslog(context, message) {
if (window["console"] && console["log"]) {
console.log(context, message);
}
return;
}
/**
* tests for all the ways a variable might be undefined or not have a value
* @param {*} x the variable to test
* @return {Boolean} true if variable is defined and has a value
*/
function isDefined(x) {
if ( x === '' || x === null || x === undefined || x === NaN) {
return false;
}
return true;
}
/**
* find index of an object in array of objects
* based on some property value
*
* @param {array} targetArray - array to search
* @param {string} objProperty - object property to search
* @param {string|number} value - value of the property to search for
* @return {integer} index of first instance if found, otherwise returns null
*/
function findObjectInArray(targetArray, objProperty, value) {
var i, totalItems = targetArray.length, objFound = false;
for (i = 0; i < totalItems; i++) {
if (targetArray[i][objProperty] === value) {
objFound = true;
return i;
}
}
if (objFound === false) {
return null;
}
}
/**
* factory for new video objects
* @param {String} videoId the video id
* @return {object} the new object
*/
function makeVideoDataObject(videoId) {
var obj = {};
obj.id = videoId;
obj.name = '';
obj.reference_id = '';
obj.hlsManifests = 0;
obj.hlsRenditions = 0;
obj.mp4Renditions = 0;
obj.complete = 'no';
return obj;
}
/**
* processes notification objects
* creates a new object in the videoDataArray if it doesn't exist
* and updates the videoDataArray object based on the notification
* @param {Object} notificationObj the raw notification object
*/
function processNotification(notificationObj) {
var objIndex, videoObj;
// if notification object contains a video id, find the corresponding
// object in the videoDataArray or create it if it's not there
if (isDefined(notificationObj) && isDefined(notificationObj.videoId)) {
objIndex = findObjectInArray(videoDataArray, 'id', notificationObj.videoId);
// if not found, create one
if (!isDefined(objIndex)) {
videoObj = makeVideoDataObject(notificationObj.videoId);
videoDataArray.push(videoObj);
objIndex = videoDataArray.length - 1;
}
// now update properties based on what's in the notification
if (notificationObj.entityType === 'ASSET') {
// if it's a rendition or manifest, there will be a profileRefId
if (isDefined(notificationObj.profileRefId)) {
// see if it's an HLS manifest
if (notificationObj.profileRefId === 'HlsManifest') {
// increment the hls manifest count
videoDataArray[objIndex].hlsManifests++;
} else if (notificationObj.profileRefId.charAt(0) === 't') {
// increment the hls rendition count
videoDataArray[objIndex].hlsRenditions++;
} else if (notificationObj.profileRefId.charAt(0) === 'm') {
// increment the mp4 rendition count
videoDataArray[objIndex].mp4Renditions++;
}
}
} else if (notificationObj.entityType === 'TITLE') {
// overall processing notification - checked for SUCCESS / FAILED
if (notificationObj.status === 'SUCCESS') {
// mark complete
videoDataArray[objIndex].complete = 'yes';
} else if (notificationObj.status === 'FAILED') {
// mark failed
videoDataArray[objIndex].complete = 'failed';
}
}
}
return;
}
/**
* creates the dashboard table body
*/
function writeReport() {
var j,
jMax = videoDataArray.length,
item,
t;
loadingMessage.textContent = 'This page will refresh in 1 minute...';
/* just showing HLS and MP4 renditions, because
* that's all that will be produced in this account,
* but you could modify the notification handler and
* this page to handle other formats
*/
for (j = 0; j < jMax; j++) {
item = videoDataArray[j];
if (item.id !== undefined) {
logBody.innerHTML += '<tr><td>' + item.id + '</td><td>' + item.name + '</td><td>' + item.reference_id + '</td><td>' + item.hlsManifests + '</td><td>' + item.hlsRenditions + '</td><td>' + item.mp4Renditions + '</td><td>' + item.complete + '</td></tr>';
}
}
// set timeout for refresh
t = window.setTimeout(init, 60000);
};
// function to set up the notification data request
function setJSONRequestOptions() {
submitRequest(null, dataFileURL, 'notificationData');
}
// function to set up video data request
function setVideoRequestOptions() {
requestOptions = {};
requestOptions.url = 'https://cms.api.brightcove.com/v1/accounts/' + account_id + '/videos/' + currentVideo.id;
submitRequest(requestOptions, proxyURL, 'video');
}
/**
* initiates the cms api requests
*/
function getVideoInfo() {
iMax = videoDataArray.length;
if (currentIndex < iMax) {
currentVideo = videoDataArray[currentIndex];
setVideoRequestOptions();
} else {
loadingMessage.innerHTML = 'No videos have been ingested - you can add some using the <a href="./di-tester.html">Dynamic Ingest tester</a>';
}
}
/**
* make the cms api requests
* @param {Object} options request options
* @param (String) url URL to send request to
* @param (String) type the request type
*/
function submitRequest(options, url, type) {
var httpRequest = new XMLHttpRequest(),
requestData,
responseData,
videoDataObject,
parsedData,
getResponse = function () {
try {
if (httpRequest.readyState === 4) {
if (httpRequest.status === 200) {
responseData = httpRequest.responseText;
switch (type) {
case 'notificationData':
var k, kMax, dataArray;
dataArray = JSON.parse(responseData);
bclslog('dataArray', dataArray);
// process the notifications
kMax = dataArray.length;
for (k = 0; k < kMax; k++) {
processNotification(dataArray[k]);
}
getVideoInfo();
break;
case 'video':
parsedData = JSON.parse(responseData);
bclslog('parsedData', parsedData);
videoDataArray[currentIndex].reference_id = parsedData.reference_id;
videoDataArray[currentIndex].name = parsedData.name;
currentIndex++;
if (currentIndex < iMax) {
currentVideo = videoDataArray[currentIndex];
setVideoRequestOptions();
} else {
writeReport();
}
break;
}
} else {
bclslog("There was a problem with the request. Request returned " + httpRequest.status);
if (type === 'video') {
setVideoRequestOptions();
} else {
setSourcesRequestOptions();
}
}
}
}
catch(e) {
bclslog('Caught Exception: ' + e);
}
};
// notifications data is a special case
if (type === 'notificationData') {
// set response handler
httpRequest.onreadystatechange = getResponse;
// open the request
httpRequest.open("GET", url);
// set headers
httpRequest.setRequestHeader("Content-Type", "application/json");
// open and send request
httpRequest.send();
} else {
// requests via proxy
// set up request data
requestData = "url=" + encodeURIComponent(options.url) + "&requestType=GET";
// set response handler
httpRequest.onreadystatechange = getResponse;
// open the request
httpRequest.open("POST", url);
// set headers
httpRequest.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
// open and send request
httpRequest.send(requestData);
}
};
// event handlers
clearLogBtn.addEventListener('click', function () {
if (window.confirm('Are you sure? This action cannot be undone!')) {
// if your clear-log app resides in another location, change the URL
window.location.href = 'clear-log.php';
}
});
// get things started
function init() {
// clear table and the video data array
logBody.innerHTML = "";
videoDataArray = [];
setJSONRequestOptions();
}
// kick off the app
init();
})(window, document);
</script>
</body>
</html>
プロキシ
<?php
/**
* brightcove-learning-proxy.php - proxy for Brightcove RESTful APIs
* gets an access token, makes the request, and returns the response
* Accessing:
* URL: https://solutions.brightcove.com/bcls/bcls-proxy/bcsl-proxy.php
* (note you should *always* access the proxy via HTTPS)
* Method: POST
*
* @post {string} url - the URL for the API request
* @post {string} [requestType=GET] - HTTP method for the request
* @post {string} [requestBody=null] - JSON data to be sent with write requests
*
* @returns {string} $response - JSON response received from the API
*/
// CORS enablement
header("Access-Control-Allow-Origin: *");
// set up request for access token
$data = array();
//
// change the values below to use this proxy with a different account
//
$client_id = "YOUR_CLIENT_ID_HERE";
$client_secret = "YOUR_CLIENT_SECRET_HERE";
$auth_string = "{$client_id}:{$client_secret}";
$request = "https://oauth.brightcove.com/v4/access_token?grant_type=client_credentials";
$ch = curl_init($request);
curl_setopt_array($ch, array(
CURLOPT_POST => TRUE,
CURLOPT_RETURNTRANSFER => TRUE,
CURLOPT_SSL_VERIFYPEER => FALSE,
CURLOPT_USERPWD => $auth_string,
CURLOPT_HTTPHEADER => array(
'Content-type: application/x-www-form-urlencoded',
),
CURLOPT_POSTFIELDS => $data
));
$response = curl_exec($ch);
curl_close($ch);
// Check for errors
if ($response === FALSE) {
die(curl_error($ch));
}
// Decode the response
$responseData = json_decode($response, TRUE);
$access_token = $responseData["access_token"];
// set up the API call
// get data
if ($_POST["requestBody"]) {
$data = json_decode($_POST["requestBody"]);
} else {
$data = array();
}
// get request type or default to GET
if ($_POST["requestType"]) {
$method = $_POST["requestType"];
} else {
$method = "GET";
}
// get the URL and authorization info from the form data
$request = $_POST["url"];
//send the http request
$ch = curl_init($request);
curl_setopt_array($ch, array(
CURLOPT_CUSTOMREQUEST => $method,
CURLOPT_RETURNTRANSFER => TRUE,
CURLOPT_SSL_VERIFYPEER => FALSE,
CURLOPT_HTTPHEADER => array(
'Content-type: application/json',
"Authorization: Bearer {$access_token}",
),
CURLOPT_POSTFIELDS => json_encode($data)
));
$response = curl_exec($ch);
curl_close($ch);
// Check for errors
if ($response === FALSE) {
echo "Error: "+$response;
die(curl_error($ch));
}
// Decode the response
// $responseData = json_decode($response, TRUE);
// return the response to the AJAX caller
echo $response;
?>
ログを消去する
こちらのシンプルな PHP アプリケーションは JavaScript ファイルを元の状態に戻し、古い動画の ID を消去します:
<?php
$logFileLocation = "di.json";
$freshContent = array ();
$encodedContent = json_encode($freshContent);
file_put_contents($logFileLocation, $encodedContent);
echo 'Log file cleared - <a href="di-log.html">go back to the dashboard</a>';
?>