Clips

List overlays on a clip

Changed on

Returns the image and video overlays on a clip.

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

Request

Path parameters

idstring required

Video identifier

Example:vid_abc123def456
clipIdstring required

Clip identifier

Example:cl_xyz789ghi012

Response

OK

Example response

{
  "overlays": [
    {
      "animation": {
        "intro": {
          "durationMs": 500,
          "easing": {
            "bezier": [
              0.25,
              0.1,
              0.25,
              1
            ],
            "curve": "slow_down",
            "intensity": 0.5,
            "spring": {
              "damping": 12,
              "mass": 1,
              "stiffness": 200
            }
          },
          "moveY": -0.5,
          "preset": "slide_up",
          "scale": 1,
          "text": {
            "delayMs": 100,
            "order": "forward",
            "smoothing": "linear",
            "unit": "words"
          }
        },
        "motionBlur": true,
        "outro": {
          "durationMs": 500,
          "easing": {
            "bezier": [
              0.25,
              0.1,
              0.25,
              1
            ],
            "curve": "slow_down",
            "intensity": 0.5,
            "spring": {
              "damping": 12,
              "mass": 1,
              "stiffness": 200
            }
          },
          "moveY": -0.5,
          "preset": "slide_up",
          "scale": 1,
          "text": {
            "delayMs": 100,
            "order": "forward",
            "smoothing": "linear",
            "unit": "words"
          }
        },
        "textIntro": {
          "durationMs": 500,
          "easing": {
            "bezier": [
              0.25,
              0.1,
              0.25,
              1
            ],
            "curve": "slow_down",
            "intensity": 0.5,
            "spring": {
              "damping": 12,
              "mass": 1,
              "stiffness": 200
            }
          },
          "moveY": -0.5,
          "preset": "slide_up",
          "scale": 1,
          "text": {
            "delayMs": 100,
            "order": "forward",
            "smoothing": "linear",
            "unit": "words"
          }
        },
        "textOutro": {
          "durationMs": 500,
          "easing": {
            "bezier": [
              0.25,
              0.1,
              0.25,
              1
            ],
            "curve": "slow_down",
            "intensity": 0.5,
            "spring": {
              "damping": 12,
              "mass": 1,
              "stiffness": 200
            }
          },
          "moveY": -0.5,
          "preset": "slide_up",
          "scale": 1,
          "text": {
            "delayMs": 100,
            "order": "forward",
            "smoothing": "linear",
            "unit": "words"
          }
        }
      },
      "depth": "behind_presenter",
      "depthChanges": [
        {
          "atMs": 1200,
          "depth": "behind_presenter"
        }
      ],
      "dimensions": {
        "height": 540,
        "width": 960
      },
      "durationMs": 5000,
      "id": "ly_abc123",
      "motionDocumentId": "ffd_abc123",
      "name": "Logo",
      "point": {
        "xPct": 30,
        "yPct": 30
      },
      "sourceId": "su_abc123",
      "startTimeMs": 1000,
      "transition": "smooth",
      "type": "image"
    }
  ]
}

Changes

    • warning

      added the new motion enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status