Scheduling Clip Generation for a Live Stream

Requirements

• OAuth 2.0 client credentials with Live API v2 job permissions
• Scheduled clipping enabled on your account

For Control Room instructions, see Scheduling Clips.

Create a scheduled clip

Specify the clip boundaries in clip.clip_request and when to run the clip in clip.time_utc. The scheduled time must be at or after the clip end time, or the clip fails when the task runs.

POST https://api.live.brightcove.com/v2/accounts/{account_id}/jobs/{job_id}/scheduler/clips

{
  "job_id": "6386637563112",
  "description": "Post-game highlight",
  "notification_url": "https://example.com/live/clip/callbacks",
  "clip": {
    "time_utc": 1612879800,
    "notification": 600,
    "clip_request": {
      "name": "Post-game highlight",
      "start": "2021-02-09T13:55:00Z",
      "end": "2021-02-09T14:10:00Z",
      "remove_ads": true,
      "output": {
        "type": "brightcove"
      }
    }
  }
}

When output.type is brightcove (the default), a Video Cloud video is created when the workflow is scheduled. The video ID is returned in the response so you can reference it before the clip is ingested. If you cancel the workflow or it fails, the Video Cloud video is not removed.

Update a scheduled clip

PUT https://api.live.brightcove.com/v2/accounts/{account_id}/jobs/{job_id}/scheduler/clips/{workflow_id}

Update clip.clip_request and/or clip.time_utc while the task is in pending state. Provide the full clip_request object, not just changed fields.

List scheduled clips

GET https://api.live.brightcove.com/v2/accounts/{account_id}/jobs/{job_id}/scheduler/clips?state=pending

Delete a scheduled clip

DELETE https://api.live.brightcove.com/v2/accounts/{account_id}/jobs/{job_id}/scheduler/clips/{workflow_id}