@shotstack/schemas 1.24.0-beta.2 → 1.24.0-beta.3

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.
@@ -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": [
@@ -2193,6 +2196,9 @@
2193
2196
  },
2194
2197
  "duck": {
2195
2198
  "$ref": "#/components/schemas/Duck"
2199
+ },
2200
+ "mute": {
2201
+ "$ref": "#/components/schemas/Mute"
2196
2202
  }
2197
2203
  },
2198
2204
  "additionalProperties": false,
@@ -3361,12 +3367,12 @@
3361
3367
  ]
3362
3368
  },
3363
3369
  "volume": {
3364
- "description": "The volume while ducked, from 0 to 1 (defaults to 0.2). It must be lower than the clip's own 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.",
3365
3371
  "type": "number",
3366
3372
  "format": "float",
3367
3373
  "minimum": 0,
3368
3374
  "maximum": 1,
3369
- "example": 0.2
3375
+ "example": 0.1
3370
3376
  }
3371
3377
  },
3372
3378
  "additionalProperties": false,
@@ -3374,6 +3380,25 @@
3374
3380
  "under"
3375
3381
  ]
3376
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
+ },
3377
3402
  "Transformation": {
3378
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.",
3379
3404
  "type": "object",
@@ -4207,7 +4232,7 @@
4207
4232
  },
4208
4233
  "Filter": {
4209
4234
  "type": "object",
4210
- "description": "A filter that adjusts the look of a Clip. Choose from one of the available filter types below. Keyframe values outside a field's range are limited to that range.",
4235
+ "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.",
4211
4236
  "discriminator": {
4212
4237
  "propertyName": "type",
4213
4238
  "mapping": {
@@ -4696,7 +4721,7 @@
4696
4721
  ]
4697
4722
  },
4698
4723
  "RgbSplitFilter": {
4699
- "description": "Offsets the red and blue channels in opposite directions to create a color fringing effect.",
4724
+ "description": "Offsets the red and blue channels in opposite directions to create a color fringing effect. Channels pushed past one edge of the frame reappear at the opposite edge, so small values such as 0.02 work best and 1 or -1 shows no split.",
4700
4725
  "type": "object",
4701
4726
  "additionalProperties": false,
4702
4727
  "properties": {
@@ -197,6 +197,9 @@
197
197
  },
198
198
  "duck": {
199
199
  "$ref": "#/$defs/Duck"
200
+ },
201
+ "mute": {
202
+ "$ref": "#/$defs/Mute"
200
203
  }
201
204
  },
202
205
  "additionalProperties": false,
@@ -1048,12 +1051,12 @@
1048
1051
  ]
1049
1052
  },
1050
1053
  "volume": {
1051
- "description": "The volume while ducked, from 0 to 1 (defaults to 0.2). It must be lower than the clip's own 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.",
1052
1055
  "type": "number",
1053
1056
  "minimum": 0,
1054
1057
  "maximum": 1,
1055
1058
  "examples": [
1056
- 0.2
1059
+ 0.1
1057
1060
  ]
1058
1061
  }
1059
1062
  },
@@ -1064,7 +1067,7 @@
1064
1067
  },
1065
1068
  "Filter": {
1066
1069
  "type": "object",
1067
- "description": "A filter that adjusts the look of a Clip. Choose from one of the available filter types below. Keyframe values outside a field's range are limited to that range.",
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.",
1068
1071
  "oneOf": [
1069
1072
  {
1070
1073
  "$ref": "#/$defs/BrightnessFilter"
@@ -1692,6 +1695,25 @@
1692
1695
  "replace"
1693
1696
  ]
1694
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
+ },
1695
1717
  "MuxDestination": {
1696
1718
  "deprecated": true,
1697
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.",
@@ -2017,7 +2039,7 @@
2017
2039
  "type": "object"
2018
2040
  },
2019
2041
  "RgbSplitFilter": {
2020
- "description": "Offsets the red and blue channels in opposite directions to create a color fringing effect.",
2042
+ "description": "Offsets the red and blue channels in opposite directions to create a color fringing effect. Channels pushed past one edge of the frame reappear at the opposite edge, so small values such as 0.02 work best and 1 or -1 shows no split.",
2021
2043
  "type": "object",
2022
2044
  "additionalProperties": false,
2023
2045
  "properties": {
@@ -4410,6 +4432,9 @@
4410
4432
  ],
4411
4433
  "type": "string"
4412
4434
  },
4435
+ "mute": {
4436
+ "$ref": "#/$defs/Mute"
4437
+ },
4413
4438
  "speed": {
4414
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.",
4415
4440
  "oneOf": [