@shotstack/schemas 1.23.1 → 1.23.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.
- package/dist/api.bundled.json +12 -12
- package/dist/json-schema/edit.json +12 -12
- package/dist/json-schema/index.cjs +1 -1
- package/dist/json-schema/index.js +1 -1
- package/dist/schema.d.ts +23 -21
- package/dist/zod/zod.gen.cjs +2 -0
- package/dist/zod/zod.gen.d.ts +2 -0
- package/dist/zod/zod.gen.js +2 -0
- package/dist/zod/zod.gen.ts +2 -0
- package/package.json +1 -1
package/dist/api.bundled.json
CHANGED
|
@@ -2682,7 +2682,7 @@
|
|
|
2682
2682
|
"type": "object",
|
|
2683
2683
|
"properties": {
|
|
2684
2684
|
"style": {
|
|
2685
|
-
"description": "The animation style to apply to words: <ul>\n <li>`karaoke` - Word-by-word color fill as spoken (shows all words, highlights active)</li>\n <li>`highlight` - Word changes to active color when spoken (shows all words)</li>\n <li>`pop` - Each word scales up when active</li>\n <li>`fade` - Gradual opacity transition per word</li>\n <li>`slide` - Words slide in
|
|
2685
|
+
"description": "The animation style to apply to words: <ul>\n <li>`karaoke` - Word-by-word color fill as spoken (shows all words, highlights active)</li>\n <li>`highlight` - Word changes to active color when spoken (shows all words)</li>\n <li>`pop` - Each word scales up when active</li>\n <li>`fade` - Gradual opacity transition per word</li>\n <li>`slide` - Words slide in, travelling in `direction`</li>\n <li>`bounce` - Spring animation on word appearance</li>\n <li>`typewriter` - Words appear one by one and stay visible</li>\n <li>`none` - No animation, all words visible immediately</li>\n</ul>",
|
|
2686
2686
|
"type": "string",
|
|
2687
2687
|
"enum": [
|
|
2688
2688
|
"karaoke",
|
|
@@ -2698,7 +2698,7 @@
|
|
|
2698
2698
|
"example": "highlight"
|
|
2699
2699
|
},
|
|
2700
2700
|
"direction": {
|
|
2701
|
-
"description": "
|
|
2701
|
+
"description": "The direction words travel when style is `slide`.",
|
|
2702
2702
|
"type": "string",
|
|
2703
2703
|
"enum": [
|
|
2704
2704
|
"left",
|
|
@@ -3105,7 +3105,7 @@
|
|
|
3105
3105
|
"description": "In and out transitions for a clip - i.e. fade in and fade out",
|
|
3106
3106
|
"properties": {
|
|
3107
3107
|
"in": {
|
|
3108
|
-
"description": "The transition in. Available transitions are:\n <ul>\n <li>`fade` - fade in</li>\n <li>`reveal` - reveal from left to right</li>\n <li>`wipeLeft` - fade across screen to the left</li>\n <li>`wipeRight` - fade across screen to the right</li>\n <li>`slideLeft` - move slightly left and fade in</li>\n <li>`slideRight` - move slightly right and fade in</li>\n <li>`slideUp` - move slightly up and fade in</li>\n <li>`slideDown` - move slightly down and fade in</li>\n <li>`carouselLeft` - slide in from right to left</li>\n <li>`carouselRight` - slide in from left to right</li>\n <li>`carouselUp` - slide in from bottom to top</li>\n <li>`carouselDown` - slide in from top to bottom</li>\n <li>`shuffleTopRight` - rotate in from top right</li>\n <li>`shuffleRightTop` - rotate in from right top</li>\n <li>`shuffleRightBottom` - rotate in from right bottom</li>\n <li>`shuffleBottomRight` - rotate in from bottom right</li>\n <li>`shuffleBottomLeft` - rotate in from bottom left</li>\n <li>`shuffleLeftBottom` - rotate in from left bottom</li>\n <li>`shuffleLeftTop` - rotate in from left top</li>\n <li>`shuffleTopLeft` - rotate in from top left</li>\n <li>`zoom` - fast zoom in</li>\n </ul>\nThe transition speed can also be controlled by appending `Fast` or `Slow` to
|
|
3108
|
+
"description": "The transition in. Available transitions are:\n <ul>\n <li>`fade` - fade in</li>\n <li>`reveal` - reveal from left to right</li>\n <li>`wipeLeft` - fade across screen to the left</li>\n <li>`wipeRight` - fade across screen to the right</li>\n <li>`slideLeft` - move slightly left and fade in</li>\n <li>`slideRight` - move slightly right and fade in</li>\n <li>`slideUp` - move slightly up and fade in</li>\n <li>`slideDown` - move slightly down and fade in</li>\n <li>`carouselLeft` - slide in from right to left</li>\n <li>`carouselRight` - slide in from left to right</li>\n <li>`carouselUp` - slide in from bottom to top</li>\n <li>`carouselDown` - slide in from top to bottom</li>\n <li>`shuffleTopRight` - rotate in from top right</li>\n <li>`shuffleRightTop` - rotate in from right top</li>\n <li>`shuffleRightBottom` - rotate in from right bottom</li>\n <li>`shuffleBottomRight` - rotate in from bottom right</li>\n <li>`shuffleBottomLeft` - rotate in from bottom left</li>\n <li>`shuffleLeftBottom` - rotate in from left bottom</li>\n <li>`shuffleLeftTop` - rotate in from left top</li>\n <li>`shuffleTopLeft` - rotate in from top left</li>\n <li>`zoom` - fast zoom in</li>\n </ul>\nThe transition speed can also be controlled by appending `Fast` or `Slow` to any transition except `zoom`, e.g. `fadeFast` or `carouselLeftSlow`.",
|
|
3109
3109
|
"enum": [
|
|
3110
3110
|
"none",
|
|
3111
3111
|
"fade",
|
|
@@ -3173,7 +3173,7 @@
|
|
|
3173
3173
|
"type": "string"
|
|
3174
3174
|
},
|
|
3175
3175
|
"out": {
|
|
3176
|
-
"description": "The transition out. Available transitions are:\n <ul>\n <li>`fade` - fade out</li>\n <li>`reveal` - reveal from right to left</li>\n <li>`wipeLeft` - fade across screen to the left</li>\n <li>`wipeRight` - fade across screen to the right</li>\n <li>`slideLeft` - move slightly left and fade out</li>\n <li>`slideRight` - move slightly right and fade out</li>\n <li>`slideUp` - move slightly up and fade out</li>\n <li>`slideDown` - move slightly down and fade out</li>\n <li>`carouselLeft` - slide out from right to left</li>\n <li>`carouselRight` - slide out from left to right</li>\n <li>`carouselUp` - slide out from bottom to top</li>\n <li>`carouselDown` - slide out from top to bottom</li>\n <li>`shuffleTopRight` - rotate out from top right</li>\n <li>`shuffleRightTop` - rotate out from right top</li>\n <li>`shuffleRightBottom` - rotate out from right bottom</li>\n <li>`shuffleBottomRight` - rotate out from bottom right</li>\n <li>`shuffleBottomLeft` - rotate out from bottom left</li>\n <li>`shuffleLeftBottom` - rotate out from left bottom</li>\n <li>`shuffleLeftTop` - rotate out from left top</li>\n <li>`shuffleTopLeft` - rotate out from top left</li>\n <li>`zoom` - fast zoom out</li>\n </ul>\nThe transition speed can also be controlled by appending `Fast` or `Slow` to
|
|
3176
|
+
"description": "The transition out. Available transitions are:\n <ul>\n <li>`fade` - fade out</li>\n <li>`reveal` - reveal from right to left</li>\n <li>`wipeLeft` - fade across screen to the left</li>\n <li>`wipeRight` - fade across screen to the right</li>\n <li>`slideLeft` - move slightly left and fade out</li>\n <li>`slideRight` - move slightly right and fade out</li>\n <li>`slideUp` - move slightly up and fade out</li>\n <li>`slideDown` - move slightly down and fade out</li>\n <li>`carouselLeft` - slide out from right to left</li>\n <li>`carouselRight` - slide out from left to right</li>\n <li>`carouselUp` - slide out from bottom to top</li>\n <li>`carouselDown` - slide out from top to bottom</li>\n <li>`shuffleTopRight` - rotate out from top right</li>\n <li>`shuffleRightTop` - rotate out from right top</li>\n <li>`shuffleRightBottom` - rotate out from right bottom</li>\n <li>`shuffleBottomRight` - rotate out from bottom right</li>\n <li>`shuffleBottomLeft` - rotate out from bottom left</li>\n <li>`shuffleLeftBottom` - rotate out from left bottom</li>\n <li>`shuffleLeftTop` - rotate out from left top</li>\n <li>`shuffleTopLeft` - rotate out from top left</li>\n <li>`zoom` - fast zoom out</li>\n </ul>\nThe transition speed can also be controlled by appending `Fast` or `Slow` to any transition except `zoom`, e.g. `fadeFast` or `carouselLeftSlow`.",
|
|
3177
3177
|
"enum": [
|
|
3178
3178
|
"none",
|
|
3179
3179
|
"fade",
|
|
@@ -3852,7 +3852,7 @@
|
|
|
3852
3852
|
"description": "Animation properties for text entrance effects.",
|
|
3853
3853
|
"properties": {
|
|
3854
3854
|
"preset": {
|
|
3855
|
-
"description": "The animation preset to apply. Available presets: <ul>\n <li>`fadeIn` -
|
|
3855
|
+
"description": "The animation preset to apply. Every preset starts with the clip. Available presets: <ul>\n <li>`fadeIn` - fade in</li>\n <li>`slideIn` - fade in while sliding in `direction`</li>\n <li>`typewriter` - type the text out behind a cursor</li>\n <li>`ascend` - each word rises (`up`) or drops (`down`) into place</li>\n <li>`shift` - fade in while shifting a short distance in `direction`</li>\n <li>`movingLetters` - fade in, then ripple the letters along `direction` for the rest of the clip. Ignores `duration` and `style`.</li>\n</ul>",
|
|
3856
3856
|
"type": "string",
|
|
3857
3857
|
"enum": [
|
|
3858
3858
|
"fadeIn",
|
|
@@ -3865,14 +3865,14 @@
|
|
|
3865
3865
|
"example": "shift"
|
|
3866
3866
|
},
|
|
3867
3867
|
"duration": {
|
|
3868
|
-
"description": "Override animation duration in seconds. Must be between 0.1 and 30 seconds.",
|
|
3868
|
+
"description": "Override animation duration in seconds. Must be between 0.1 and 30 seconds. When omitted, the text animates at about 30 characters per second, taking at least 0.3 seconds and at most 90% of the clip.",
|
|
3869
3869
|
"type": "number",
|
|
3870
3870
|
"minimum": 0.1,
|
|
3871
3871
|
"maximum": 30,
|
|
3872
3872
|
"example": 2
|
|
3873
3873
|
},
|
|
3874
3874
|
"style": {
|
|
3875
|
-
"description": "
|
|
3875
|
+
"description": "Animate by character or by word. Applies to `fadeIn`, `slideIn`, `typewriter` and `shift`, where `shift` defaults to `character`. `ascend` always animates by word.",
|
|
3876
3876
|
"type": "string",
|
|
3877
3877
|
"enum": [
|
|
3878
3878
|
"character",
|
|
@@ -3881,7 +3881,7 @@
|
|
|
3881
3881
|
"example": "character"
|
|
3882
3882
|
},
|
|
3883
3883
|
"direction": {
|
|
3884
|
-
"description": "
|
|
3884
|
+
"description": "The direction the text travels. Defaults to `left` for `slideIn` and `shift`, and to `up` for `ascend` and `movingLetters`. <ul>\n <li>`ascend` - supports: up, down</li>\n <li>`shift` - supports: left, right, up, down</li>\n <li>`slideIn` - supports: left, right, up, down</li>\n <li>`movingLetters` - supports: left, right, up, down</li>\n</ul>",
|
|
3885
3885
|
"type": "string",
|
|
3886
3886
|
"enum": [
|
|
3887
3887
|
"left",
|
|
@@ -4091,7 +4091,7 @@
|
|
|
4091
4091
|
"type": "object"
|
|
4092
4092
|
},
|
|
4093
4093
|
"Tween": {
|
|
4094
|
-
"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>",
|
|
4094
|
+
"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>Scale - animate the size 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 <li>Speed - animate the playback speed of a video clip.</li>\n </ul>",
|
|
4095
4095
|
"properties": {
|
|
4096
4096
|
"from": {
|
|
4097
4097
|
"description": "The initial property value at the start of the animation.",
|
|
@@ -4196,7 +4196,7 @@
|
|
|
4196
4196
|
"example": "mp4"
|
|
4197
4197
|
},
|
|
4198
4198
|
"resolution": {
|
|
4199
|
-
"description": "The preset output resolution of the video or image. For custom sizes use the `size` property. Either `resolution` or `size` (with both `width` and `height`) must be specified for all formats except `mp3`. <ul>\n <li>`preview` - 512px x 288px @
|
|
4199
|
+
"description": "The preset output resolution of the video or image. For custom sizes use the `size` property. Either `resolution` or `size` (with both `width` and `height`) must be specified for all formats except `mp3`. <ul>\n <li>`preview` - 512px x 288px @ 12fps</li>\n <li>`mobile` - 640px x 360px @ 25fps</li>\n <li>`sd` - 1024px x 576px @ 25fps</li>\n <li>`hd` - 1280px x 720px @ 25fps</li>\n <li>`1080` - 1920px x 1080px @ 25fps</li>\n <li>`4k` - 3840px x 2160px @ 25fps</li>\n</ul>",
|
|
4200
4200
|
"enum": [
|
|
4201
4201
|
"preview",
|
|
4202
4202
|
"mobile",
|
|
@@ -4224,7 +4224,7 @@
|
|
|
4224
4224
|
"$ref": "#/components/schemas/Size"
|
|
4225
4225
|
},
|
|
4226
4226
|
"fps": {
|
|
4227
|
-
"description": "Override the default frames per second. Useful for when the source footage is recorded at 30fps, i.e. on mobile devices. Lower frame rates can be used to add cinematic quality (24fps) or to create smaller file size/faster render times or animated gifs (12 or 15fps). Default is 25fps. <ul>\n <li>`12` - 12fps</li>\n <li>`15` - 15fps</li>\n <li>`24` - 24fps</li>\n <li>`23.976` - 23.976fps</li>\n <li>`25` (default) - 25fps</li>\n <li>`29.97` - 29.97fps</li>\n <li>`30` - 30fps</li>\n <li>`48` - 48fps</li>\n <li>`50` - 50fps</li>\n <li>`59.94` - 59.94fps</li>\n <li>`60` - 60fps</li>\n</ul>",
|
|
4227
|
+
"description": "Override the default frames per second. Useful for when the source footage is recorded at 30fps, i.e. on mobile devices. Lower frame rates can be used to add cinematic quality (24fps) or to create smaller file size/faster render times or animated gifs (12 or 15fps). Default is 25fps, or 12fps for the `preview` resolution. <ul>\n <li>`12` - 12fps</li>\n <li>`15` - 15fps</li>\n <li>`24` - 24fps</li>\n <li>`23.976` - 23.976fps</li>\n <li>`25` (default) - 25fps</li>\n <li>`29.97` - 29.97fps</li>\n <li>`30` - 30fps</li>\n <li>`48` - 48fps</li>\n <li>`50` - 50fps</li>\n <li>`59.94` - 59.94fps</li>\n <li>`60` - 60fps</li>\n</ul>",
|
|
4228
4228
|
"enum": [
|
|
4229
4229
|
12,
|
|
4230
4230
|
15,
|
|
@@ -4242,7 +4242,7 @@
|
|
|
4242
4242
|
"example": 25
|
|
4243
4243
|
},
|
|
4244
4244
|
"scaleTo": {
|
|
4245
|
-
"description": "Override the resolution and scale the video or image to render at a different size. When using scaleTo the asset should be edited at the resolution dimensions, i.e. use font sizes that look best at HD, then use scaleTo to output the file at SD and the text will be scaled to the correct size. This is useful if you want to create multiple asset sizes. <ul>\n <li>`preview` - 512px x 288px
|
|
4245
|
+
"description": "Override the resolution and scale the video or image to render at a different size. When using scaleTo the asset should be edited at the resolution dimensions, i.e. use font sizes that look best at HD, then use scaleTo to output the file at SD and the text will be scaled to the correct size. This is useful if you want to create multiple asset sizes. <ul>\n <li>`preview` - 512px x 288px</li>\n <li>`mobile` - 640px x 360px</li>\n <li>`sd` - 1024px x 576px</li>\n <li>`hd` - 1280px x 720px</li>\n <li>`1080` - 1920px x 1080px</li>\n</ul>",
|
|
4246
4246
|
"enum": [
|
|
4247
4247
|
"preview",
|
|
4248
4248
|
"mobile",
|
|
@@ -1385,7 +1385,7 @@
|
|
|
1385
1385
|
]
|
|
1386
1386
|
},
|
|
1387
1387
|
"resolution": {
|
|
1388
|
-
"description": "The preset output resolution of the video or image. For custom sizes use the `size` property. Either `resolution` or `size` (with both `width` and `height`) must be specified for all formats except `mp3`.\n\n- `preview` - 512px x 288px @
|
|
1388
|
+
"description": "The preset output resolution of the video or image. For custom sizes use the `size` property. Either `resolution` or `size` (with both `width` and `height`) must be specified for all formats except `mp3`.\n\n- `preview` - 512px x 288px @ 12fps\n\n- `mobile` - 640px x 360px @ 25fps\n\n- `sd` - 1024px x 576px @ 25fps\n\n- `hd` - 1280px x 720px @ 25fps\n\n- `1080` - 1920px x 1080px @ 25fps\n\n- `4k` - 3840px x 2160px @ 25fps",
|
|
1389
1389
|
"enum": [
|
|
1390
1390
|
"preview",
|
|
1391
1391
|
"mobile",
|
|
@@ -1417,7 +1417,7 @@
|
|
|
1417
1417
|
"$ref": "#/$defs/Size"
|
|
1418
1418
|
},
|
|
1419
1419
|
"fps": {
|
|
1420
|
-
"description": "Override the default frames per second. Useful for when the source footage is recorded at 30fps, i.e. on mobile devices. Lower frame rates can be used to add cinematic quality (24fps) or to create smaller file size/faster render times or animated gifs (12 or 15fps). Default is 25fps.\n\n- `12` - 12fps\n\n- `15` - 15fps\n\n- `24` - 24fps\n\n- `23.976` - 23.976fps\n\n- `25` (default) - 25fps\n\n- `29.97` - 29.97fps\n\n- `30` - 30fps\n\n- `48` - 48fps\n\n- `50` - 50fps\n\n- `59.94` - 59.94fps\n\n- `60` - 60fps",
|
|
1420
|
+
"description": "Override the default frames per second. Useful for when the source footage is recorded at 30fps, i.e. on mobile devices. Lower frame rates can be used to add cinematic quality (24fps) or to create smaller file size/faster render times or animated gifs (12 or 15fps). Default is 25fps, or 12fps for the `preview` resolution.\n\n- `12` - 12fps\n\n- `15` - 15fps\n\n- `24` - 24fps\n\n- `23.976` - 23.976fps\n\n- `25` (default) - 25fps\n\n- `29.97` - 29.97fps\n\n- `30` - 30fps\n\n- `48` - 48fps\n\n- `50` - 50fps\n\n- `59.94` - 59.94fps\n\n- `60` - 60fps",
|
|
1421
1421
|
"enum": [
|
|
1422
1422
|
12,
|
|
1423
1423
|
15,
|
|
@@ -1437,7 +1437,7 @@
|
|
|
1437
1437
|
]
|
|
1438
1438
|
},
|
|
1439
1439
|
"scaleTo": {
|
|
1440
|
-
"description": "Override the resolution and scale the video or image to render at a different size. When using scaleTo the asset should be edited at the resolution dimensions, i.e. use font sizes that look best at HD, then use scaleTo to output the file at SD and the text will be scaled to the correct size. This is useful if you want to create multiple asset sizes.\n\n- `preview` - 512px x 288px
|
|
1440
|
+
"description": "Override the resolution and scale the video or image to render at a different size. When using scaleTo the asset should be edited at the resolution dimensions, i.e. use font sizes that look best at HD, then use scaleTo to output the file at SD and the text will be scaled to the correct size. This is useful if you want to create multiple asset sizes.\n\n- `preview` - 512px x 288px\n\n- `mobile` - 640px x 360px\n\n- `sd` - 1024px x 576px\n\n- `hd` - 1280px x 720px\n\n- `1080` - 1920px x 1080px",
|
|
1441
1441
|
"enum": [
|
|
1442
1442
|
"preview",
|
|
1443
1443
|
"mobile",
|
|
@@ -1651,7 +1651,7 @@
|
|
|
1651
1651
|
"type": "object",
|
|
1652
1652
|
"properties": {
|
|
1653
1653
|
"style": {
|
|
1654
|
-
"description": "The animation style to apply to words:\n\n- `karaoke` - Word-by-word color fill as spoken (shows all words, highlights active)\n\n- `highlight` - Word changes to active color when spoken (shows all words)\n\n- `pop` - Each word scales up when active\n\n- `fade` - Gradual opacity transition per word\n\n- `slide` - Words slide in
|
|
1654
|
+
"description": "The animation style to apply to words:\n\n- `karaoke` - Word-by-word color fill as spoken (shows all words, highlights active)\n\n- `highlight` - Word changes to active color when spoken (shows all words)\n\n- `pop` - Each word scales up when active\n\n- `fade` - Gradual opacity transition per word\n\n- `slide` - Words slide in, travelling in `direction`\n\n- `bounce` - Spring animation on word appearance\n\n- `typewriter` - Words appear one by one and stay visible\n\n- `none` - No animation, all words visible immediately",
|
|
1655
1655
|
"type": "string",
|
|
1656
1656
|
"enum": [
|
|
1657
1657
|
"karaoke",
|
|
@@ -1669,7 +1669,7 @@
|
|
|
1669
1669
|
]
|
|
1670
1670
|
},
|
|
1671
1671
|
"direction": {
|
|
1672
|
-
"description": "
|
|
1672
|
+
"description": "The direction words travel when style is `slide`.",
|
|
1673
1673
|
"type": "string",
|
|
1674
1674
|
"enum": [
|
|
1675
1675
|
"left",
|
|
@@ -1929,7 +1929,7 @@
|
|
|
1929
1929
|
"description": "Animation properties for text entrance effects.",
|
|
1930
1930
|
"properties": {
|
|
1931
1931
|
"preset": {
|
|
1932
|
-
"description": "The animation preset to apply. Available presets:\n\n- `fadeIn` -
|
|
1932
|
+
"description": "The animation preset to apply. Every preset starts with the clip. Available presets:\n\n- `fadeIn` - fade in\n\n- `slideIn` - fade in while sliding in `direction`\n\n- `typewriter` - type the text out behind a cursor\n\n- `ascend` - each word rises (`up`) or drops (`down`) into place\n\n- `shift` - fade in while shifting a short distance in `direction`\n\n- `movingLetters` - fade in, then ripple the letters along `direction` for the rest of the clip. Ignores `duration` and `style`.",
|
|
1933
1933
|
"type": "string",
|
|
1934
1934
|
"enum": [
|
|
1935
1935
|
"fadeIn",
|
|
@@ -1944,7 +1944,7 @@
|
|
|
1944
1944
|
]
|
|
1945
1945
|
},
|
|
1946
1946
|
"duration": {
|
|
1947
|
-
"description": "Override animation duration in seconds. Must be between 0.1 and 30 seconds.",
|
|
1947
|
+
"description": "Override animation duration in seconds. Must be between 0.1 and 30 seconds. When omitted, the text animates at about 30 characters per second, taking at least 0.3 seconds and at most 90% of the clip.",
|
|
1948
1948
|
"type": "number",
|
|
1949
1949
|
"minimum": 0.1,
|
|
1950
1950
|
"maximum": 30,
|
|
@@ -1953,7 +1953,7 @@
|
|
|
1953
1953
|
]
|
|
1954
1954
|
},
|
|
1955
1955
|
"style": {
|
|
1956
|
-
"description": "
|
|
1956
|
+
"description": "Animate by character or by word. Applies to `fadeIn`, `slideIn`, `typewriter` and `shift`, where `shift` defaults to `character`. `ascend` always animates by word.",
|
|
1957
1957
|
"type": "string",
|
|
1958
1958
|
"enum": [
|
|
1959
1959
|
"character",
|
|
@@ -1964,7 +1964,7 @@
|
|
|
1964
1964
|
]
|
|
1965
1965
|
},
|
|
1966
1966
|
"direction": {
|
|
1967
|
-
"description": "
|
|
1967
|
+
"description": "The direction the text travels. Defaults to `left` for `slideIn` and `shift`, and to `up` for `ascend` and `movingLetters`.\n\n- `ascend` - supports: up, down\n\n- `shift` - supports: left, right, up, down\n\n- `slideIn` - supports: left, right, up, down\n\n- `movingLetters` - supports: left, right, up, down",
|
|
1968
1968
|
"type": "string",
|
|
1969
1969
|
"enum": [
|
|
1970
1970
|
"left",
|
|
@@ -3468,7 +3468,7 @@
|
|
|
3468
3468
|
"description": "In and out transitions for a clip - i.e. fade in and fade out",
|
|
3469
3469
|
"properties": {
|
|
3470
3470
|
"in": {
|
|
3471
|
-
"description": "The transition in. Available transitions are:\n\n- `fade` - fade in\n\n- `reveal` - reveal from left to right\n\n- `wipeLeft` - fade across screen to the left\n\n- `wipeRight` - fade across screen to the right\n\n- `slideLeft` - move slightly left and fade in\n\n- `slideRight` - move slightly right and fade in\n\n- `slideUp` - move slightly up and fade in\n\n- `slideDown` - move slightly down and fade in\n\n- `carouselLeft` - slide in from right to left\n\n- `carouselRight` - slide in from left to right\n\n- `carouselUp` - slide in from bottom to top\n\n- `carouselDown` - slide in from top to bottom\n\n- `shuffleTopRight` - rotate in from top right\n\n- `shuffleRightTop` - rotate in from right top\n\n- `shuffleRightBottom` - rotate in from right bottom\n\n- `shuffleBottomRight` - rotate in from bottom right\n\n- `shuffleBottomLeft` - rotate in from bottom left\n\n- `shuffleLeftBottom` - rotate in from left bottom\n\n- `shuffleLeftTop` - rotate in from left top\n\n- `shuffleTopLeft` - rotate in from top left\n\n- `zoom` - fast zoom in\n\nThe transition speed can also be controlled by appending `Fast` or `Slow` to
|
|
3471
|
+
"description": "The transition in. Available transitions are:\n\n- `fade` - fade in\n\n- `reveal` - reveal from left to right\n\n- `wipeLeft` - fade across screen to the left\n\n- `wipeRight` - fade across screen to the right\n\n- `slideLeft` - move slightly left and fade in\n\n- `slideRight` - move slightly right and fade in\n\n- `slideUp` - move slightly up and fade in\n\n- `slideDown` - move slightly down and fade in\n\n- `carouselLeft` - slide in from right to left\n\n- `carouselRight` - slide in from left to right\n\n- `carouselUp` - slide in from bottom to top\n\n- `carouselDown` - slide in from top to bottom\n\n- `shuffleTopRight` - rotate in from top right\n\n- `shuffleRightTop` - rotate in from right top\n\n- `shuffleRightBottom` - rotate in from right bottom\n\n- `shuffleBottomRight` - rotate in from bottom right\n\n- `shuffleBottomLeft` - rotate in from bottom left\n\n- `shuffleLeftBottom` - rotate in from left bottom\n\n- `shuffleLeftTop` - rotate in from left top\n\n- `shuffleTopLeft` - rotate in from top left\n\n- `zoom` - fast zoom in\n\nThe transition speed can also be controlled by appending `Fast` or `Slow` to any transition except `zoom`, e.g. `fadeFast` or `carouselLeftSlow`.",
|
|
3472
3472
|
"enum": [
|
|
3473
3473
|
"none",
|
|
3474
3474
|
"fade",
|
|
@@ -3536,7 +3536,7 @@
|
|
|
3536
3536
|
"type": "string"
|
|
3537
3537
|
},
|
|
3538
3538
|
"out": {
|
|
3539
|
-
"description": "The transition out. Available transitions are:\n\n- `fade` - fade out\n\n- `reveal` - reveal from right to left\n\n- `wipeLeft` - fade across screen to the left\n\n- `wipeRight` - fade across screen to the right\n\n- `slideLeft` - move slightly left and fade out\n\n- `slideRight` - move slightly right and fade out\n\n- `slideUp` - move slightly up and fade out\n\n- `slideDown` - move slightly down and fade out\n\n- `carouselLeft` - slide out from right to left\n\n- `carouselRight` - slide out from left to right\n\n- `carouselUp` - slide out from bottom to top\n\n- `carouselDown` - slide out from top to bottom\n\n- `shuffleTopRight` - rotate out from top right\n\n- `shuffleRightTop` - rotate out from right top\n\n- `shuffleRightBottom` - rotate out from right bottom\n\n- `shuffleBottomRight` - rotate out from bottom right\n\n- `shuffleBottomLeft` - rotate out from bottom left\n\n- `shuffleLeftBottom` - rotate out from left bottom\n\n- `shuffleLeftTop` - rotate out from left top\n\n- `shuffleTopLeft` - rotate out from top left\n\n- `zoom` - fast zoom out\n\nThe transition speed can also be controlled by appending `Fast` or `Slow` to
|
|
3539
|
+
"description": "The transition out. Available transitions are:\n\n- `fade` - fade out\n\n- `reveal` - reveal from right to left\n\n- `wipeLeft` - fade across screen to the left\n\n- `wipeRight` - fade across screen to the right\n\n- `slideLeft` - move slightly left and fade out\n\n- `slideRight` - move slightly right and fade out\n\n- `slideUp` - move slightly up and fade out\n\n- `slideDown` - move slightly down and fade out\n\n- `carouselLeft` - slide out from right to left\n\n- `carouselRight` - slide out from left to right\n\n- `carouselUp` - slide out from bottom to top\n\n- `carouselDown` - slide out from top to bottom\n\n- `shuffleTopRight` - rotate out from top right\n\n- `shuffleRightTop` - rotate out from right top\n\n- `shuffleRightBottom` - rotate out from right bottom\n\n- `shuffleBottomRight` - rotate out from bottom right\n\n- `shuffleBottomLeft` - rotate out from bottom left\n\n- `shuffleLeftBottom` - rotate out from left bottom\n\n- `shuffleLeftTop` - rotate out from left top\n\n- `shuffleTopLeft` - rotate out from top left\n\n- `zoom` - fast zoom out\n\nThe transition speed can also be controlled by appending `Fast` or `Slow` to any transition except `zoom`, e.g. `fadeFast` or `carouselLeftSlow`.",
|
|
3540
3540
|
"enum": [
|
|
3541
3541
|
"none",
|
|
3542
3542
|
"fade",
|
|
@@ -3608,7 +3608,7 @@
|
|
|
3608
3608
|
"type": "object"
|
|
3609
3609
|
},
|
|
3610
3610
|
"Tween": {
|
|
3611
|
-
"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\n- Opacity - animate the transparency of a clip.\n\n- Offset - animate the x and y position of a clip.\n\n- Rotation - animate the rotation of a clip.\n\n- Skew - animate the horizontal and vertical shearing effect.\n\n- Volume - animate the audio volume of a clip.",
|
|
3611
|
+
"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\n- Opacity - animate the transparency of a clip.\n\n- Offset - animate the x and y position of a clip.\n\n- Scale - animate the size of a clip.\n\n- Rotation - animate the rotation of a clip.\n\n- Skew - animate the horizontal and vertical shearing effect.\n\n- Volume - animate the audio volume of a clip.\n\n- Speed - animate the playback speed of a video clip.",
|
|
3612
3612
|
"properties": {
|
|
3613
3613
|
"from": {
|
|
3614
3614
|
"description": "The initial property value at the start of the animation.",
|