@shotstack/schemas 1.12.1 → 1.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1189,7 +1189,7 @@
1189
1189
  "additionalProperties": false
1190
1190
  },
1191
1191
  "VideoAsset": {
1192
- "description": "The VideoAsset is used to create video sequences from video files. The src must be a publicly accessible URL to a video resource such as an mp4 file.",
1192
+ "description": "The VideoAsset adds a video to a Clip. The video can be sourced from a URL\n(`src`) or generated from a text prompt (`prompt`), optionally seeded from a\nstarting image (`seed`). Exactly one of `src` or `prompt` must be provided.\n\n- **Source URL:** set `src` to the URL of an mp4 (or compatible) video file.\n- **Generated:** set `prompt` to describe the motion. Optionally set `seed` to\n a starting image URL (image-to-video). Use `model` to choose the generator\n (e.g. `luma-ray-3`, `runpod-itv-mini`). The generated `src` is filled in\n automatically.\n",
1193
1193
  "type": "object",
1194
1194
  "properties": {
1195
1195
  "type": {
@@ -1201,12 +1201,29 @@
1201
1201
  "type": "string"
1202
1202
  },
1203
1203
  "src": {
1204
- "description": "The video source URL. The URL must be publicly accessible or include credentials.",
1204
+ "description": "The video source URL. The URL must be publicly accessible or include credentials. Provide either `src` or `prompt`, not both.",
1205
1205
  "type": "string",
1206
1206
  "minLength": 1,
1207
1207
  "pattern": "\\S",
1208
1208
  "example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/video.mp4"
1209
1209
  },
1210
+ "prompt": {
1211
+ "description": "A text prompt to generate the video from. When set without `src`, the engine generates a video and fills `src` automatically. Optionally pair with `seed` for image-to-video. Use `model` to choose the generator.",
1212
+ "type": "string",
1213
+ "maxLength": 4000,
1214
+ "example": "Slowly zoom out and orbit left around the object."
1215
+ },
1216
+ "seed": {
1217
+ "description": "Seed image URL for image-to-video generation. The image is used as the starting frame; `prompt` describes the motion. Has no effect unless `prompt` is set.",
1218
+ "type": "string",
1219
+ "minLength": 1,
1220
+ "example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/seed-image.jpg"
1221
+ },
1222
+ "model": {
1223
+ "description": "The generation model to use when `prompt` is set (e.g. `luma-ray-3`, `runpod-itv-mini`). Defaults to the platform's preferred generator if omitted.",
1224
+ "type": "string",
1225
+ "example": "luma-ray-3"
1226
+ },
1210
1227
  "transcode": {
1211
1228
  "type": "boolean",
1212
1229
  "description": "Set to `true` to force re-encoding of the video during preprocessing. This can help resolve compatibility issues, fix rotation problems, synchronize audio, or convert formats. The video will be processed to ensure optimal compatibility with the rendering engine.",
@@ -1248,7 +1265,7 @@
1248
1265
  "type": "string"
1249
1266
  },
1250
1267
  "speed": {
1251
- "description": "Adjust the playback speed of the video clip between 0 (paused) and 10 (10x normal speed) where 1 is normal speed (defaults to 1). Adjusting the speed will also adjust the duration of the clip and may require you to adjust the Clip length. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the entire video (i.e. original length / 0.5). If you set speed to 2, the clip will need to be half as long to play the entire video (i.e. original length / 2).",
1268
+ "description": "Adjust the playback speed of the video clip between 0 (paused) and 10 (10x normal speed) where 1 is normal speed (defaults to 1). Adjusting the speed will also adjust the duration of the clip and may require you to adjust the Clip length. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the entire video (i.e. original length / 0.5). If you set speed to 2, the clip will need to be half as long to play the entire video (i.e. original length / 2).",
1252
1269
  "type": "number",
1253
1270
  "format": "float",
1254
1271
  "minimum": 0,
@@ -1264,12 +1281,11 @@
1264
1281
  },
1265
1282
  "additionalProperties": false,
1266
1283
  "required": [
1267
- "type",
1268
- "src"
1284
+ "type"
1269
1285
  ]
1270
1286
  },
1271
1287
  "ImageAsset": {
1272
- "description": "The ImageAsset is used to create video from images to compose an image. The src must be a publicly accessible URL to an image resource such as a jpg or png file.",
1288
+ "description": "The ImageAsset adds an image to a Clip. The image can be sourced from a URL\n(`src`) or generated from a text prompt (`prompt`). Exactly one of `src` or\n`prompt` must be provided.\n\n- **Source URL:** set `src` to the publicly accessible URL of a jpg or png file.\n- **Generated:** set `prompt` to describe the image; the engine generates it\n using the provider chosen by `model` and fills `src` in automatically.\n",
1273
1289
  "type": "object",
1274
1290
  "properties": {
1275
1291
  "type": {
@@ -1281,20 +1297,30 @@
1281
1297
  "type": "string"
1282
1298
  },
1283
1299
  "src": {
1284
- "description": "The image source URL. The URL must be publicly accessible or include credentials.",
1300
+ "description": "The image source URL. The URL must be publicly accessible or include credentials. Provide either `src` or `prompt`, not both.",
1285
1301
  "type": "string",
1286
1302
  "minLength": 1,
1287
1303
  "pattern": "\\S",
1288
1304
  "example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/image.jpg"
1289
1305
  },
1306
+ "prompt": {
1307
+ "description": "A text prompt to generate the image from. When set without `src`, the engine generates an image and fills `src` automatically. Use `model` to choose the generator.",
1308
+ "type": "string",
1309
+ "maxLength": 4000,
1310
+ "example": "A serene landscape with a crystal-clear mountain lake at sunrise."
1311
+ },
1312
+ "model": {
1313
+ "description": "The generation model to use when `prompt` is set (e.g. `flux-schnell`). Defaults to the platform's preferred generator if omitted.",
1314
+ "type": "string",
1315
+ "example": "flux-schnell"
1316
+ },
1290
1317
  "crop": {
1291
1318
  "$ref": "#/components/schemas/Crop"
1292
1319
  }
1293
1320
  },
1294
1321
  "additionalProperties": false,
1295
1322
  "required": [
1296
- "type",
1297
- "src"
1323
+ "type"
1298
1324
  ]
1299
1325
  },
1300
1326
  "TextAsset": {
@@ -1529,7 +1555,7 @@
1529
1555
  ]
1530
1556
  },
1531
1557
  "AudioAsset": {
1532
- "description": "The AudioAsset is used to add sound effects and audio at specific intervals on the timeline. The src must be a publicly accessible URL to an audio resource such as an mp3 file.",
1558
+ "description": "The AudioAsset adds audio to a Clip. The audio can be sourced from a URL\n(`src`) or generated from a text prompt (`prompt`). Exactly one of `src` or\n`prompt` must be provided.\n\n- **Source URL:** set `src` to a publicly accessible audio URL (e.g. mp3).\n- **Generated speech:** set `prompt` to the spoken text and `voice` to a voice\n identifier (text-to-speech). Optionally set `language`/`newscaster`.\n- **Generated music or SFX:** set `prompt` describing the sound; omit `voice`.\n- Use `model` to choose the generator. The generated `src` is filled in\n automatically.\n",
1533
1559
  "type": "object",
1534
1560
  "properties": {
1535
1561
  "type": {
@@ -1541,12 +1567,38 @@
1541
1567
  "type": "string"
1542
1568
  },
1543
1569
  "src": {
1544
- "description": "The audio source URL. The URL must be publicly accessible or include credentials.",
1570
+ "description": "The audio source URL. The URL must be publicly accessible or include credentials. Provide either `src` or `prompt`, not both.",
1545
1571
  "type": "string",
1546
1572
  "minLength": 1,
1547
1573
  "pattern": "\\S",
1548
1574
  "example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/sound.mp3"
1549
1575
  },
1576
+ "prompt": {
1577
+ "description": "A text prompt. When `voice` is set, the prompt is the spoken text (text-to-speech). Without `voice`, the prompt describes generated music or sound effects. The generated `src` is filled in automatically.",
1578
+ "type": "string",
1579
+ "maxLength": 4000,
1580
+ "example": "Welcome to today's broadcast."
1581
+ },
1582
+ "voice": {
1583
+ "description": "Voice identifier for text-to-speech generation (e.g. `Matthew`, `Joanna`). Only meaningful when `prompt` is set.",
1584
+ "type": "string",
1585
+ "example": "Matthew"
1586
+ },
1587
+ "language": {
1588
+ "description": "Optional BCP-47 language code (e.g. `en-US`) for text-to-speech. Only meaningful when `prompt` and `voice` are set.",
1589
+ "type": "string",
1590
+ "example": "en-US"
1591
+ },
1592
+ "newscaster": {
1593
+ "description": "Set to `true` to use the voice's newscaster mode when supported. Only meaningful when `prompt` and `voice` are set.",
1594
+ "type": "boolean",
1595
+ "default": false
1596
+ },
1597
+ "model": {
1598
+ "description": "The generation model to use when `prompt` is set (e.g. `polly-neural`). Defaults to the platform's preferred generator if omitted.",
1599
+ "type": "string",
1600
+ "example": "polly-neural"
1601
+ },
1550
1602
  "trim": {
1551
1603
  "description": "The start trim point of the audio clip, in seconds (defaults to 0). Audio will start from the in trim point. The audio will play until the file ends or the Clip length is reached.",
1552
1604
  "type": "number"
@@ -1572,7 +1624,7 @@
1572
1624
  ]
1573
1625
  },
1574
1626
  "speed": {
1575
- "description": "Adjust the playback speed of the audio clip between 0 (paused) and 10 (10x normal speed), where 1 is normal speed (defaults to 1). Adjusting the speed will also adjust the duration of the clip and may require you to adjust the Clip length. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the entire audio (i.e. original length / 0.5). If you set speed to 2, the clip will need to be half as long to play the entire audio (i.e. original length / 2).",
1627
+ "description": "Adjust the playback speed of the audio clip between 0 (paused) and 10 (10x normal speed), where 1 is normal speed (defaults to 1). Adjusting the speed will also adjust the duration of the clip and may require you to adjust the Clip length. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the entire audio (i.e. original length / 0.5). If you set speed to 2, the clip will need to be half as long to play the entire audio (i.e. original length / 2).",
1576
1628
  "type": "number",
1577
1629
  "format": "float",
1578
1630
  "minimum": 0,
@@ -1592,8 +1644,7 @@
1592
1644
  },
1593
1645
  "additionalProperties": false,
1594
1646
  "required": [
1595
- "type",
1596
- "src"
1647
+ "type"
1597
1648
  ]
1598
1649
  },
1599
1650
  "ShapeAsset": {
@@ -2111,7 +2162,8 @@
2111
2162
  ]
2112
2163
  },
2113
2164
  "TextToImageAsset": {
2114
- "description": "The TextToImageAsset lets you create a dynamic image from a text prompt.",
2165
+ "deprecated": true,
2166
+ "description": "**Notice: TextToImageAsset is deprecated. Use [ImageAsset](#tocs_imageasset)\nwith `prompt` instead.** This type continues to function and is internally\nrewritten to ImageAsset; no behaviour change for existing integrations.\n\nThe TextToImageAsset lets you create a dynamic image from a text prompt.\n",
2115
2167
  "properties": {
2116
2168
  "type": {
2117
2169
  "type": "string",
@@ -2148,7 +2200,8 @@
2148
2200
  ]
2149
2201
  },
2150
2202
  "ImageToVideoAsset": {
2151
- "description": "The ImageToVideoAsset lets you create a video from an image and a text prompt.",
2203
+ "deprecated": true,
2204
+ "description": "**Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)\nwith `prompt` and `seed` instead.** This type continues to function and is\ninternally rewritten to VideoAsset; no behaviour change for existing\nintegrations.\n\nThe ImageToVideoAsset lets you create a video from an image and a text prompt.\n",
2152
2205
  "properties": {
2153
2206
  "type": {
2154
2207
  "type": "string",
@@ -2203,7 +2256,8 @@
2203
2256
  ]
2204
2257
  },
2205
2258
  "TextToSpeechAsset": {
2206
- "description": "The TextToSpeechAsset lets you generate a voice over from text using a text-to-speech service. The generated audio can be trimmed, faded and have its volume and speed adjusted using the same properties available on the AudioAsset.",
2259
+ "deprecated": true,
2260
+ "description": "**Notice: TextToSpeechAsset is deprecated. Use [AudioAsset](#tocs_audioasset)\nwith `prompt` (the spoken text) and `voice` instead.** This type continues to\nfunction and is internally rewritten to AudioAsset; no behaviour change for\nexisting integrations.\n\nThe TextToSpeechAsset lets you generate a voice over from text using a text-to-speech service.\nThe generated audio can be trimmed, faded and have its volume and speed adjusted using the\nsame properties available on the AudioAsset.\n",
2207
2261
  "type": "object",
2208
2262
  "properties": {
2209
2263
  "type": {
@@ -3189,6 +3243,13 @@
3189
3243
  "type": "boolean",
3190
3244
  "default": false,
3191
3245
  "example": true
3246
+ },
3247
+ "padding": {
3248
+ "description": "Inner padding in pixels between the wrap pill edge and the rendered text. Only takes\neffect when `wrap: true`. When omitted, the renderer applies a sensible default\nproportional to the font size (approximately 12% of the active page font size on\nrich-caption assets). Set to 0 for a pill that hugs the text exactly. Available on\nrich-text and rich-caption assets only.\n",
3249
+ "type": "integer",
3250
+ "minimum": 0,
3251
+ "maximum": 200,
3252
+ "example": 12
3192
3253
  }
3193
3254
  },
3194
3255
  "additionalProperties": false,
@@ -51,7 +51,44 @@
51
51
  "type": "string"
52
52
  },
53
53
  "src": {
54
- "type": "string"
54
+ "anyOf": [
55
+ {
56
+ "type": "string"
57
+ },
58
+ {
59
+ "type": "null"
60
+ }
61
+ ]
62
+ },
63
+ "prompt": {
64
+ "anyOf": [
65
+ {
66
+ "type": "string"
67
+ },
68
+ {
69
+ "type": "null"
70
+ }
71
+ ]
72
+ },
73
+ "seed": {
74
+ "anyOf": [
75
+ {
76
+ "type": "string"
77
+ },
78
+ {
79
+ "type": "null"
80
+ }
81
+ ]
82
+ },
83
+ "model": {
84
+ "anyOf": [
85
+ {
86
+ "type": "string"
87
+ },
88
+ {
89
+ "type": "null"
90
+ }
91
+ ]
55
92
  },
56
93
  "transcode": {
57
94
  "anyOf": [
@@ -144,6 +181,9 @@
144
181
  "required": [
145
182
  "type",
146
183
  "src",
184
+ "prompt",
185
+ "seed",
186
+ "model",
147
187
  "transcode",
148
188
  "trim",
149
189
  "volume",
@@ -370,7 +410,34 @@
370
410
  "type": "string"
371
411
  },
372
412
  "src": {
373
- "type": "string"
413
+ "anyOf": [
414
+ {
415
+ "type": "string"
416
+ },
417
+ {
418
+ "type": "null"
419
+ }
420
+ ]
421
+ },
422
+ "prompt": {
423
+ "anyOf": [
424
+ {
425
+ "type": "string"
426
+ },
427
+ {
428
+ "type": "null"
429
+ }
430
+ ]
431
+ },
432
+ "model": {
433
+ "anyOf": [
434
+ {
435
+ "type": "string"
436
+ },
437
+ {
438
+ "type": "null"
439
+ }
440
+ ]
374
441
  },
375
442
  "crop": {
376
443
  "anyOf": [
@@ -387,6 +454,8 @@
387
454
  "required": [
388
455
  "type",
389
456
  "src",
457
+ "prompt",
458
+ "model",
390
459
  "crop"
391
460
  ]
392
461
  },
@@ -1016,6 +1085,18 @@
1016
1085
  "type": "null"
1017
1086
  }
1018
1087
  ]
1088
+ },
1089
+ "padding": {
1090
+ "anyOf": [
1091
+ {
1092
+ "type": "integer",
1093
+ "minimum": 0,
1094
+ "maximum": 200
1095
+ },
1096
+ {
1097
+ "type": "null"
1098
+ }
1099
+ ]
1019
1100
  }
1020
1101
  },
1021
1102
  "additionalProperties": false,
@@ -1024,7 +1105,8 @@
1024
1105
  "color",
1025
1106
  "opacity",
1026
1107
  "borderRadius",
1027
- "wrap"
1108
+ "wrap",
1109
+ "padding"
1028
1110
  ]
1029
1111
  },
1030
1112
  "RichTextAlignment": {
@@ -1142,7 +1224,64 @@
1142
1224
  "type": "string"
1143
1225
  },
1144
1226
  "src": {
1145
- "type": "string"
1227
+ "anyOf": [
1228
+ {
1229
+ "type": "string"
1230
+ },
1231
+ {
1232
+ "type": "null"
1233
+ }
1234
+ ]
1235
+ },
1236
+ "prompt": {
1237
+ "anyOf": [
1238
+ {
1239
+ "type": "string"
1240
+ },
1241
+ {
1242
+ "type": "null"
1243
+ }
1244
+ ]
1245
+ },
1246
+ "voice": {
1247
+ "anyOf": [
1248
+ {
1249
+ "type": "string"
1250
+ },
1251
+ {
1252
+ "type": "null"
1253
+ }
1254
+ ]
1255
+ },
1256
+ "language": {
1257
+ "anyOf": [
1258
+ {
1259
+ "type": "string"
1260
+ },
1261
+ {
1262
+ "type": "null"
1263
+ }
1264
+ ]
1265
+ },
1266
+ "newscaster": {
1267
+ "anyOf": [
1268
+ {
1269
+ "type": "boolean"
1270
+ },
1271
+ {
1272
+ "type": "null"
1273
+ }
1274
+ ]
1275
+ },
1276
+ "model": {
1277
+ "anyOf": [
1278
+ {
1279
+ "type": "string"
1280
+ },
1281
+ {
1282
+ "type": "null"
1283
+ }
1284
+ ]
1146
1285
  },
1147
1286
  "trim": {
1148
1287
  "anyOf": [
@@ -1205,6 +1344,11 @@
1205
1344
  "required": [
1206
1345
  "type",
1207
1346
  "src",
1347
+ "prompt",
1348
+ "voice",
1349
+ "language",
1350
+ "newscaster",
1351
+ "model",
1208
1352
  "trim",
1209
1353
  "volume",
1210
1354
  "speed",
@@ -2,25 +2,87 @@
2
2
  "name": "AudioAsset",
3
3
  "strict": true,
4
4
  "schema": {
5
- "description": "The AudioAsset is used to add sound effects and audio at specific intervals on the timeline. The src must be a publicly accessible URL to an audio resource such as an mp3 file.",
5
+ "description": "The AudioAsset adds audio to a Clip. The audio can be sourced from a URL\n(`src`) or generated from a text prompt (`prompt`). Exactly one of `src` or\n`prompt` must be provided.\n\n- **Source URL:** set `src` to a publicly accessible audio URL (e.g. mp3).\n- **Generated speech:** set `prompt` to the spoken text and `voice` to a voice\n identifier (text-to-speech). Optionally set `language`...",
6
6
  "type": "object",
7
7
  "properties": {
8
8
  "type": {
9
9
  "enum": [
10
10
  "audio"
11
11
  ],
12
- "description": "The type of asset - set to `audio` for audio assets.",
12
+ "description": "The type of asset - set to `audi...",
13
13
  "type": "string"
14
14
  },
15
15
  "src": {
16
- "description": "The audio source URL. The URL must be publicly accessible or include credentials.",
17
- "type": "string"
16
+ "anyOf": [
17
+ {
18
+ "type": "string",
19
+ "description": "The audio source URL. The URL must be publicly accessible or include credentials. ..."
20
+ },
21
+ {
22
+ "type": "null"
23
+ }
24
+ ]
25
+ },
26
+ "prompt": {
27
+ "anyOf": [
28
+ {
29
+ "type": "string",
30
+ "description": "A text prompt. When `voice` is set, the prompt is the spoken text (text-to-speech). Without `voice`, the prompt describes generated musi..."
31
+ },
32
+ {
33
+ "type": "null"
34
+ }
35
+ ]
36
+ },
37
+ "voice": {
38
+ "anyOf": [
39
+ {
40
+ "type": "string",
41
+ "description": "Voice identifier for text-to-speech generation (e.g. `Matthew`, `Joanna`)..."
42
+ },
43
+ {
44
+ "type": "null"
45
+ }
46
+ ]
47
+ },
48
+ "language": {
49
+ "anyOf": [
50
+ {
51
+ "type": "string",
52
+ "description": "Optional BCP-47 language code (e.g. `en-US`) for text-to-speech. Only meani..."
53
+ },
54
+ {
55
+ "type": "null"
56
+ }
57
+ ]
58
+ },
59
+ "newscaster": {
60
+ "anyOf": [
61
+ {
62
+ "type": "boolean",
63
+ "description": "Set to `true` to use the voice's newscaster mode when supported. Only meani..."
64
+ },
65
+ {
66
+ "type": "null"
67
+ }
68
+ ]
69
+ },
70
+ "model": {
71
+ "anyOf": [
72
+ {
73
+ "type": "string",
74
+ "description": "The generation model to use when `prompt` is set (e.g. `polly-neural`). Defaults to th..."
75
+ },
76
+ {
77
+ "type": "null"
78
+ }
79
+ ]
18
80
  },
19
81
  "trim": {
20
82
  "anyOf": [
21
83
  {
22
84
  "type": "number",
23
- "description": "The start trim point of the audio clip, in seconds (defaults to 0). Audio will start from the in trim point. The audio will play until the file ends or the Clip length is reached."
85
+ "description": "The start trim point of the audio clip, in seconds (defaults to 0). Audio will start from the in trim point. The audio ..."
24
86
  },
25
87
  {
26
88
  "type": "null"
@@ -28,17 +90,17 @@
28
90
  ]
29
91
  },
30
92
  "volume": {
31
- "description": "Set the volume of the audio clip. Use a number or an array of [Tween](./#tocs_tween) objects to create custom volume transitions.",
93
+ "description": "Set the volume of the audio clip. Use a number or an array of [Tween](./#tocs_tween) ...",
32
94
  "anyOf": [
33
95
  {
34
96
  "type": "number",
35
- "description": "The volume level for the audio clip. Range varies from 0 to 1 where 0 is muted and 1 is full volume (defaults to 1).",
97
+ "description": "The volume level for the audio clip. Range varies from 0 to 1 where 0 is mut...",
36
98
  "minimum": 0,
37
99
  "maximum": 1
38
100
  },
39
101
  {
40
102
  "type": "array",
41
- "description": "An array of [Tween](./#tocs_tween) objects used to create a custom volume effect. Modify the volume of an asset over time.",
103
+ "description": "An array of [Tween](./#tocs_tween) objects used to create a custom volume effect...",
42
104
  "items": {
43
105
  "$ref": "#/$defs/Tween"
44
106
  }
@@ -52,7 +114,7 @@
52
114
  "anyOf": [
53
115
  {
54
116
  "type": "number",
55
- "description": "Adjust the playback speed of the audio clip between 0 (paused) and 10 (10x normal speed), where 1 is normal speed (defaults to 1). Adjusting the speed will also adjust the duration of the clip and may require you to adjust the Clip length. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the entire audio (i.e. original length / 0.5). If you set speed to 2, the clip will need to be half as long to play the entire audio (i.e. original length / 2).",
117
+ "description": "Adjust the playback speed of the audio clip between 0 (paused) and 10 (10x normal speed), where 1 is normal speed (defaults to 1). Adjusting the speed will also adjust the duration of the clip and may require you to adjust the Clip length. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the e...",
56
118
  "minimum": 0,
57
119
  "maximum": 10
58
120
  },
@@ -65,7 +127,7 @@
65
127
  "anyOf": [
66
128
  {
67
129
  "type": "string",
68
- "description": "The effect to apply to the audio asset <ul>\n <li>`fadeIn` - fade volume in only</li>\n <li>`fadeOut` - fade volume out only</li>\n <li>`fadeInFadeOut` - fade volume in and out</li>\n</ul>",
130
+ "description": "The effect to apply to the audio asset <ul>\n <li>`fadeIn` - fade volume in only</li>\n <li>`fadeOut` - fade volume out only<...",
69
131
  "enum": [
70
132
  "none",
71
133
  "fadeIn",
@@ -83,6 +145,11 @@
83
145
  "required": [
84
146
  "type",
85
147
  "src",
148
+ "prompt",
149
+ "voice",
150
+ "language",
151
+ "newscaster",
152
+ "model",
86
153
  "trim",
87
154
  "volume",
88
155
  "speed",
@@ -90,13 +157,13 @@
90
157
  ],
91
158
  "$defs": {
92
159
  "Tween": {
93
- "description": "Use a Tween to [animate properties over time](/docs/guide/architecting-an-application/animations/). The following properties are currently supported and can be animated:\n <ul>\n <li>Opacity - animate the transparency of a clip.</li>\n <li>Offset - animate the x and y position of a clip.</li>\n <li>Rotation - animate the rotation of a clip.</li>\n <li>Skew - animate the horizontal and vertical shearing effect.</li>\n <li>Volume - animate the audio volume of a clip.</li>\n </ul>",
160
+ "description": "Use a Tween to [animate properties over time](/docs/guide/architecting-an-application/animations/). The following properties are currently supported and can be animated:\n <ul>\n <li>Opacity - animate the transparency of a clip.</li>\n <li>Offset - animate the x and y position of a clip.</li>\n <li>Rotation - animate the rotat...",
94
161
  "properties": {
95
162
  "from": {
96
163
  "anyOf": [
97
164
  {
98
165
  "type": "string",
99
- "description": "The initial property value at the start of the animation."
166
+ "description": "The initial property value at the st..."
100
167
  },
101
168
  {
102
169
  "type": "null"
@@ -107,7 +174,7 @@
107
174
  "anyOf": [
108
175
  {
109
176
  "type": "string",
110
- "description": "The final property value at the end of the animation."
177
+ "description": "The final property value at the e..."
111
178
  },
112
179
  {
113
180
  "type": "null"
@@ -118,7 +185,7 @@
118
185
  "anyOf": [
119
186
  {
120
187
  "type": "number",
121
- "description": "The time in seconds when the animation starts, relative to the clip, not the timeline."
188
+ "description": "The time in seconds when the animation starts, relative..."
122
189
  },
123
190
  {
124
191
  "type": "null"
@@ -129,7 +196,7 @@
129
196
  "anyOf": [
130
197
  {
131
198
  "type": "number",
132
- "description": "The duration of the animation in seconds."
199
+ "description": "The duration of the anima..."
133
200
  },
134
201
  {
135
202
  "type": "null"
@@ -140,7 +207,7 @@
140
207
  "anyOf": [
141
208
  {
142
209
  "type": "string",
143
- "description": "The interpolation method to use for the animation. Available options are: <ul>\n <li>`linear` - a linear interpolation between the start and end values.</li>\n <li>`bezier` - a bezier curve interpolation between the start and end values.</li>\n <li>`constant` - an interpolation where the property instantly jumps from the start to the end value, without any gradual transition.</li>\n</ul>",
210
+ "description": "The interpolation method to use for the animation. Available options are: <ul>\n <li>`linear` - a linear interpolation between the start and end values.</li>\n <li>`bezier` - a bezier curve interpolation between the start and end values.</li>\n <li>`constant` - a...",
144
211
  "enum": [
145
212
  "linear",
146
213
  "bezier",
@@ -156,7 +223,7 @@
156
223
  "anyOf": [
157
224
  {
158
225
  "type": "string",
159
- "description": "The easing function to use for the animation. Easing controls the rate of change of the animated value, allowing for more natural motion by speeding up or slowing down the animation at different points. Only applicable if interpolation is set to `bezier`.",
226
+ "description": "The easing function to use for the animation. Easing controls the rate of change of the animated value, allowing for more natural motion by speeding up or slowing down the...",
160
227
  "enum": [
161
228
  "ease",
162
229
  "easeIn",