@shotstack/schemas 1.13.3 → 1.14.1
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.
- package/dist/api.bundled.json +98 -11
- package/dist/json-schema/asset.json +144 -0
- package/dist/json-schema/audio-asset.json +59 -21
- package/dist/json-schema/clip.json +144 -0
- package/dist/json-schema/destinations.json +19 -5
- package/dist/json-schema/edit.json +163 -5
- package/dist/json-schema/google-drive-destination-options.json +12 -5
- package/dist/json-schema/google-drive-destination.json +21 -7
- package/dist/json-schema/image-asset.json +39 -1
- package/dist/json-schema/output.json +19 -5
- package/dist/json-schema/schemas.json +177 -10
- package/dist/json-schema/template.json +145 -1
- package/dist/json-schema/timeline.json +144 -0
- package/dist/json-schema/track.json +144 -0
- package/dist/json-schema/video-asset.json +106 -29
- package/dist/schema.d.ts +55 -7
- package/dist/zod/zod.gen.cjs +55 -2
- package/dist/zod/zod.gen.d.ts +1824 -177
- package/dist/zod/zod.gen.js +55 -2
- package/dist/zod/zod.gen.ts +49 -2
- package/package.json +1 -1
package/dist/api.bundled.json
CHANGED
|
@@ -1220,10 +1220,60 @@
|
|
|
1220
1220
|
"example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/input-image.jpg"
|
|
1221
1221
|
},
|
|
1222
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.",
|
|
1223
|
+
"description": "The generation model to use when `prompt` is set (e.g. `luma-ray-3`, `runpod-itv-mini`, `fal/seedance-2.0`). Defaults to the platform's preferred generator if omitted.",
|
|
1224
1224
|
"type": "string",
|
|
1225
1225
|
"example": "luma-ray-3"
|
|
1226
1226
|
},
|
|
1227
|
+
"resolution": {
|
|
1228
|
+
"description": "Output resolution for video generation. Only meaningful when `prompt` is set and the model supports it (e.g. `fal/seedance-2.0`).",
|
|
1229
|
+
"enum": [
|
|
1230
|
+
"480p",
|
|
1231
|
+
"720p",
|
|
1232
|
+
"1080p"
|
|
1233
|
+
],
|
|
1234
|
+
"type": "string",
|
|
1235
|
+
"example": "720p"
|
|
1236
|
+
},
|
|
1237
|
+
"duration": {
|
|
1238
|
+
"description": "Target video duration in seconds for generation models that accept it. `\"auto\"` lets the model decide. Only meaningful when `prompt` is set.",
|
|
1239
|
+
"enum": [
|
|
1240
|
+
"auto",
|
|
1241
|
+
"4",
|
|
1242
|
+
"5",
|
|
1243
|
+
"6",
|
|
1244
|
+
"7",
|
|
1245
|
+
"8",
|
|
1246
|
+
"9",
|
|
1247
|
+
"10",
|
|
1248
|
+
"11",
|
|
1249
|
+
"12",
|
|
1250
|
+
"13",
|
|
1251
|
+
"14",
|
|
1252
|
+
"15"
|
|
1253
|
+
],
|
|
1254
|
+
"type": "string",
|
|
1255
|
+
"default": "auto",
|
|
1256
|
+
"example": "5"
|
|
1257
|
+
},
|
|
1258
|
+
"aspectRatio": {
|
|
1259
|
+
"description": "Aspect ratio for the generated video. Only meaningful when `prompt` is set and the model supports it.",
|
|
1260
|
+
"enum": [
|
|
1261
|
+
"1:1",
|
|
1262
|
+
"16:9",
|
|
1263
|
+
"9:16",
|
|
1264
|
+
"4:3",
|
|
1265
|
+
"3:4",
|
|
1266
|
+
"21:9",
|
|
1267
|
+
"9:21"
|
|
1268
|
+
],
|
|
1269
|
+
"type": "string",
|
|
1270
|
+
"example": "16:9"
|
|
1271
|
+
},
|
|
1272
|
+
"generateAudio": {
|
|
1273
|
+
"description": "Set to `true` to request audio generation alongside the video. Only meaningful for video generation models that support it (e.g. `fal/seedance-2.0`).",
|
|
1274
|
+
"type": "boolean",
|
|
1275
|
+
"default": false
|
|
1276
|
+
},
|
|
1227
1277
|
"transcode": {
|
|
1228
1278
|
"type": "boolean",
|
|
1229
1279
|
"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.",
|
|
@@ -1310,10 +1360,34 @@
|
|
|
1310
1360
|
"example": "A serene landscape with a crystal-clear mountain lake at sunrise."
|
|
1311
1361
|
},
|
|
1312
1362
|
"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.",
|
|
1363
|
+
"description": "The generation model to use when `prompt` is set (e.g. `flux-schnell`, `fal/flux-schnell`, `fal/nano-banana-2`). Defaults to the platform's preferred generator if omitted.",
|
|
1314
1364
|
"type": "string",
|
|
1315
1365
|
"example": "flux-schnell"
|
|
1316
1366
|
},
|
|
1367
|
+
"resolution": {
|
|
1368
|
+
"description": "Output resolution tier for supported image generation models. `1K` (default), `2K`, or `4K`. Only meaningful when `prompt` is set.",
|
|
1369
|
+
"enum": [
|
|
1370
|
+
"1K",
|
|
1371
|
+
"2K",
|
|
1372
|
+
"4K"
|
|
1373
|
+
],
|
|
1374
|
+
"type": "string",
|
|
1375
|
+
"example": "1K"
|
|
1376
|
+
},
|
|
1377
|
+
"aspectRatio": {
|
|
1378
|
+
"description": "Aspect ratio for the generated image. Only meaningful when `prompt` is set and the model supports it.",
|
|
1379
|
+
"enum": [
|
|
1380
|
+
"1:1",
|
|
1381
|
+
"16:9",
|
|
1382
|
+
"9:16",
|
|
1383
|
+
"4:3",
|
|
1384
|
+
"3:4",
|
|
1385
|
+
"21:9",
|
|
1386
|
+
"9:21"
|
|
1387
|
+
],
|
|
1388
|
+
"type": "string",
|
|
1389
|
+
"example": "1:1"
|
|
1390
|
+
},
|
|
1317
1391
|
"crop": {
|
|
1318
1392
|
"$ref": "#/components/schemas/Crop"
|
|
1319
1393
|
}
|
|
@@ -1595,10 +1669,27 @@
|
|
|
1595
1669
|
"default": false
|
|
1596
1670
|
},
|
|
1597
1671
|
"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.",
|
|
1672
|
+
"description": "The generation model to use when `prompt` is set (e.g. `polly-neural`, `fal/elevenlabs-tts`, `fal/minimax-speech`, `fal/elevenlabs-music`). Defaults to the platform's preferred generator if omitted.",
|
|
1599
1673
|
"type": "string",
|
|
1600
1674
|
"example": "polly-neural"
|
|
1601
1675
|
},
|
|
1676
|
+
"musicLengthMs": {
|
|
1677
|
+
"description": "Target duration in milliseconds for generated music (3,000–600,000). Only meaningful when `prompt` is set and the model is a music generator (e.g. `fal/elevenlabs-music`).",
|
|
1678
|
+
"type": "number",
|
|
1679
|
+
"minimum": 3000,
|
|
1680
|
+
"maximum": 600000,
|
|
1681
|
+
"example": 30000
|
|
1682
|
+
},
|
|
1683
|
+
"forceInstrumental": {
|
|
1684
|
+
"description": "Set to `true` to force instrumental music (no vocals). Only meaningful for music generation models.",
|
|
1685
|
+
"type": "boolean",
|
|
1686
|
+
"default": false
|
|
1687
|
+
},
|
|
1688
|
+
"compositionPlan": {
|
|
1689
|
+
"description": "An optional structured composition plan for music generation. Only meaningful for music generation models (e.g. `fal/elevenlabs-music`).",
|
|
1690
|
+
"type": "string",
|
|
1691
|
+
"maxLength": 4000
|
|
1692
|
+
},
|
|
1602
1693
|
"trim": {
|
|
1603
1694
|
"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.",
|
|
1604
1695
|
"type": "number"
|
|
@@ -4081,21 +4172,20 @@
|
|
|
4081
4172
|
"example": "google-drive"
|
|
4082
4173
|
},
|
|
4083
4174
|
"options": {
|
|
4084
|
-
"description": "Additional Google Drive configuration and features.",
|
|
4175
|
+
"description": "Additional Google Drive configuration and features. If omitted, files are saved to the root of My Drive using the default Shotstack filename.",
|
|
4085
4176
|
"$ref": "#/components/schemas/GoogleDriveDestinationOptions"
|
|
4086
4177
|
}
|
|
4087
4178
|
},
|
|
4088
4179
|
"type": "object",
|
|
4089
4180
|
"required": [
|
|
4090
|
-
"provider"
|
|
4091
|
-
"options"
|
|
4181
|
+
"provider"
|
|
4092
4182
|
]
|
|
4093
4183
|
},
|
|
4094
4184
|
"GoogleDriveDestinationOptions": {
|
|
4095
4185
|
"description": "Pass the folder ID and options to configure how assets are stored in Google Drive.",
|
|
4096
4186
|
"properties": {
|
|
4097
4187
|
"folderId": {
|
|
4098
|
-
"description": "The Google Drive folder ID where asset will be stored.
|
|
4188
|
+
"description": "The Google Drive folder ID where the asset will be stored. If omitted, the asset is saved to the root of My Drive. The folder ID can be retrieved from the URL when logged in to Google Drive, e.g. <a href=\"#\">https://drive.google.com/drive/u/0/folders/1r-eTY6OLO8tzQRKwMyq-fIrQ_7AJEI6A</a>.",
|
|
4099
4189
|
"type": "string",
|
|
4100
4190
|
"example": "1r-eTY6OLO8tzQRKwMyq-fIrQ_7AJEI6A"
|
|
4101
4191
|
},
|
|
@@ -4104,10 +4194,7 @@
|
|
|
4104
4194
|
"type": "string",
|
|
4105
4195
|
"example": "my-file"
|
|
4106
4196
|
}
|
|
4107
|
-
}
|
|
4108
|
-
"required": [
|
|
4109
|
-
"folderId"
|
|
4110
|
-
]
|
|
4197
|
+
}
|
|
4111
4198
|
},
|
|
4112
4199
|
"VimeoDestination": {
|
|
4113
4200
|
"description": "Send videos to [Vimeo](https://shotstack.io/docs/guide/serving-assets/destinations/vimeo/) video hosting and streaming service. Vimeo credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/vimeo), not in the request.",
|
|
@@ -90,6 +90,75 @@
|
|
|
90
90
|
}
|
|
91
91
|
]
|
|
92
92
|
},
|
|
93
|
+
"resolution": {
|
|
94
|
+
"anyOf": [
|
|
95
|
+
{
|
|
96
|
+
"type": "string",
|
|
97
|
+
"enum": [
|
|
98
|
+
"480p",
|
|
99
|
+
"720p",
|
|
100
|
+
"1080p"
|
|
101
|
+
]
|
|
102
|
+
},
|
|
103
|
+
{
|
|
104
|
+
"type": "null"
|
|
105
|
+
}
|
|
106
|
+
]
|
|
107
|
+
},
|
|
108
|
+
"duration": {
|
|
109
|
+
"anyOf": [
|
|
110
|
+
{
|
|
111
|
+
"type": "string",
|
|
112
|
+
"enum": [
|
|
113
|
+
"auto",
|
|
114
|
+
"4",
|
|
115
|
+
"5",
|
|
116
|
+
"6",
|
|
117
|
+
"7",
|
|
118
|
+
"8",
|
|
119
|
+
"9",
|
|
120
|
+
"10",
|
|
121
|
+
"11",
|
|
122
|
+
"12",
|
|
123
|
+
"13",
|
|
124
|
+
"14",
|
|
125
|
+
"15"
|
|
126
|
+
]
|
|
127
|
+
},
|
|
128
|
+
{
|
|
129
|
+
"type": "null"
|
|
130
|
+
}
|
|
131
|
+
]
|
|
132
|
+
},
|
|
133
|
+
"aspectRatio": {
|
|
134
|
+
"anyOf": [
|
|
135
|
+
{
|
|
136
|
+
"type": "string",
|
|
137
|
+
"enum": [
|
|
138
|
+
"1:1",
|
|
139
|
+
"16:9",
|
|
140
|
+
"9:16",
|
|
141
|
+
"4:3",
|
|
142
|
+
"3:4",
|
|
143
|
+
"21:9",
|
|
144
|
+
"9:21"
|
|
145
|
+
]
|
|
146
|
+
},
|
|
147
|
+
{
|
|
148
|
+
"type": "null"
|
|
149
|
+
}
|
|
150
|
+
]
|
|
151
|
+
},
|
|
152
|
+
"generateAudio": {
|
|
153
|
+
"anyOf": [
|
|
154
|
+
{
|
|
155
|
+
"type": "boolean"
|
|
156
|
+
},
|
|
157
|
+
{
|
|
158
|
+
"type": "null"
|
|
159
|
+
}
|
|
160
|
+
]
|
|
161
|
+
},
|
|
93
162
|
"transcode": {
|
|
94
163
|
"anyOf": [
|
|
95
164
|
{
|
|
@@ -184,6 +253,10 @@
|
|
|
184
253
|
"prompt",
|
|
185
254
|
"inputSrc",
|
|
186
255
|
"model",
|
|
256
|
+
"resolution",
|
|
257
|
+
"duration",
|
|
258
|
+
"aspectRatio",
|
|
259
|
+
"generateAudio",
|
|
187
260
|
"transcode",
|
|
188
261
|
"trim",
|
|
189
262
|
"volume",
|
|
@@ -439,6 +512,40 @@
|
|
|
439
512
|
}
|
|
440
513
|
]
|
|
441
514
|
},
|
|
515
|
+
"resolution": {
|
|
516
|
+
"anyOf": [
|
|
517
|
+
{
|
|
518
|
+
"type": "string",
|
|
519
|
+
"enum": [
|
|
520
|
+
"1K",
|
|
521
|
+
"2K",
|
|
522
|
+
"4K"
|
|
523
|
+
]
|
|
524
|
+
},
|
|
525
|
+
{
|
|
526
|
+
"type": "null"
|
|
527
|
+
}
|
|
528
|
+
]
|
|
529
|
+
},
|
|
530
|
+
"aspectRatio": {
|
|
531
|
+
"anyOf": [
|
|
532
|
+
{
|
|
533
|
+
"type": "string",
|
|
534
|
+
"enum": [
|
|
535
|
+
"1:1",
|
|
536
|
+
"16:9",
|
|
537
|
+
"9:16",
|
|
538
|
+
"4:3",
|
|
539
|
+
"3:4",
|
|
540
|
+
"21:9",
|
|
541
|
+
"9:21"
|
|
542
|
+
]
|
|
543
|
+
},
|
|
544
|
+
{
|
|
545
|
+
"type": "null"
|
|
546
|
+
}
|
|
547
|
+
]
|
|
548
|
+
},
|
|
442
549
|
"crop": {
|
|
443
550
|
"anyOf": [
|
|
444
551
|
{
|
|
@@ -456,6 +563,8 @@
|
|
|
456
563
|
"src",
|
|
457
564
|
"prompt",
|
|
458
565
|
"model",
|
|
566
|
+
"resolution",
|
|
567
|
+
"aspectRatio",
|
|
459
568
|
"crop"
|
|
460
569
|
]
|
|
461
570
|
},
|
|
@@ -1283,6 +1392,38 @@
|
|
|
1283
1392
|
}
|
|
1284
1393
|
]
|
|
1285
1394
|
},
|
|
1395
|
+
"musicLengthMs": {
|
|
1396
|
+
"anyOf": [
|
|
1397
|
+
{
|
|
1398
|
+
"type": "number",
|
|
1399
|
+
"minimum": 3000,
|
|
1400
|
+
"maximum": 600000
|
|
1401
|
+
},
|
|
1402
|
+
{
|
|
1403
|
+
"type": "null"
|
|
1404
|
+
}
|
|
1405
|
+
]
|
|
1406
|
+
},
|
|
1407
|
+
"forceInstrumental": {
|
|
1408
|
+
"anyOf": [
|
|
1409
|
+
{
|
|
1410
|
+
"type": "boolean"
|
|
1411
|
+
},
|
|
1412
|
+
{
|
|
1413
|
+
"type": "null"
|
|
1414
|
+
}
|
|
1415
|
+
]
|
|
1416
|
+
},
|
|
1417
|
+
"compositionPlan": {
|
|
1418
|
+
"anyOf": [
|
|
1419
|
+
{
|
|
1420
|
+
"type": "string"
|
|
1421
|
+
},
|
|
1422
|
+
{
|
|
1423
|
+
"type": "null"
|
|
1424
|
+
}
|
|
1425
|
+
]
|
|
1426
|
+
},
|
|
1286
1427
|
"trim": {
|
|
1287
1428
|
"anyOf": [
|
|
1288
1429
|
{
|
|
@@ -1349,6 +1490,9 @@
|
|
|
1349
1490
|
"language",
|
|
1350
1491
|
"newscaster",
|
|
1351
1492
|
"model",
|
|
1493
|
+
"musicLengthMs",
|
|
1494
|
+
"forceInstrumental",
|
|
1495
|
+
"compositionPlan",
|
|
1352
1496
|
"trim",
|
|
1353
1497
|
"volume",
|
|
1354
1498
|
"speed",
|
|
@@ -2,21 +2,21 @@
|
|
|
2
2
|
"name": "AudioAsset",
|
|
3
3
|
"strict": true,
|
|
4
4
|
"schema": {
|
|
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
|
|
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 t...",
|
|
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
|
|
12
|
+
"description": "The type of asset - set t...",
|
|
13
13
|
"type": "string"
|
|
14
14
|
},
|
|
15
15
|
"src": {
|
|
16
16
|
"anyOf": [
|
|
17
17
|
{
|
|
18
18
|
"type": "string",
|
|
19
|
-
"description": "The audio source URL. The URL must be publicly accessible or
|
|
19
|
+
"description": "The audio source URL. The URL must be publicly accessible or inc..."
|
|
20
20
|
},
|
|
21
21
|
{
|
|
22
22
|
"type": "null"
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
"anyOf": [
|
|
28
28
|
{
|
|
29
29
|
"type": "string",
|
|
30
|
-
"description": "A text prompt. When `voice` is set, the prompt is the spoken text (text-to-speech). Without `voice`, the
|
|
30
|
+
"description": "A text prompt. When `voice` is set, the prompt is the spoken text (text-to-speech). Without `voice`, the p..."
|
|
31
31
|
},
|
|
32
32
|
{
|
|
33
33
|
"type": "null"
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
"anyOf": [
|
|
39
39
|
{
|
|
40
40
|
"type": "string",
|
|
41
|
-
"description": "Voice identifier for text-to-speech generation (e.g. `
|
|
41
|
+
"description": "Voice identifier for text-to-speech generation (e.g. `Mat..."
|
|
42
42
|
},
|
|
43
43
|
{
|
|
44
44
|
"type": "null"
|
|
@@ -49,7 +49,7 @@
|
|
|
49
49
|
"anyOf": [
|
|
50
50
|
{
|
|
51
51
|
"type": "string",
|
|
52
|
-
"description": "Optional BCP-47 language code (e.g. `en-US`) for text-to-
|
|
52
|
+
"description": "Optional BCP-47 language code (e.g. `en-US`) for text-to-sp..."
|
|
53
53
|
},
|
|
54
54
|
{
|
|
55
55
|
"type": "null"
|
|
@@ -60,7 +60,7 @@
|
|
|
60
60
|
"anyOf": [
|
|
61
61
|
{
|
|
62
62
|
"type": "boolean",
|
|
63
|
-
"description": "Set to `true` to use the voice's newscaster mode when
|
|
63
|
+
"description": "Set to `true` to use the voice's newscaster mode when suppo..."
|
|
64
64
|
},
|
|
65
65
|
{
|
|
66
66
|
"type": "null"
|
|
@@ -71,7 +71,42 @@
|
|
|
71
71
|
"anyOf": [
|
|
72
72
|
{
|
|
73
73
|
"type": "string",
|
|
74
|
-
"description": "The generation model to use when `prompt` is set (e.g. `polly-neural`
|
|
74
|
+
"description": "The generation model to use when `prompt` is set (e.g. `polly-neural`, `fal/elevenlabs-tts`, `fal/minim..."
|
|
75
|
+
},
|
|
76
|
+
{
|
|
77
|
+
"type": "null"
|
|
78
|
+
}
|
|
79
|
+
]
|
|
80
|
+
},
|
|
81
|
+
"musicLengthMs": {
|
|
82
|
+
"anyOf": [
|
|
83
|
+
{
|
|
84
|
+
"type": "number",
|
|
85
|
+
"description": "Target duration in milliseconds for generated music (3,000–600,000). Only meaningful when...",
|
|
86
|
+
"minimum": 3000,
|
|
87
|
+
"maximum": 600000
|
|
88
|
+
},
|
|
89
|
+
{
|
|
90
|
+
"type": "null"
|
|
91
|
+
}
|
|
92
|
+
]
|
|
93
|
+
},
|
|
94
|
+
"forceInstrumental": {
|
|
95
|
+
"anyOf": [
|
|
96
|
+
{
|
|
97
|
+
"type": "boolean",
|
|
98
|
+
"description": "Set to `true` to force instrumental music (no voca..."
|
|
99
|
+
},
|
|
100
|
+
{
|
|
101
|
+
"type": "null"
|
|
102
|
+
}
|
|
103
|
+
]
|
|
104
|
+
},
|
|
105
|
+
"compositionPlan": {
|
|
106
|
+
"anyOf": [
|
|
107
|
+
{
|
|
108
|
+
"type": "string",
|
|
109
|
+
"description": "An optional structured composition plan for music generation. Only mea..."
|
|
75
110
|
},
|
|
76
111
|
{
|
|
77
112
|
"type": "null"
|
|
@@ -82,7 +117,7 @@
|
|
|
82
117
|
"anyOf": [
|
|
83
118
|
{
|
|
84
119
|
"type": "number",
|
|
85
|
-
"description": "The start trim point of the audio clip, in seconds (defaults to 0). Audio will start from the
|
|
120
|
+
"description": "The start trim point of the audio clip, in seconds (defaults to 0). Audio will start from the..."
|
|
86
121
|
},
|
|
87
122
|
{
|
|
88
123
|
"type": "null"
|
|
@@ -90,17 +125,17 @@
|
|
|
90
125
|
]
|
|
91
126
|
},
|
|
92
127
|
"volume": {
|
|
93
|
-
"description": "Set the volume of the audio clip. Use a number or an array of [
|
|
128
|
+
"description": "Set the volume of the audio clip. Use a number or an array of [Twe...",
|
|
94
129
|
"anyOf": [
|
|
95
130
|
{
|
|
96
131
|
"type": "number",
|
|
97
|
-
"description": "The volume level for the audio clip. Range varies from 0 to
|
|
132
|
+
"description": "The volume level for the audio clip. Range varies from 0 to...",
|
|
98
133
|
"minimum": 0,
|
|
99
134
|
"maximum": 1
|
|
100
135
|
},
|
|
101
136
|
{
|
|
102
137
|
"type": "array",
|
|
103
|
-
"description": "An array of [Tween](./#tocs_tween) objects used to create a
|
|
138
|
+
"description": "An array of [Tween](./#tocs_tween) objects used to create a cu...",
|
|
104
139
|
"items": {
|
|
105
140
|
"$ref": "#/$defs/Tween"
|
|
106
141
|
}
|
|
@@ -114,7 +149,7 @@
|
|
|
114
149
|
"anyOf": [
|
|
115
150
|
{
|
|
116
151
|
"type": "number",
|
|
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
|
|
152
|
+
"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 ...",
|
|
118
153
|
"minimum": 0,
|
|
119
154
|
"maximum": 10
|
|
120
155
|
},
|
|
@@ -127,7 +162,7 @@
|
|
|
127
162
|
"anyOf": [
|
|
128
163
|
{
|
|
129
164
|
"type": "string",
|
|
130
|
-
"description": "The effect to apply to the audio asset <ul>\n <li>`fadeIn` - fade volume in only</li>\n <li>`
|
|
165
|
+
"description": "The effect to apply to the audio asset <ul>\n <li>`fadeIn` - fade volume in only</li>\n <li>`fade...",
|
|
131
166
|
"enum": [
|
|
132
167
|
"none",
|
|
133
168
|
"fadeIn",
|
|
@@ -150,6 +185,9 @@
|
|
|
150
185
|
"language",
|
|
151
186
|
"newscaster",
|
|
152
187
|
"model",
|
|
188
|
+
"musicLengthMs",
|
|
189
|
+
"forceInstrumental",
|
|
190
|
+
"compositionPlan",
|
|
153
191
|
"trim",
|
|
154
192
|
"volume",
|
|
155
193
|
"speed",
|
|
@@ -157,13 +195,13 @@
|
|
|
157
195
|
],
|
|
158
196
|
"$defs": {
|
|
159
197
|
"Tween": {
|
|
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
|
|
198
|
+
"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 t...",
|
|
161
199
|
"properties": {
|
|
162
200
|
"from": {
|
|
163
201
|
"anyOf": [
|
|
164
202
|
{
|
|
165
203
|
"type": "string",
|
|
166
|
-
"description": "The initial property value
|
|
204
|
+
"description": "The initial property value ..."
|
|
167
205
|
},
|
|
168
206
|
{
|
|
169
207
|
"type": "null"
|
|
@@ -174,7 +212,7 @@
|
|
|
174
212
|
"anyOf": [
|
|
175
213
|
{
|
|
176
214
|
"type": "string",
|
|
177
|
-
"description": "The final property value
|
|
215
|
+
"description": "The final property value ..."
|
|
178
216
|
},
|
|
179
217
|
{
|
|
180
218
|
"type": "null"
|
|
@@ -185,7 +223,7 @@
|
|
|
185
223
|
"anyOf": [
|
|
186
224
|
{
|
|
187
225
|
"type": "number",
|
|
188
|
-
"description": "The time in seconds when the animation
|
|
226
|
+
"description": "The time in seconds when the animation star..."
|
|
189
227
|
},
|
|
190
228
|
{
|
|
191
229
|
"type": "null"
|
|
@@ -196,7 +234,7 @@
|
|
|
196
234
|
"anyOf": [
|
|
197
235
|
{
|
|
198
236
|
"type": "number",
|
|
199
|
-
"description": "The duration of the
|
|
237
|
+
"description": "The duration of the..."
|
|
200
238
|
},
|
|
201
239
|
{
|
|
202
240
|
"type": "null"
|
|
@@ -207,7 +245,7 @@
|
|
|
207
245
|
"anyOf": [
|
|
208
246
|
{
|
|
209
247
|
"type": "string",
|
|
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
|
|
248
|
+
"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 be...",
|
|
211
249
|
"enum": [
|
|
212
250
|
"linear",
|
|
213
251
|
"bezier",
|
|
@@ -223,7 +261,7 @@
|
|
|
223
261
|
"anyOf": [
|
|
224
262
|
{
|
|
225
263
|
"type": "string",
|
|
226
|
-
"description": "The easing function to use for the animation. Easing controls the rate of change of the animated value, allowing for more natural
|
|
264
|
+
"description": "The easing function to use for the animation. Easing controls the rate of change of the animated value, allowing for more natural moti...",
|
|
227
265
|
"enum": [
|
|
228
266
|
"ease",
|
|
229
267
|
"easeIn",
|