要件
- アカウントのライブ API キー。
- ライブアカウントでは、スケジューラオーバーライドを有効にする必要があります。
クリップスケジューラワークフローを作成する
クリップを作成するときは、クリップ要求を行うために、クリップ時間の境界(出力フィールド)とスケジュールされた時間(
time_utc
フィールド)の両方を指定する必要があります。
リクエストボディの出力フィールドは、標準 VOD
エンドポイントの出力フィールドの同じフィールドをすべてサポートします。ただし、スケジュールされたクリップでは、リストではなく 1つの出力しかサポートされません。使用可能なフィールドの詳細については、 VODクリッピングサポートドキュメントを参照してください。
通常、 time_utc
はクリップの終了境界に一致するように設定します。スケジュールされた時刻は、クリップの終了境界より後になければなりません。そうしないと、スケジュールされた時間にクリップ要求が失敗します。
time_utc
フィールドのタイムスタンプは、UNIX タイムスタンプとして秒単位の UTC 形式にする必要があります。https://www.unixtimestamp.com/で変換できます。
2021-02-09T 13:55 + 00:00
から始まる15分のクリップをスケジュールするとします。output.start_time
と output.end_time
を使用して、クリップの境界を秒単位の UNIX 時間として指定できます。(繰り返しますが、を参照してくださいVODクリッピングサポートドキュメント利用可能なフィールドの詳細については)。
始まる時間:2021-02-09T13:55:00 + 00:00 = 1612878900 end_time:2021-02-09T 14:10:00 + 00:00 = 1612879800
スケジューラーはクリップ要求をスケジュールするための時間も必要とするため、と同じ値を使用できます。終了時間
また、秒単位のUNIX時間であるためです。
また、クリップの Videoclud Video を作成したいので、それを出力に含めます
。Videocloud Videoはワークフローのスケジュール時に作成され、そのIDが応答で返されるため、クリップが作成される前にビデオIDを知ることができます。後でクリップリクエストをキャンセルした場合、またはスケジュールされた時間にクリップリクエストが失敗した場合、Videocoud 動画はアカウントから削除されません。
要求
ワークフローを作成するには、次の POST
リクエストを実行します。
https://api.bcovlive.io/v1/scheduler/clip
ヘッダー
コンテンツタイプ:application / json X-API-KEY:APIキー
リクエスト本文
{
"job_id": "your Job ID",
"description": "My Scheduled Clip",
"clip": {
"output": {
"label": "My Scheduled Clip",
"start_time": 1612878900,
"end_time": 1612879800,
"videocloud": {
"video": {
"name": "My Scheduled Clip"
}
}
},
"time_utc": 1612879800
}
}
レスポンスの例
{ "account_id": "your Account ID", "description": "My Tuesday Clip", "type": "clip", "job_id": "your Job ID", "clip": { "state": "pending", "output": { "label": "My Scheduled Clip", "start_time": 1612878900, "end_time": 1612879800, "videocloud": { "video": { "id": "70702010152202", "name": "My Scheduled Clip" } }}、 "time_utc":1612879800} "workflow_id": "d44cf29f4f184757ac0995beb8a0097e"、}
clip.output.videocloud.video.id
には、新しく作成されたビデオクラウドビデオのIDが含まれていることに注意してください。time_utc
では、取り込んだクリップでビデオソースが更新されます。
クリップスケジューラワークフローを更新する
クリップの出力と
time_utc
の両方を更新できます。これらは、ジョブが保留中の状態 (「state」: 「pending」)
の場合にのみ更新できます。
前の例に従って、クリップを計画より5分短くする必要があります。出力フィールドを更新するときは、変更だけでなく、完全なオブジェクトを指定する必要があります。これには、上記のcreate呼び出しによって返されたVideocloud VideoIDが含まれます。
この例では、両方を更新したことに注意してください終了時間
とtime_utc
5分の短縮を反映します。
要求
ワークフローを更新するには、次の PUT リクエストを実行します。
https://api.bcovlive.io/v1/scheduler/clip/ {workflow_id}
ヘッダー
コンテンツタイプ:application / json X-API-KEY:APIキー
リクエスト本文
{
"clip": {
"output": {
"label": "My Scheduled Clip",
"start_time": 1612878900,
"end_time": 1612879500,
"videocloud": {
"video": {
"id": "70702010152202",
"name": "My Scheduled Clip"
}
}
},
"time_utc": 1612879500
}
}
レスポンスの例
{ "account_id": "your Account ID", "description": "My Tuesday Clip", "type": "clip", "job_id": "your Job ID", "clip": { "state": "pending", "output": { "label": "My Scheduled Clip", "start_time": 1612878900, "end_time": 1612879500, "videocloud": { "video": { "id": "70702010152202", "name": "My Scheduled Clip" } }}、 "time_utc":1612879500} "workflow_id": "d44cf29f4f184757ac0995beb8a0097e"、}
クリップスケジューラワークフローをキャンセルする
DELETE
リクエストでクリップをキャンセルできます。
注:クリップワークフローをキャンセルする場合、スケジューリング時に作成された Videocloud Video はバックエンドによって削除されません。孤立した動画は、Videocloud アカウントから手動で削除する必要があります。
要求
ワークフローを更新するには、次の DELETE
リクエストを実行します。
https://api.bcovlive.io/v1/scheduler/clip/ {workflow_id}
ヘッダー
X-API-KEY: あなたの API キーリクエスト本文
このリクエストにはリクエスト本文がありません。
レスポンスの例
{ "account_id": "your Account ID", "description": "My Tuesday Clip", "type": "clip", "job_id": "your Job ID", "clip": { "state": "cancelled", "output": { "label": "My Scheduled Clip", "start_time": 1612878900, "end_time": 1612879500, "videocloud": { "video": { "id": "70702010152202", "name": "My Scheduled Clip" } }}、 "time_utc":1612879500} "workflow_id": "d44cf29f4f184757ac0995beb8a0097e"、}
通知
オプションで、ワークフローの作成時に通知を構成できます。POSTするサービスの URL
を提供する必要があります。スケジューラーがクリップ呼び出しを行うと、通知が送信されます。クリップの n
秒前に通知を受信するように構成することもできます。詳細については、ライブスケジューラ通知を参照してください。
リクエスト本文の例
{"job_id": "あなたのジョブID"、 "説明":「マイスケジュールクリップ」, 「notification_url」: "http://example.com/live/clip/callbacks" ,「クリップ」: { "output": { "label": "My Scheduled Clip", "start_time": 1612878900, "end_time": 1612879800, "videocloud": { "video": { "name": "My Scheduled Clip" } },「time_utc」: 1612879800, 「通知」:600 }}