WIwithchima
Clips

Update a zoom

Changed on

Update a zoom's type, timing, focus point, or scale. Only the fields you send are changed.

patch/v1/videos/{id}/clips/{clipId}/zooms/{zoomId}

Request

Path parameters

idstring required

Video ID

clipIdstring required

Clip ID

zoomIdstring required

Zoom ID

Request body

durationMsinteger
introTransition'smooth' | 'hard_cut'

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

outroTransition'smooth' | 'hard_cut'

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

scalenumber

Magnification factor (1 = no zoom, 3.5 = max).

startTimeMsinteger

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

type'manualZoom' | 'trackingZoom'

manualZoom zooms into a fixed focusPoint on the screen. trackingZoom automatically follows the cursor in the screen recording.

Example request

{
  "focusPoint": {
    "xPct": 50,
    "yPct": 50
  },
  "introTransition": "smooth",
  "outroTransition": "smooth",
  "scale": 2,
  "type": "manualZoom"
}

Response

OK

Example response

{
  "zoom": {
    "durationMs": 2000,
    "focusPoint": {
      "xPct": 50,
      "yPct": 50
    },
    "id": "ef_abc123",
    "introTransition": "smooth",
    "outroTransition": "smooth",
    "scale": 2,
    "startTimeMs": 1000,
    "type": "manualZoom"
  }
}

Changes

  • 25910750ad41Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the required property / to the response with the status

    • 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