@shotstack/schemas 1.24.0-beta.2 → 1.25.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/schema.d.ts CHANGED
@@ -1747,8 +1747,8 @@ export interface components {
1747
1747
  under: string | string[];
1748
1748
  /**
1749
1749
  * Format: float
1750
- * @description The volume while ducked, from 0 to 1 (defaults to 0.2). It must be lower than the clip's own volume.
1751
- * @example 0.2
1750
+ * @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.
1751
+ * @example 0.1
1752
1752
  */
1753
1753
  volume?: number;
1754
1754
  };
@@ -2326,7 +2326,7 @@ export interface components {
2326
2326
  */
2327
2327
  easing?: "ease" | "easeIn" | "easeOut" | "easeInOut" | "easeInQuad" | "easeInCubic" | "easeInQuart" | "easeInQuint" | "easeInSine" | "easeInExpo" | "easeInCirc" | "easeInBack" | "easeOutQuad" | "easeOutCubic" | "easeOutQuart" | "easeOutQuint" | "easeOutSine" | "easeOutExpo" | "easeOutCirc" | "easeOutBack" | "easeInOutQuad" | "easeInOutCubic" | "easeInOutQuart" | "easeInOutQuint" | "easeInOutSine" | "easeInOutExpo" | "easeInOutCirc" | "easeInOutBack";
2328
2328
  };
2329
- /** @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. */
2329
+ /** @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. */
2330
2330
  Filter: components["schemas"]["BrightnessFilter"] | components["schemas"]["ContrastFilter"] | components["schemas"]["SaturationFilter"] | components["schemas"]["HueFilter"] | components["schemas"]["GradeFilter"] | components["schemas"]["BlurFilter"] | components["schemas"]["SharpenFilter"] | components["schemas"]["PixelateFilter"] | components["schemas"]["RgbSplitFilter"] | components["schemas"]["NegativeFilter"];
2331
2331
  /** @description Lightens or darkens the clip. */
2332
2332
  BrightnessFilter: {
@@ -2424,7 +2424,7 @@ export interface components {
2424
2424
  /** @description Sets the strength of the pixelation. Use a number or an array of [Tween](./#tocs_tween) objects to change it over time. */
2425
2425
  value?: number | components["schemas"]["Tween"][];
2426
2426
  };
2427
- /** @description Offsets the red and blue channels in opposite directions to create a color fringing effect. */
2427
+ /** @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. */
2428
2428
  RgbSplitFilter: {
2429
2429
  /**
2430
2430
  * @description The filter type - set to `rgbSplit`. (enum property replaced by openapi-typescript)
@@ -2618,7 +2618,7 @@ exports.pixelatefilterPixelateFilterSchema = zod_1.z.object({
2618
2618
  }).strict();
2619
2619
  exports.pixelateFilterSchema = exports.pixelatefilterPixelateFilterSchema;
2620
2620
  /**
2621
- * Offsets the red and blue channels in opposite directions to create a color fringing effect.
2621
+ * 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.
2622
2622
  */
2623
2623
  exports.rgbsplitfilterRgbSplitFilterSchema = zod_1.z.object({
2624
2624
  type: zod_1.z.enum(['rgbSplit']),
@@ -2705,7 +2705,7 @@ exports.sharpenfilterSharpenFilterSchema = zod_1.z.object({
2705
2705
  }).strict();
2706
2706
  exports.sharpenFilterSchema = exports.sharpenfilterSharpenFilterSchema;
2707
2707
  /**
2708
- * 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.
2708
+ * 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.
2709
2709
  */
2710
2710
  exports.filterFilterSchema = zod_1.z.discriminatedUnion("type", [
2711
2711
  exports.brightnessfilterBrightnessFilterSchema,
@@ -7390,7 +7390,7 @@ export declare const pixelateFilterSchema: z.ZodObject<{
7390
7390
  }, z.core.$strict>>]>>;
7391
7391
  }, z.core.$strict>;
7392
7392
  /**
7393
- * Offsets the red and blue channels in opposite directions to create a color fringing effect.
7393
+ * 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.
7394
7394
  */
7395
7395
  export declare const rgbsplitfilterRgbSplitFilterSchema: z.ZodObject<{
7396
7396
  type: z.ZodEnum<{
@@ -7928,7 +7928,7 @@ export declare const sharpenFilterSchema: z.ZodObject<{
7928
7928
  }, z.core.$strict>>]>>;
7929
7929
  }, z.core.$strict>;
7930
7930
  /**
7931
- * 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.
7931
+ * 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.
7932
7932
  */
7933
7933
  export declare const filterFilterSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
7934
7934
  type: z.ZodEnum<{
@@ -2609,7 +2609,7 @@ export const pixelatefilterPixelateFilterSchema = z.object({
2609
2609
  }).strict();
2610
2610
  export const pixelateFilterSchema = pixelatefilterPixelateFilterSchema;
2611
2611
  /**
2612
- * Offsets the red and blue channels in opposite directions to create a color fringing effect.
2612
+ * 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.
2613
2613
  */
2614
2614
  export const rgbsplitfilterRgbSplitFilterSchema = z.object({
2615
2615
  type: z.enum(['rgbSplit']),
@@ -2696,7 +2696,7 @@ export const sharpenfilterSharpenFilterSchema = z.object({
2696
2696
  }).strict();
2697
2697
  export const sharpenFilterSchema = sharpenfilterSharpenFilterSchema;
2698
2698
  /**
2699
- * 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.
2699
+ * 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.
2700
2700
  */
2701
2701
  export const filterFilterSchema = z.discriminatedUnion("type", [
2702
2702
  brightnessfilterBrightnessFilterSchema,
@@ -2136,7 +2136,7 @@ export const pixelatefilterPixelateFilterSchema = z.object({
2136
2136
  export const pixelateFilterSchema = pixelatefilterPixelateFilterSchema;
2137
2137
 
2138
2138
  /**
2139
- * Offsets the red and blue channels in opposite directions to create a color fringing effect.
2139
+ * 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.
2140
2140
  */
2141
2141
  export const rgbsplitfilterRgbSplitFilterSchema = z.object({
2142
2142
  type: z.enum(['rgbSplit']),
@@ -2195,7 +2195,7 @@ export const sharpenfilterSharpenFilterSchema = z.object({
2195
2195
  export const sharpenFilterSchema = sharpenfilterSharpenFilterSchema;
2196
2196
 
2197
2197
  /**
2198
- * 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.
2198
+ * 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.
2199
2199
  */
2200
2200
  export const filterFilterSchema = z.discriminatedUnion("type", [
2201
2201
  brightnessfilterBrightnessFilterSchema,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shotstack/schemas",
3
- "version": "1.24.0-beta.2",
3
+ "version": "1.25.0",
4
4
  "description": "Centralized OpenAPI schemas and TypeScript types for Shotstack API",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",