# Færibreytur

Hver gerð heldur sínum innbyggðu heitum færibreytna og á síðu hverrar gerðar eru þær taldar upp. Að auki tekur API við
**staðlaðri heitum** fyrir færibreytur sem hafa sömu merkingu í öllum gerðum, þannig að kóði sem er skrifaður fyrir eina gerð virkar
fyrir næstu gerð með færri breytingum.

## Staðlað heiti

| Staðlað heiti | Merking | Dæmigerð innbyggð heiti |
|---|---|---|
| `image` | Inntaksmyndin eða myndin í fyrsta ramma | `image_url`, `start_image_url`, `first_frame_url`, `first_image_url`, `source_image_url` |
| `end_image` | Myndin í síðasta ramma | `end_image_url`, `last_frame_url`, `tail_image_url` |
| `images` | Listi yfir viðmiðunarmyndir | `image_urls`, `reference_image_urls` |
| `video` | Inntaksvídeóið | `video_url` |
| `videos` | Listi yfir viðmiðunarvídeó | `video_urls` |
| `audio` | Inntakshljóðið | `audio_url` |
| `audios` | Listi yfir viðmiðunarhljóðbúta | `audio_urls` |
| `mask` | Grímumynd | `mask_url` |
| `num_outputs` | Hversu margar niðurstöður á að búa til | `num_images` |
| `generate_audio` | Búa til hljóð með vídeóinu | `generate_audio_switch`, `enable_audio` |

Hvaða innbyggða reit staðlað heiti tengist í hverri núverandi gerð:

| Kanonískt heiti | Innbyggður reitur (líkön sem nota hann) |
|---|---|
| `audio` | `audio_url` (líkön: 126) |
| `audios` | `audio_urls` (líkön: 7), `reference_audio_urls` (líkön: 1) |
| `end_image` | `end_image_url` (líkön: 76), `last_frame_url` (líkön: 12), `tail_image_url` (líkön: 1) |
| `generate_audio` | `generate_audio_switch` (líkön: 16), `audio` (líkön: 3) |
| `image` | `image_url` (líkön: 529), `start_image_url` (líkön: 20), `first_frame_url` (líkön: 12), `first_image_url` (líkön: 7), `source_image_url` (líkön: 2) |
| `images` | `image_urls` (líkön: 148), `reference_image_urls` (líkön: 31) |
| `mask` | `mask_url` (líkön: 46) |
| `num_outputs` | `num_images` (líkön: 337) |
| `video` | `video_url` (líkön: 197) |
| `videos` | `video_urls` (líkön: 13), `reference_video_urls` (líkön: 1) |

Reglur:

- Sendu annaðhvort staðlaða heitið eða það innbyggða. Ef þú sendir bæði með mismunandi gildum mistekst kallið með
  `422 invalid_input` á staðlaða heitinu.
- Færibreytu sem er hvorki innbyggt heiti né staðlað heiti gerðarinnar er hafnað með `422 invalid_input`
  ("Unknown parameter"), ásamt tillögu að næsta gildu heiti. Innsláttarvillur fara aldrei hljóðalaust í gegn.
- Á síðu hverrar gerðar eru bæði heitin sýnd hlið við hlið.

## Gerðarbreyting

Gildum er breytt í þá gagnategund sem gerðin gerir ráð fyrir, þannig að allt þetta virkar:

| Þú sendir | Gerðin gerir ráð fyrir | Verður |
|---|---|---|
| `5`, `"5"`, `"5s"` | `duration` sem streng, til dæmis `"5"` | `"5"` |
| `"8"` | heiltölu | `8` |
| `"1080P"`, `"4K"` | `resolution`, til dæmis `"1080p"`, `"4k"` | nákvæmlega leyfða stafsetningin |
| `"true"`, `"false"`, `1`, `0` | bool-gildi | `true`, `false` |
| `"https://…/a.jpg"` | lista yfir URL-slóðir | `["https://…/a.jpg"]` |
| `42` | streng | `"42"` |

Leyfileg gildi eru fyrst borin saman nákvæmlega, síðan án tillits til há- og lágstafa og að lokum sem tölur (`5` passar við `"5"`, `"5s"` og
`"5 s"`-lík gildi).

## Sjálfgefin gildi

Færibreytur sem þú skilur eftir eru notaðar með sjálfgefnu gildi gerðarinnar, sem er skráð í færibreytutöflu gerðarinnar. Verðið er
reiknað með sömu sjálfgefnu gildum (til dæmis er verð fyrir vídeógerð þar sem `generate_audio` er sjálfgefið `true` reiknað með
hljóði nema þú sendir `"generate_audio": false`).

## Skráarfæribreytur

Mynd-, vídeó- og hljóðfæribreytur taka við opinberri URL-slóð, `data:`-URI allt að 10 MB eða `file_url` fyrir upphleðslu.
Sjá [Files](https://doitong.com/developers/docs/files).