@shotstack/schemas 1.24.0 → 1.26.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.
- package/dist/api.bundled.json +64 -0
- package/dist/json-schema/edit.json +67 -0
- package/dist/json-schema/index.cjs +1 -1
- package/dist/json-schema/index.js +1 -1
- package/dist/schema.d.ts +19 -0
- package/dist/zod/zod.gen.cjs +34 -7
- package/dist/zod/zod.gen.d.ts +710 -0
- package/dist/zod/zod.gen.js +28 -1
- package/dist/zod/zod.gen.ts +26 -1
- package/package.json +1 -1
package/dist/api.bundled.json
CHANGED
|
@@ -1862,6 +1862,9 @@
|
|
|
1862
1862
|
],
|
|
1863
1863
|
"type": "string"
|
|
1864
1864
|
},
|
|
1865
|
+
"mute": {
|
|
1866
|
+
"$ref": "#/components/schemas/Mute"
|
|
1867
|
+
},
|
|
1865
1868
|
"speed": {
|
|
1866
1869
|
"description": "Adjust the playback speed of the video clip. Use a number for a constant speed or an array of [Tween](./#tocs_tween) objects to change speed over time, for example easing from normal speed up to 3x.",
|
|
1867
1870
|
"oneOf": [
|
|
@@ -2190,6 +2193,12 @@
|
|
|
2190
2193
|
"fadeInFadeOut"
|
|
2191
2194
|
],
|
|
2192
2195
|
"type": "string"
|
|
2196
|
+
},
|
|
2197
|
+
"duck": {
|
|
2198
|
+
"$ref": "#/components/schemas/Duck"
|
|
2199
|
+
},
|
|
2200
|
+
"mute": {
|
|
2201
|
+
"$ref": "#/components/schemas/Mute"
|
|
2193
2202
|
}
|
|
2194
2203
|
},
|
|
2195
2204
|
"additionalProperties": false,
|
|
@@ -3335,6 +3344,61 @@
|
|
|
3335
3344
|
"additionalProperties": false,
|
|
3336
3345
|
"type": "object"
|
|
3337
3346
|
},
|
|
3347
|
+
"Duck": {
|
|
3348
|
+
"description": "Lowers the clip's volume while other clips play and restores it afterwards, for example to keep music under a voiceover. The volume ramps down just before each referenced clip starts and back up after it ends. Requires a numeric `volume` on the clip and cannot be combined with `speed`.",
|
|
3349
|
+
"type": "object",
|
|
3350
|
+
"properties": {
|
|
3351
|
+
"under": {
|
|
3352
|
+
"description": "The clip or clips to duck under, each referenced by its alias in the form `alias://clip-name`.",
|
|
3353
|
+
"oneOf": [
|
|
3354
|
+
{
|
|
3355
|
+
"type": "string",
|
|
3356
|
+
"pattern": "^alias://[A-Za-z0-9_-]+$",
|
|
3357
|
+
"example": "alias://voice"
|
|
3358
|
+
},
|
|
3359
|
+
{
|
|
3360
|
+
"type": "array",
|
|
3361
|
+
"minItems": 1,
|
|
3362
|
+
"items": {
|
|
3363
|
+
"type": "string",
|
|
3364
|
+
"pattern": "^alias://[A-Za-z0-9_-]+$"
|
|
3365
|
+
}
|
|
3366
|
+
}
|
|
3367
|
+
]
|
|
3368
|
+
},
|
|
3369
|
+
"volume": {
|
|
3370
|
+
"description": "The volume while ducked, from 0 to 1. When omitted, the level is chosen automatically so the clips it ducks under stay clearly audible. When set, it must be lower than the clip's own volume.",
|
|
3371
|
+
"type": "number",
|
|
3372
|
+
"format": "float",
|
|
3373
|
+
"minimum": 0,
|
|
3374
|
+
"maximum": 1,
|
|
3375
|
+
"example": 0.1
|
|
3376
|
+
}
|
|
3377
|
+
},
|
|
3378
|
+
"additionalProperties": false,
|
|
3379
|
+
"required": [
|
|
3380
|
+
"under"
|
|
3381
|
+
]
|
|
3382
|
+
},
|
|
3383
|
+
"Mute": {
|
|
3384
|
+
"description": "Silences English profanity in the clip's speech, and any listed `words`. The audio is transcribed when the edit renders, and the volume drops to zero just before each matching word and returns just after it. Rich captions transcribed from this clip show the same words masked. Profanity detection is not exhaustive: list any word that must not be heard. Cannot be combined with `speed`, `duck` or a volume tween array.",
|
|
3385
|
+
"type": "object",
|
|
3386
|
+
"properties": {
|
|
3387
|
+
"words": {
|
|
3388
|
+
"description": "Extra words to silence, each a single word, matched whole and ignoring case and surrounding punctuation.",
|
|
3389
|
+
"type": "array",
|
|
3390
|
+
"minItems": 1,
|
|
3391
|
+
"maxItems": 200,
|
|
3392
|
+
"items": {
|
|
3393
|
+
"type": "string",
|
|
3394
|
+
"minLength": 1,
|
|
3395
|
+
"maxLength": 50,
|
|
3396
|
+
"pattern": "^\\S+$"
|
|
3397
|
+
}
|
|
3398
|
+
}
|
|
3399
|
+
},
|
|
3400
|
+
"additionalProperties": false
|
|
3401
|
+
},
|
|
3338
3402
|
"Transformation": {
|
|
3339
3403
|
"description": "Apply one or more transformations to a clip. Transformations alter the visual properties of a clip and can be combined to create new shapes and effects.",
|
|
3340
3404
|
"type": "object",
|
|
@@ -194,6 +194,12 @@
|
|
|
194
194
|
"fadeInFadeOut"
|
|
195
195
|
],
|
|
196
196
|
"type": "string"
|
|
197
|
+
},
|
|
198
|
+
"duck": {
|
|
199
|
+
"$ref": "#/$defs/Duck"
|
|
200
|
+
},
|
|
201
|
+
"mute": {
|
|
202
|
+
"$ref": "#/$defs/Mute"
|
|
197
203
|
}
|
|
198
204
|
},
|
|
199
205
|
"additionalProperties": false,
|
|
@@ -1020,6 +1026,45 @@
|
|
|
1020
1026
|
}
|
|
1021
1027
|
]
|
|
1022
1028
|
},
|
|
1029
|
+
"Duck": {
|
|
1030
|
+
"description": "Lowers the clip's volume while other clips play and restores it afterwards, for example to keep music under a voiceover. The volume ramps down just before each referenced clip starts and back up after it ends. Requires a numeric `volume` on the clip and cannot be combined with `speed`.",
|
|
1031
|
+
"type": "object",
|
|
1032
|
+
"properties": {
|
|
1033
|
+
"under": {
|
|
1034
|
+
"description": "The clip or clips to duck under, each referenced by its alias in the form `alias://clip-name`.",
|
|
1035
|
+
"oneOf": [
|
|
1036
|
+
{
|
|
1037
|
+
"type": "string",
|
|
1038
|
+
"pattern": "^alias://[A-Za-z0-9_-]+$",
|
|
1039
|
+
"examples": [
|
|
1040
|
+
"alias://voice"
|
|
1041
|
+
]
|
|
1042
|
+
},
|
|
1043
|
+
{
|
|
1044
|
+
"type": "array",
|
|
1045
|
+
"minItems": 1,
|
|
1046
|
+
"items": {
|
|
1047
|
+
"type": "string",
|
|
1048
|
+
"pattern": "^alias://[A-Za-z0-9_-]+$"
|
|
1049
|
+
}
|
|
1050
|
+
}
|
|
1051
|
+
]
|
|
1052
|
+
},
|
|
1053
|
+
"volume": {
|
|
1054
|
+
"description": "The volume while ducked, from 0 to 1. When omitted, the level is chosen automatically so the clips it ducks under stay clearly audible. When set, it must be lower than the clip's own volume.",
|
|
1055
|
+
"type": "number",
|
|
1056
|
+
"minimum": 0,
|
|
1057
|
+
"maximum": 1,
|
|
1058
|
+
"examples": [
|
|
1059
|
+
0.1
|
|
1060
|
+
]
|
|
1061
|
+
}
|
|
1062
|
+
},
|
|
1063
|
+
"additionalProperties": false,
|
|
1064
|
+
"required": [
|
|
1065
|
+
"under"
|
|
1066
|
+
]
|
|
1067
|
+
},
|
|
1023
1068
|
"Filter": {
|
|
1024
1069
|
"type": "object",
|
|
1025
1070
|
"description": "A filter that adjusts the look of a Clip. Choose from one of the available filter types below. Tween values outside a field's range are limited to that range.",
|
|
@@ -1650,6 +1695,25 @@
|
|
|
1650
1695
|
"replace"
|
|
1651
1696
|
]
|
|
1652
1697
|
},
|
|
1698
|
+
"Mute": {
|
|
1699
|
+
"description": "Silences English profanity in the clip's speech, and any listed `words`. The audio is transcribed when the edit renders, and the volume drops to zero just before each matching word and returns just after it. Rich captions transcribed from this clip show the same words masked. Profanity detection is not exhaustive: list any word that must not be heard. Cannot be combined with `speed`, `duck` or a volume tween array.",
|
|
1700
|
+
"type": "object",
|
|
1701
|
+
"properties": {
|
|
1702
|
+
"words": {
|
|
1703
|
+
"description": "Extra words to silence, each a single word, matched whole and ignoring case and surrounding punctuation.",
|
|
1704
|
+
"type": "array",
|
|
1705
|
+
"minItems": 1,
|
|
1706
|
+
"maxItems": 200,
|
|
1707
|
+
"items": {
|
|
1708
|
+
"type": "string",
|
|
1709
|
+
"minLength": 1,
|
|
1710
|
+
"maxLength": 50,
|
|
1711
|
+
"pattern": "^\\S+$"
|
|
1712
|
+
}
|
|
1713
|
+
}
|
|
1714
|
+
},
|
|
1715
|
+
"additionalProperties": false
|
|
1716
|
+
},
|
|
1653
1717
|
"MuxDestination": {
|
|
1654
1718
|
"deprecated": true,
|
|
1655
1719
|
"description": "**Notice: The Mux destination is deprecated.** It continues to work, with no behaviour change for existing integrations.\nSend videos to the [Mux](https://www.mux.com/docs) video hosting and streaming service. Mux credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/mux), not in the request.",
|
|
@@ -4368,6 +4432,9 @@
|
|
|
4368
4432
|
],
|
|
4369
4433
|
"type": "string"
|
|
4370
4434
|
},
|
|
4435
|
+
"mute": {
|
|
4436
|
+
"$ref": "#/$defs/Mute"
|
|
4437
|
+
},
|
|
4371
4438
|
"speed": {
|
|
4372
4439
|
"description": "Adjust the playback speed of the video clip. Use a number for a constant speed or an array of [Tween](./#tocs_tween) objects to change speed over time, for example easing from normal speed up to 3x.",
|
|
4373
4440
|
"oneOf": [
|