Restyle a clip
restyle_clipUse this when the user wants a made clip changed and rendered again: a different caption style, bigger or smaller captions, captions moved up or down, the hook title turned on, off or reworded, or the whole video shown instead of cropped (fit, background). The change is saved on the clip and a new render starts; follow with get_job. When the user wants the look kept for future clips, pass save_as_default (new clips then start from it). Do not use for clips that have not been made yet (use make_clips).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fit | No | How the picture sits in the frame. "fill" (the default) crops it to fill the frame. "whole" shows the whole video, nothing cropped, with space around it; use when the user does not want a wide video cropped. | |
| style | No | A caption style id or name from list_styles, e.g. bold-punch. | |
| clip_id | Yes | The clip_id from get_episode or get_job (or the job_id of its render). With episode_id, the clip's number or ref also works. | |
| position | No | Where the captions sit. "up" and "down" move them from where they are now. | |
| background | No | What fills the space around a whole video: "black", or "blur" for a blurred copy of the video. Only matters with fit "whole". | |
| episode_id | No | Only needed when clip_id is a number or ref from get_episode. | |
| hook_title | No | The title box at the top of the clip, on by default for new clips. false removes it, true puts the clip's title there, or give the words to show. | |
| caption_size | No | Caption size. "bigger" and "smaller" are relative to now. | |
| save_as_default | No | True when the user wants this look kept for future clips ("use this from now on", "save this style"). Can be sent with no other change to keep the clip's current look. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| job_id | Yes | Pass to get_job. | |
| status | Yes | ||
| changes | Yes | ||
| clip_id | Yes | ||
| message | Yes | ||
| saved_as_default | No |