• AI reference · Area studio

film_ready

Ask the owner: is the film ready?. Ask the owner's yes that a finished Motion JSON film is ready: a "film ready" card on your task with the film, its piece and its sound. Pass exactly the film_ready args studio_status gave (asset_id, version, project, job_id and the studio's facts), plus task (the task you hold) and score (its sound, optional). Rules: only the owner says yes, never a helper, and only after playing that exact version; the yes approves that version in the media library and nothing else: nothing is public or posted. To post it after the yes, propose a post card (propose kind post, content_item_id = asset_id, content_item_version = version, the accounts, the text and when): that is its own yes, and the scheduler posts it once. A newer version of the film needs its own film_ready.

Where it is

In the studio area (making films and sound in the cloud studio (Video Desk, Immersive Desk)): open it with tools_for { area: "studio" }, then call it with use_tool { name: "film_ready", args }.

Does it need a yes?

Needs the owner's yes: it makes a yes card, and nothing happens until the owner taps yes. Here: a finished film's "film ready" card: the owner's yes (never a helper's) approves that exact version in the media library; posting it is a post yes.

Inputs

InputTypeNeededAbout
taskintegernoThe task you hold: the card goes there. · 1 or more
asset_idstringyesThe film in the media library, from studio_status film_ready. · format `^[A-Za-z0-9._:-]{1,200}$`
versionstringyesIts exact version, from studio_status film_ready. · 1 to 100 characters
projectstringyesformat `^[a-z0-9][a-z0-9._-]{0,63}$`
job_idstringyes1 to 80 characters
piecestringno1 to 200 characters
durationnumberno0 or more
widthintegerno1 or more
heightintegerno1 or more
fpsnumberno1 or more
size_bytesintegerno0 or more
quality"draft" | "looks" | "delivery"no
lint_warningsintegerno0 or more
enginestringno1 to 200 characters
scorestringnoThe film's sound: its Desk piece (e.g. sound/piece.json) or the library piece of its mix. · 1 to 200 characters
run_idstringyesThe run_id from start. Pass it on every call: it keeps your task held. · 1 to 100 characters

Example

{
  "name": "film_ready",
  "arguments": {
    "asset_id": "asset id",
    "version": "version",
    "project": "project",
    "job_id": "job id",
    "run_id": "the run_id from start"
  }
}

When it is refused

  • invalid: The input isn't right. The sentence names the field and the fix; nothing was done. Fix it and call again.
  • not_found: No such thing in this company (a task, file, person, record). Check the number or name, or list first.
  • not_allowed: Not without another step: the owner's yes, your own task held with pick_up, or a setting the owner turns on. The sentence says which.
  • taken: Someone else holds it (another AI on that task). Pick another task.
  • stale: It changed since you read it. Read it again and use the new version.
  • failed: On our side or a service's, never your input. Try again in a minute; if it keeps failing, call report_problem.