要件
- アカウントのLive APIキー。
- ライブアカウントでは、スケジューラのオーバーライドを有効にする必要があります。
クリップスケジューラワークフローを作成する
クリップを作成するときは、クリップの時間境界の両方を指定する必要があります(出力
フィールド)、およびスケジュールされた時間( time_utc
フィールド)クリップリクエストを行います。
NS 出力
リクエスト本文のフィールドは、のすべての同じフィールドをサポートします出力
標準VODエンドポイントのフィールド。しかしながら、スケジュールされたクリップは、リストではなく単一の出力のみをサポートします。見るVODクリッピングサポートドキュメント利用可能なフィールドの詳細については。
通常、 time_utc
クリップの端の境界に一致させます。予定時刻しなければならないクリップの終了境界の後である必要があります。そうでない場合、クリップ要求はスケジュールされた時間に失敗します。
のタイムスタンプtime_utc
フィールドは、秒単位のUNIXタイムスタンプとしてUTC形式である必要があります。あなたが使用することができますhttps://www.unixtimestamp.com/変換用。
15分のクリップをスケジュールしたいとしましょう。 2021-02-09T13:55:00 + 00:00
。使用できますoutput.start_time
とoutput.end_time
クリップの境界をUNIX時間(秒単位)として指定します。(繰り返しますが、を参照してくださいVODクリッピングサポートドキュメント利用可能なフィールドの詳細については)。
始まる時間:2021-02-09T13:55:00 + 00:00 = 1612878900 end_time:2021-02-09T14:10:00 + 00:00 = 1612879800
スケジューラーはクリップ要求をスケジュールするための時間も必要とするため、と同じ値を使用できます。終了時間
また、秒単位のUNIX時間であるためです。
また、クリップ用のVideocloudビデオを作成したいので、それをに含めます。出力
。Videocloud Videoはワークフローのスケジュール時に作成され、そのIDが応答で返されるため、クリップが作成される前にビデオIDを知ることができます。後でクリップリクエストをキャンセルした場合、またはスケジュールされた時間に失敗した場合、VideocloudVideoはアカウントから削除されません。
要求
ワークフローを作成するには、次のようにします役職
リクエスト:
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
新しく作成されたVideocloudビデオのIDが含まれます。でtime_utc
ビデオソースは、取り込んだクリップで更新されます。
クリップスケジューラワークフローを更新する
あなたは両方を更新することができます出力
とtime_utc
あなたのクリップの。これらは、ジョブが保留状態にある場合にのみ更新できます。「状態」:「保留中」
。
前の例に従って、クリップを計画より5分短くする必要があります。更新するとき出力
フィールドには、加えられた変更だけでなく、完全なオブジェクトを提供する必要があります。これには、上記のcreate呼び出しによって返されたVideocloud VideoIDが含まれます。
この例では、両方を更新したことに注意してください終了時間
とtime_utc
5分の短縮を反映します。
要求
ワークフローを更新するには、次のようにします置く
リクエスト:
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"、}
クリップスケジューラワークフローをキャンセルする
あなたはでクリップをキャンセルすることができます消去
リクエスト。
クリップワークフローをキャンセルする場合、スケジュール時に作成されたVideocloudビデオはすべてないバックエンドによって削除されます。孤立したビデオをVideocloudアカウントから手動で削除する必要があります。
要求
ワークフローを更新するには、次のようにします消去
リクエスト:
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"、}
通知
オプションで、ワークフローの作成時に通知を構成できます。あなたは私たちのサービスのURLを提供する必要があります役職
に。スケジューラーがクリップ呼び出しを行うと、通知が送信されます。通知を受信するように構成することもできますNS
クリップの数秒前。を参照してくださいライブスケジューラ通知詳細については。
リクエスト本文の例
{"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 }}