Clips

List shape overlays on a clip

Changed on

Returns the shape overlays (squares, circles, stars…) on a clip.

get/v1/videos/{id}/clips/{clipId}/shape-overlays

Request

Path parameters

idstring required

Video identifier

Example:vid_abc123def456
clipIdstring required

Clip identifier

Example:cl_xyz789ghi012

Response

OK

Example response

{
  "shapeOverlays": [
    {
      "border": {
        "color": "#FFFFFFFF"
      },
      "corners": "squircle",
      "depth": "behind_presenter",
      "depthChanges": [
        {
          "atMs": 1200,
          "depth": "behind_presenter"
        }
      ],
      "dimensions": {
        "height": 540,
        "width": 960
      },
      "fill": {
        "color": "#000000ff",
        "gradientAngle": 45,
        "gradientColor1": "#ff0080ff",
        "gradientColor2": "#7928caff",
        "shaderGradientPreset": "Halo",
        "sourceId": "su_abc123",
        "type": "solid",
        "videoDurationSeconds": 12.4
      },
      "id": "ly_abc123",
      "point": {
        "xPct": 30,
        "yPct": 30
      },
      "shadow": "subtle",
      "transition": "smooth"
    }
  ]
}

Changes