WIwithchima
Clips

Add a highlight to a clip

Changed on

Adds a highlight mask to a clip. Targets the footage in the clip's Screen slot at startTimeMs: the screen recording, or b-roll media a layout puts there.

post/v1/videos/{id}/clips/{clipId}/highlights

Request

Path parameters

idstring required

Video identifier

Example:vid_abc123def456
clipIdstring required

Clip identifier

Example:cl_xyz789ghi012

Request body

durationMsinteger required
intensitynumber

Strength from 0 to 1. Blur: 0 is the standard blur and 1 blurs three times as heavily; the content stays fully hidden at every value (defaults to 0). Highlight: how dark the area outside the highlight goes, 0 = no dimming, 1 = black (defaults to 0.7).

startTimeMsinteger required

Start time in ms on the clip's playback timeline (cuts applied)

transition'smooth' | 'hard_cut'

How one thing gives way to the next: smooth eases across the change, hard_cut swaps instantly.

Example request

{
  "dimensions": {
    "heightPct": 50,
    "widthPct": 50
  },
  "durationMs": 2000,
  "intensity": 0.7,
  "point": {
    "xPct": 25,
    "yPct": 25
  },
  "startTimeMs": 1000,
  "transition": "smooth"
}

Response

OK

Example response

{
  "mask": {
    "dimensions": {
      "heightPct": 50,
      "widthPct": 50
    },
    "durationMs": 2000,
    "id": "ly_abc123",
    "intensity": 0.7,
    "point": {
      "xPct": 25,
      "yPct": 25
    },
    "startTimeMs": 1000,
    "transition": "smooth",
    "type": "blur"
  }
}

Changes

  • f7923c831a59Revision changes
    • info

      added the new optional request property

    • info

      added the required property / to the response with the status

  • ac47c99c144fRevision changes
    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status