@cesdk/node 1.64.0-nightly.20251030 → 1.64.0-nightly.20251104
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/assets/core/{cesdk-v1.64.0-nightly.20251030-U3354BGP.wasm → cesdk-v1.64.0-nightly.20251104-RE4TDMG6.wasm} +0 -0
- package/index.d.ts +549 -346
- package/index.js +1 -1
- package/package.json +1 -1
- /package/assets/core/{cesdk-v1.64.0-nightly.20251030-44YCFRT6.data → cesdk-v1.64.0-nightly.20251104-44YCFRT6.data} +0 -0
package/index.d.ts
CHANGED
|
@@ -62,10 +62,29 @@ export declare interface AddVideoOptions {
|
|
|
62
62
|
}
|
|
63
63
|
|
|
64
64
|
/**
|
|
65
|
-
* The
|
|
65
|
+
* The shorthand block type IDs for the animation blocks. These are the IDs used to create new animations
|
|
66
|
+
* using `cesdk.engine.block.createAnimation(id)`.
|
|
66
67
|
* @public
|
|
67
68
|
*/
|
|
68
|
-
export declare
|
|
69
|
+
export declare const ANIMATION_TYPES: readonly ["slide", "pan", "fade", "blur", "grow", "zoom", "pop", "wipe", "baseline", "crop_zoom", "spin", "spin_loop", "fade_loop", "blur_loop", "pulsating_loop", "breathing_loop", "jump_loop", "squeeze_loop", "sway_loop", "typewriter_text", "block_swipe_text", "spread_text", "merge_text", "ken_burns"];
|
|
70
|
+
|
|
71
|
+
/** @public */
|
|
72
|
+
export declare type AnimationBaselineDirection = (typeof AnimationBaselineDirectionValues)[number];
|
|
73
|
+
|
|
74
|
+
/** @public */
|
|
75
|
+
export declare const AnimationBaselineDirectionValues: readonly ["Up", "Right", "Down", "Left"];
|
|
76
|
+
|
|
77
|
+
/** @public */
|
|
78
|
+
export declare type AnimationBlockSwipeTextDirection = (typeof AnimationBlockSwipeTextDirectionValues)[number];
|
|
79
|
+
|
|
80
|
+
/** @public */
|
|
81
|
+
export declare const AnimationBlockSwipeTextDirectionValues: readonly ["Up", "Right", "Down", "Left"];
|
|
82
|
+
|
|
83
|
+
/** @public */
|
|
84
|
+
export declare type AnimationEasing = (typeof AnimationEasingValues)[number];
|
|
85
|
+
|
|
86
|
+
/** @public */
|
|
87
|
+
export declare const AnimationEasingValues: readonly ["Linear", "EaseIn", "EaseOut", "EaseInOut", "EaseInQuart", "EaseOutQuart", "EaseInOutQuart", "EaseInQuint", "EaseOutQuint", "EaseInOutQuint", "EaseInBack", "EaseOutBack", "EaseInOutBack", "EaseInSpring", "EaseOutSpring", "EaseInOutSpring"];
|
|
69
88
|
|
|
70
89
|
/**
|
|
71
90
|
* Configuration options for animations.
|
|
@@ -80,6 +99,30 @@ export declare type AnimationEntry = {
|
|
|
80
99
|
easing?: AnimationEasing;
|
|
81
100
|
};
|
|
82
101
|
|
|
102
|
+
/** @public */
|
|
103
|
+
export declare type AnimationGrowDirection = (typeof AnimationGrowDirectionValues)[number];
|
|
104
|
+
|
|
105
|
+
/** @public */
|
|
106
|
+
export declare const AnimationGrowDirectionValues: readonly ["Horizontal", "Vertical", "All"];
|
|
107
|
+
|
|
108
|
+
/** @public */
|
|
109
|
+
export declare type AnimationJumpLoopDirection = (typeof AnimationJumpLoopDirectionValues)[number];
|
|
110
|
+
|
|
111
|
+
/** @public */
|
|
112
|
+
export declare const AnimationJumpLoopDirectionValues: readonly ["Up", "Right", "Down", "Left"];
|
|
113
|
+
|
|
114
|
+
/** @public */
|
|
115
|
+
export declare type AnimationKenBurnsDirection = (typeof AnimationKenBurnsDirectionValues)[number];
|
|
116
|
+
|
|
117
|
+
/** @public */
|
|
118
|
+
export declare const AnimationKenBurnsDirectionValues: readonly ["Up", "Right", "Down", "Left"];
|
|
119
|
+
|
|
120
|
+
/** @public */
|
|
121
|
+
export declare type AnimationMergeTextDirection = (typeof AnimationMergeTextDirectionValues)[number];
|
|
122
|
+
|
|
123
|
+
/** @public */
|
|
124
|
+
export declare const AnimationMergeTextDirectionValues: readonly ["Right", "Left"];
|
|
125
|
+
|
|
83
126
|
/**
|
|
84
127
|
* Options for configuring animations (in, loop, out animations).
|
|
85
128
|
* @public
|
|
@@ -93,6 +136,18 @@ export declare type AnimationOptions = {
|
|
|
93
136
|
out?: AnimationEntry;
|
|
94
137
|
};
|
|
95
138
|
|
|
139
|
+
/** @public */
|
|
140
|
+
export declare type AnimationSpinDirection = (typeof AnimationSpinDirectionValues)[number];
|
|
141
|
+
|
|
142
|
+
/** @public */
|
|
143
|
+
export declare const AnimationSpinDirectionValues: readonly ["Clockwise", "CounterClockwise"];
|
|
144
|
+
|
|
145
|
+
/** @public */
|
|
146
|
+
export declare type AnimationSpinLoopDirection = (typeof AnimationSpinLoopDirectionValues)[number];
|
|
147
|
+
|
|
148
|
+
/** @public */
|
|
149
|
+
export declare const AnimationSpinLoopDirectionValues: readonly ["Clockwise", "CounterClockwise"];
|
|
150
|
+
|
|
96
151
|
/**
|
|
97
152
|
* The block type IDs for the animation blocks. These are the IDs used to create new animations
|
|
98
153
|
* using `cesdk.engine.block.createAnimation(id)`.
|
|
@@ -108,12 +163,20 @@ export declare type AnimationType = AnimationTypeShorthand | AnimationTypeLongha
|
|
|
108
163
|
*/
|
|
109
164
|
export declare type AnimationTypeLonghand = `//ly.img.ubq/animation/${AnimationTypeShorthand}`;
|
|
110
165
|
|
|
111
|
-
/**
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
166
|
+
/** @public */
|
|
167
|
+
export declare type AnimationTypeShorthand = (typeof ANIMATION_TYPES)[number];
|
|
168
|
+
|
|
169
|
+
/** @public */
|
|
170
|
+
export declare type AnimationTypewriterTextWritingStyle = (typeof AnimationTypewriterTextWritingStyleValues)[number];
|
|
171
|
+
|
|
172
|
+
/** @public */
|
|
173
|
+
export declare const AnimationTypewriterTextWritingStyleValues: readonly ["Character", "Word"];
|
|
174
|
+
|
|
175
|
+
/** @public */
|
|
176
|
+
export declare type AnimationWipeDirection = (typeof AnimationWipeDirectionValues)[number];
|
|
177
|
+
|
|
178
|
+
/** @public */
|
|
179
|
+
export declare const AnimationWipeDirectionValues: readonly ["Up", "Right", "Down", "Left"];
|
|
117
180
|
|
|
118
181
|
/**
|
|
119
182
|
* Represents the application MIME types used in the editor.
|
|
@@ -820,7 +883,7 @@ export declare interface AssetFixedSize {
|
|
|
820
883
|
type: 'FixedSize';
|
|
821
884
|
width: number;
|
|
822
885
|
height: number;
|
|
823
|
-
designUnit:
|
|
886
|
+
designUnit: SceneDesignUnit;
|
|
824
887
|
}
|
|
825
888
|
|
|
826
889
|
/**
|
|
@@ -1240,42 +1303,11 @@ export declare interface AudioTrackInfo {
|
|
|
1240
1303
|
language: string;
|
|
1241
1304
|
}
|
|
1242
1305
|
|
|
1243
|
-
/**
|
|
1244
|
-
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
* - 'PassThrough': The layer or effect is not blended and is rendered as is.
|
|
1249
|
-
* - 'Normal': The layer or effect is blended normally.
|
|
1250
|
-
* - 'Darken': The layer or effect is blended to darken the underlying content.
|
|
1251
|
-
* - 'Multiply': The layer or effect is blended to multiply the underlying content.
|
|
1252
|
-
* - 'ColorBurn': The layer or effect is blended to burn the underlying content.
|
|
1253
|
-
* - 'LinearBurn': The layer or effect is blended to linearly burn the underlying content.
|
|
1254
|
-
* - 'DarkenColor': The layer or effect is blended to darken the underlying content based on color.
|
|
1255
|
-
* - 'Lighten': The layer or effect is blended to lighten the underlying content.
|
|
1256
|
-
* - 'Screen': The layer or effect is blended to screen the underlying content.
|
|
1257
|
-
* - 'ColorDodge': The layer or effect is blended to dodge the underlying content.
|
|
1258
|
-
* - 'LinearDodge': The layer or effect is blended to linearly dodge the underlying content.
|
|
1259
|
-
* - 'LightenColor': The layer or effect is blended to lighten the underlying content based on color.
|
|
1260
|
-
* - 'Overlay': The layer or effect is blended to overlay the underlying content.
|
|
1261
|
-
* - 'SoftLight': The layer or effect is blended to soft light the underlying content.
|
|
1262
|
-
* - 'HardLight': The layer or effect is blended to hard light the underlying content.
|
|
1263
|
-
* - 'VividLight': The layer or effect is blended to vivid light the underlying content.
|
|
1264
|
-
* - 'LinearLight': The layer or effect is blended to linearly light the underlying content.
|
|
1265
|
-
* - 'PinLight': The layer or effect is blended to pin light the underlying content.
|
|
1266
|
-
* - 'HardMix': The layer or effect is blended to hard mix the underlying content.
|
|
1267
|
-
* - 'Difference': The layer or effect is blended to difference the underlying content.
|
|
1268
|
-
* - 'Exclusion': The layer or effect is blended to exclude the underlying content.
|
|
1269
|
-
* - 'Subtract': The layer or effect is blended to subtract the underlying content.
|
|
1270
|
-
* - 'Divide': The layer or effect is blended to divide the underlying content.
|
|
1271
|
-
* - 'Hue': The layer or effect is blended to hue the underlying content.
|
|
1272
|
-
* - 'Saturation': The layer or effect is blended to saturate the underlying content.
|
|
1273
|
-
* - 'Color': The layer or effect is blended to color the underlying content.
|
|
1274
|
-
* - 'Luminosity': The layer or effect is blended to luminosity the underlying content.
|
|
1275
|
-
*
|
|
1276
|
-
* @public
|
|
1277
|
-
*/
|
|
1278
|
-
export declare type BlendMode = 'PassThrough' | 'Normal' | 'Darken' | 'Multiply' | 'ColorBurn' | 'LinearBurn' | 'DarkenColor' | 'Lighten' | 'Screen' | 'ColorDodge' | 'LinearDodge' | 'LightenColor' | 'Overlay' | 'SoftLight' | 'HardLight' | 'VividLight' | 'LinearLight' | 'PinLight' | 'HardMix' | 'Difference' | 'Exclusion' | 'Subtract' | 'Divide' | 'Hue' | 'Saturation' | 'Color' | 'Luminosity';
|
|
1306
|
+
/** @public */
|
|
1307
|
+
export declare type BlendMode = (typeof BlendModeValues)[number];
|
|
1308
|
+
|
|
1309
|
+
/** @public */
|
|
1310
|
+
export declare const BlendModeValues: readonly ["PassThrough", "Normal", "Darken", "Multiply", "ColorBurn", "LinearBurn", "DarkenColor", "Lighten", "Screen", "ColorDodge", "LinearDodge", "LightenColor", "Overlay", "SoftLight", "HardLight", "VividLight", "LinearLight", "PinLight", "HardMix", "Difference", "Exclusion", "Subtract", "Divide", "Hue", "Saturation", "Color", "Luminosity"];
|
|
1279
1311
|
|
|
1280
1312
|
/**
|
|
1281
1313
|
* Create, manipulate, and query the building blocks of your design.
|
|
@@ -2069,7 +2101,7 @@ export declare class BlockAPI {
|
|
|
2069
2101
|
* @param id - The block to query.
|
|
2070
2102
|
* @returns The current mode for the x position: 'Absolute' or 'Percent'.
|
|
2071
2103
|
*/
|
|
2072
|
-
getPositionXMode(id: DesignBlockId):
|
|
2104
|
+
getPositionXMode(id: DesignBlockId): PositionXMode;
|
|
2073
2105
|
/**
|
|
2074
2106
|
* Gets the Y position of a block.
|
|
2075
2107
|
*
|
|
@@ -2085,7 +2117,7 @@ export declare class BlockAPI {
|
|
|
2085
2117
|
* @param id - The block to query.
|
|
2086
2118
|
* @returns The current mode for the y position: 'Absolute' or 'Percent'.
|
|
2087
2119
|
*/
|
|
2088
|
-
getPositionYMode(id: DesignBlockId):
|
|
2120
|
+
getPositionYMode(id: DesignBlockId): PositionYMode;
|
|
2089
2121
|
/**
|
|
2090
2122
|
* Sets the X position of a block.
|
|
2091
2123
|
*
|
|
@@ -2111,7 +2143,7 @@ export declare class BlockAPI {
|
|
|
2111
2143
|
* @param id - The block to update.
|
|
2112
2144
|
* @param mode - The x position mode: 'Absolute' or 'Percent'.
|
|
2113
2145
|
*/
|
|
2114
|
-
setPositionXMode(id: DesignBlockId, mode:
|
|
2146
|
+
setPositionXMode(id: DesignBlockId, mode: PositionXMode): void;
|
|
2115
2147
|
/**
|
|
2116
2148
|
* Sets the Y position of a block.
|
|
2117
2149
|
*
|
|
@@ -2137,7 +2169,7 @@ export declare class BlockAPI {
|
|
|
2137
2169
|
* @param id - The block to update.
|
|
2138
2170
|
* @param mode - The y position mode: 'Absolute' or 'Percent'.
|
|
2139
2171
|
*/
|
|
2140
|
-
setPositionYMode(id: DesignBlockId, mode:
|
|
2172
|
+
setPositionYMode(id: DesignBlockId, mode: PositionYMode): void;
|
|
2141
2173
|
/**
|
|
2142
2174
|
* Sets a block to always be rendered on top of its siblings.
|
|
2143
2175
|
*
|
|
@@ -2300,7 +2332,7 @@ export declare class BlockAPI {
|
|
|
2300
2332
|
* @param id - The block to query.
|
|
2301
2333
|
* @returns The current mode for the width: 'Absolute', 'Percent' or 'Auto'.
|
|
2302
2334
|
*/
|
|
2303
|
-
getWidthMode(id: DesignBlockId):
|
|
2335
|
+
getWidthMode(id: DesignBlockId): WidthMode;
|
|
2304
2336
|
/**
|
|
2305
2337
|
* Gets the height of a block in the current height mode.
|
|
2306
2338
|
*
|
|
@@ -2324,7 +2356,7 @@ export declare class BlockAPI {
|
|
|
2324
2356
|
* @param id - The block to query.
|
|
2325
2357
|
* @returns The current mode for the height: 'Absolute', 'Percent' or 'Auto'.
|
|
2326
2358
|
*/
|
|
2327
|
-
getHeightMode(id: DesignBlockId):
|
|
2359
|
+
getHeightMode(id: DesignBlockId): HeightMode;
|
|
2328
2360
|
/**
|
|
2329
2361
|
* Update a block's size.
|
|
2330
2362
|
*
|
|
@@ -2379,7 +2411,7 @@ export declare class BlockAPI {
|
|
|
2379
2411
|
* @param id - The block to update.
|
|
2380
2412
|
* @param mode - The width mode: 'Absolute', 'Percent' or 'Auto'.
|
|
2381
2413
|
*/
|
|
2382
|
-
setWidthMode(id: DesignBlockId, mode:
|
|
2414
|
+
setWidthMode(id: DesignBlockId, mode: WidthMode): void;
|
|
2383
2415
|
/**
|
|
2384
2416
|
* Sets the height of a block in the current height mode.
|
|
2385
2417
|
*
|
|
@@ -2407,7 +2439,7 @@ export declare class BlockAPI {
|
|
|
2407
2439
|
* @param id - The block to update.
|
|
2408
2440
|
* @param mode - The height mode: 'Absolute', 'Percent' or 'Auto'.
|
|
2409
2441
|
*/
|
|
2410
|
-
setHeightMode(id: DesignBlockId, mode:
|
|
2442
|
+
setHeightMode(id: DesignBlockId, mode: HeightMode): void;
|
|
2411
2443
|
/**
|
|
2412
2444
|
* Gets the final calculated X position of a block's frame.
|
|
2413
2445
|
*
|
|
@@ -2636,7 +2668,7 @@ export declare class BlockAPI {
|
|
|
2636
2668
|
* @param ids - A non-empty array of block ids.
|
|
2637
2669
|
* @param horizontalBlockAlignment - How they should be aligned: 'Left', 'Right', or 'Center'.
|
|
2638
2670
|
*/
|
|
2639
|
-
alignHorizontally(ids: DesignBlockId[], horizontalBlockAlignment:
|
|
2671
|
+
alignHorizontally(ids: DesignBlockId[], horizontalBlockAlignment: TextHorizontalAlignment): void;
|
|
2640
2672
|
/**
|
|
2641
2673
|
* Aligns blocks vertically.
|
|
2642
2674
|
*
|
|
@@ -2646,7 +2678,7 @@ export declare class BlockAPI {
|
|
|
2646
2678
|
* @param ids - A non-empty array of block ids.
|
|
2647
2679
|
* @param verticalBlockAlignment - How they should be aligned: 'Top', 'Bottom', or 'Center'.
|
|
2648
2680
|
*/
|
|
2649
|
-
alignVertically(ids: DesignBlockId[], verticalBlockAlignment:
|
|
2681
|
+
alignVertically(ids: DesignBlockId[], verticalBlockAlignment: TextVerticalAlignment): void;
|
|
2650
2682
|
/**
|
|
2651
2683
|
* Checks if a set of blocks can be aligned.
|
|
2652
2684
|
*
|
|
@@ -2776,7 +2808,7 @@ export declare class BlockAPI {
|
|
|
2776
2808
|
* @param property - The name of the property to set.
|
|
2777
2809
|
* @param value - The value to set.
|
|
2778
2810
|
*/
|
|
2779
|
-
setBool(id: DesignBlockId, property:
|
|
2811
|
+
setBool(id: DesignBlockId, property: BoolPropertyName, value: boolean): void;
|
|
2780
2812
|
/**
|
|
2781
2813
|
* Gets a boolean property from a block.
|
|
2782
2814
|
*
|
|
@@ -2789,7 +2821,7 @@ export declare class BlockAPI {
|
|
|
2789
2821
|
* @param property - The name of the property to query.
|
|
2790
2822
|
* @returns The value of the property.
|
|
2791
2823
|
*/
|
|
2792
|
-
getBool(id: DesignBlockId, property:
|
|
2824
|
+
getBool(id: DesignBlockId, property: BoolPropertyName): boolean;
|
|
2793
2825
|
/**
|
|
2794
2826
|
* Sets an integer property on a block.
|
|
2795
2827
|
*
|
|
@@ -2802,7 +2834,7 @@ export declare class BlockAPI {
|
|
|
2802
2834
|
* @param property - The name of the property to set.
|
|
2803
2835
|
* @param value - The value to set.
|
|
2804
2836
|
*/
|
|
2805
|
-
setInt(id: DesignBlockId, property:
|
|
2837
|
+
setInt(id: DesignBlockId, property: IntPropertyName, value: number): void;
|
|
2806
2838
|
/**
|
|
2807
2839
|
* Gets an integer property from a block.
|
|
2808
2840
|
*
|
|
@@ -2815,7 +2847,7 @@ export declare class BlockAPI {
|
|
|
2815
2847
|
* @param property - The name of the property to query.
|
|
2816
2848
|
* @returns The value of the property.
|
|
2817
2849
|
*/
|
|
2818
|
-
getInt(id: DesignBlockId, property:
|
|
2850
|
+
getInt(id: DesignBlockId, property: IntPropertyName): number;
|
|
2819
2851
|
/**
|
|
2820
2852
|
* Sets a float property on a block.
|
|
2821
2853
|
*
|
|
@@ -2829,7 +2861,7 @@ export declare class BlockAPI {
|
|
|
2829
2861
|
* @param property - The name of the property to set.
|
|
2830
2862
|
* @param value - The value to set.
|
|
2831
2863
|
*/
|
|
2832
|
-
setFloat(id: DesignBlockId, property:
|
|
2864
|
+
setFloat(id: DesignBlockId, property: FloatPropertyName, value: number): void;
|
|
2833
2865
|
/**
|
|
2834
2866
|
* Gets a float property from a block.
|
|
2835
2867
|
*
|
|
@@ -2842,7 +2874,7 @@ export declare class BlockAPI {
|
|
|
2842
2874
|
* @param property - The name of the property to query.
|
|
2843
2875
|
* @returns The value of the property.
|
|
2844
2876
|
*/
|
|
2845
|
-
getFloat(id: DesignBlockId, property:
|
|
2877
|
+
getFloat(id: DesignBlockId, property: FloatPropertyName): number;
|
|
2846
2878
|
/**
|
|
2847
2879
|
* Sets a double-precision float property on a block.
|
|
2848
2880
|
*
|
|
@@ -2855,7 +2887,7 @@ export declare class BlockAPI {
|
|
|
2855
2887
|
* @param property - The name of the property to set.
|
|
2856
2888
|
* @param value - The value to set.
|
|
2857
2889
|
*/
|
|
2858
|
-
setDouble(id: DesignBlockId, property:
|
|
2890
|
+
setDouble(id: DesignBlockId, property: DoublePropertyName, value: number): void;
|
|
2859
2891
|
/**
|
|
2860
2892
|
* Gets a double-precision float property from a block.
|
|
2861
2893
|
*
|
|
@@ -2868,7 +2900,7 @@ export declare class BlockAPI {
|
|
|
2868
2900
|
* @param property - The name of the property to query.
|
|
2869
2901
|
* @returns The value of the property.
|
|
2870
2902
|
*/
|
|
2871
|
-
getDouble(id: DesignBlockId, property:
|
|
2903
|
+
getDouble(id: DesignBlockId, property: DoublePropertyName): number;
|
|
2872
2904
|
/**
|
|
2873
2905
|
* Sets a string property on a block.
|
|
2874
2906
|
*
|
|
@@ -2882,7 +2914,7 @@ export declare class BlockAPI {
|
|
|
2882
2914
|
* @param property - The name of the property to set.
|
|
2883
2915
|
* @param value - The value to set.
|
|
2884
2916
|
*/
|
|
2885
|
-
setString(id: DesignBlockId, property:
|
|
2917
|
+
setString(id: DesignBlockId, property: StringPropertyName, value: string): void;
|
|
2886
2918
|
/**
|
|
2887
2919
|
* Gets a string property from a block.
|
|
2888
2920
|
*
|
|
@@ -2896,7 +2928,7 @@ export declare class BlockAPI {
|
|
|
2896
2928
|
* @param property - The name of the property to query.
|
|
2897
2929
|
* @returns The value of the property.
|
|
2898
2930
|
*/
|
|
2899
|
-
getString(id: DesignBlockId, property:
|
|
2931
|
+
getString(id: DesignBlockId, property: StringPropertyName): string;
|
|
2900
2932
|
/**
|
|
2901
2933
|
* Sets a color property on a block.
|
|
2902
2934
|
*
|
|
@@ -2910,7 +2942,7 @@ export declare class BlockAPI {
|
|
|
2910
2942
|
* @param property - The name of the property to set.
|
|
2911
2943
|
* @param value - The value to set.
|
|
2912
2944
|
*/
|
|
2913
|
-
setColor(id: DesignBlockId, property:
|
|
2945
|
+
setColor(id: DesignBlockId, property: ColorPropertyName, value: Color): void;
|
|
2914
2946
|
/**
|
|
2915
2947
|
* Gets a color property from a block.
|
|
2916
2948
|
*
|
|
@@ -2923,7 +2955,7 @@ export declare class BlockAPI {
|
|
|
2923
2955
|
* @param property - The name of the property to query.
|
|
2924
2956
|
* @returns The value of the property.
|
|
2925
2957
|
*/
|
|
2926
|
-
getColor(id: DesignBlockId, property:
|
|
2958
|
+
getColor(id: DesignBlockId, property: ColorPropertyName): Color;
|
|
2927
2959
|
/**
|
|
2928
2960
|
* Sets a color property on a block using RGBA values.
|
|
2929
2961
|
*
|
|
@@ -3019,7 +3051,7 @@ export declare class BlockAPI {
|
|
|
3019
3051
|
* @param property - The name of the property to query, e.g. 'fill/image/sourceSet'.
|
|
3020
3052
|
* @returns The block's source set.
|
|
3021
3053
|
*/
|
|
3022
|
-
getSourceSet(id: DesignBlockId, property:
|
|
3054
|
+
getSourceSet(id: DesignBlockId, property: SourceSetPropertyName): Source[];
|
|
3023
3055
|
/**
|
|
3024
3056
|
* Sets the source set for a block property.
|
|
3025
3057
|
*
|
|
@@ -3038,7 +3070,7 @@ export declare class BlockAPI {
|
|
|
3038
3070
|
* @param property - The name of the property to set.
|
|
3039
3071
|
* @param sourceSet - The block's new source set.
|
|
3040
3072
|
*/
|
|
3041
|
-
setSourceSet(id: DesignBlockId, property:
|
|
3073
|
+
setSourceSet(id: DesignBlockId, property: SourceSetPropertyName, sourceSet: Source[]): void;
|
|
3042
3074
|
/**
|
|
3043
3075
|
* Adds an image file URI to a source set property.
|
|
3044
3076
|
*
|
|
@@ -3054,7 +3086,7 @@ export declare class BlockAPI {
|
|
|
3054
3086
|
* @param uri - The source to add to the source set.
|
|
3055
3087
|
* @returns A promise that resolves when the operation is complete.
|
|
3056
3088
|
*/
|
|
3057
|
-
addImageFileURIToSourceSet(id: DesignBlockId, property:
|
|
3089
|
+
addImageFileURIToSourceSet(id: DesignBlockId, property: SourceSetPropertyName, uri: string): Promise<void>;
|
|
3058
3090
|
/**
|
|
3059
3091
|
* Adds a video file URI to a source set property.
|
|
3060
3092
|
*
|
|
@@ -3070,7 +3102,7 @@ export declare class BlockAPI {
|
|
|
3070
3102
|
* @param uri - The source to add to the source set.
|
|
3071
3103
|
* @returns A promise that resolves when the operation is complete.
|
|
3072
3104
|
*/
|
|
3073
|
-
addVideoFileURIToSourceSet(id: DesignBlockId, property:
|
|
3105
|
+
addVideoFileURIToSourceSet(id: DesignBlockId, property: SourceSetPropertyName, uri: string): Promise<void>;
|
|
3074
3106
|
/**
|
|
3075
3107
|
* Sets an enum property on a block.
|
|
3076
3108
|
*
|
|
@@ -3084,7 +3116,8 @@ export declare class BlockAPI {
|
|
|
3084
3116
|
* @param property - The name of the property to set.
|
|
3085
3117
|
* @param value - The enum value as a string.
|
|
3086
3118
|
*/
|
|
3087
|
-
setEnum<T extends
|
|
3119
|
+
setEnum<T extends keyof BlockEnumType>(id: DesignBlockId, property: T, value: BlockEnumType[T]): void;
|
|
3120
|
+
setEnum(id: DesignBlockId, property: string, value: string): void;
|
|
3088
3121
|
/**
|
|
3089
3122
|
* Gets an enum property from a block.
|
|
3090
3123
|
*
|
|
@@ -3098,7 +3131,8 @@ export declare class BlockAPI {
|
|
|
3098
3131
|
* @param property - The name of the property to query.
|
|
3099
3132
|
* @returns The value as a string.
|
|
3100
3133
|
*/
|
|
3101
|
-
getEnum<T extends
|
|
3134
|
+
getEnum<T extends keyof BlockEnumType>(id: DesignBlockId, property: T): BlockEnumType[T];
|
|
3135
|
+
getEnum(id: DesignBlockId, property: string): string;
|
|
3102
3136
|
/**
|
|
3103
3137
|
* Checks if a block has crop properties.
|
|
3104
3138
|
*
|
|
@@ -5021,6 +5055,14 @@ export declare class BlockAPI {
|
|
|
5021
5055
|
* @param muted - Whether the audio should be muted.
|
|
5022
5056
|
*/
|
|
5023
5057
|
setMuted(id: DesignBlockId, muted: boolean): void;
|
|
5058
|
+
/**
|
|
5059
|
+
* Checks if a block's audio is muted due to engine rules.
|
|
5060
|
+
*
|
|
5061
|
+
* @category Block Video
|
|
5062
|
+
* @param id - The block to query.
|
|
5063
|
+
* @returns Whether the block is force muted.
|
|
5064
|
+
*/
|
|
5065
|
+
isForceMuted(id: DesignBlockId): boolean;
|
|
5024
5066
|
/**
|
|
5025
5067
|
* Checks if a block's audio is muted.
|
|
5026
5068
|
*
|
|
@@ -5048,10 +5090,12 @@ export declare class BlockAPI {
|
|
|
5048
5090
|
/**
|
|
5049
5091
|
* Sets the playback speed multiplier of a block that supports playback control.
|
|
5050
5092
|
* Note: This also adjusts the trim and duration of the block.
|
|
5093
|
+
* Video fills running faster than 3.0x are force muted until reduced to 3.0x or below.
|
|
5051
5094
|
*
|
|
5052
5095
|
* @category Block Video
|
|
5053
5096
|
* @param id - The block or video fill to update.
|
|
5054
|
-
* @param speed - The desired playback speed multiplier
|
|
5097
|
+
* @param speed - The desired playback speed multiplier. Valid range is [0.25, 3.0] for audio blocks and
|
|
5098
|
+
* [0.25, infinity) for video fills.
|
|
5055
5099
|
*/
|
|
5056
5100
|
setPlaybackSpeed(id: DesignBlockId, speed: number): void;
|
|
5057
5101
|
/**
|
|
@@ -5374,6 +5418,40 @@ export declare class BlockAPI {
|
|
|
5374
5418
|
moveToBackgroundTrack(block: DesignBlockId): void;
|
|
5375
5419
|
}
|
|
5376
5420
|
|
|
5421
|
+
/** @public */
|
|
5422
|
+
export declare type BlockEnumType = {
|
|
5423
|
+
'blend/mode': BlendMode;
|
|
5424
|
+
'contentFill/mode': ContentFillMode;
|
|
5425
|
+
'height/mode': HeightMode;
|
|
5426
|
+
'position/x/mode': PositionXMode;
|
|
5427
|
+
'position/y/mode': PositionYMode;
|
|
5428
|
+
'scene/designUnit': SceneDesignUnit;
|
|
5429
|
+
'scene/layout': SceneLayout;
|
|
5430
|
+
'scene/mode': SceneMode;
|
|
5431
|
+
'width/mode': WidthMode;
|
|
5432
|
+
'stroke/cornerGeometry': StrokeCornerGeometry;
|
|
5433
|
+
'stroke/position': StrokePosition;
|
|
5434
|
+
'stroke/style': StrokeStyle;
|
|
5435
|
+
'text/horizontalAlignment': TextHorizontalAlignment;
|
|
5436
|
+
'text/verticalAlignment': TextVerticalAlignment;
|
|
5437
|
+
'cutout/type': CutoutType;
|
|
5438
|
+
'caption/horizontalAlignment': CaptionHorizontalAlignment;
|
|
5439
|
+
'caption/verticalAlignment': CaptionVerticalAlignment;
|
|
5440
|
+
animationEasing: AnimationEasing;
|
|
5441
|
+
textAnimationWritingStyle: TextAnimationWritingStyle;
|
|
5442
|
+
'animation/grow/direction': AnimationGrowDirection;
|
|
5443
|
+
'animation/wipe/direction': AnimationWipeDirection;
|
|
5444
|
+
'animation/baseline/direction': AnimationBaselineDirection;
|
|
5445
|
+
'animation/spin/direction': AnimationSpinDirection;
|
|
5446
|
+
'animation/spin_loop/direction': AnimationSpinLoopDirection;
|
|
5447
|
+
'animation/jump_loop/direction': AnimationJumpLoopDirection;
|
|
5448
|
+
'animation/typewriter_text/writingStyle': AnimationTypewriterTextWritingStyle;
|
|
5449
|
+
'animation/block_swipe_text/direction': AnimationBlockSwipeTextDirection;
|
|
5450
|
+
'animation/merge_text/direction': AnimationMergeTextDirection;
|
|
5451
|
+
'animation/ken_burns/direction': AnimationKenBurnsDirection;
|
|
5452
|
+
'fill/pixelStream/orientation': FillPixelStreamOrientation;
|
|
5453
|
+
};
|
|
5454
|
+
|
|
5377
5455
|
/**
|
|
5378
5456
|
* Represents an event related to a design block.
|
|
5379
5457
|
*
|
|
@@ -5439,6 +5517,13 @@ export declare interface BlockStateReady {
|
|
|
5439
5517
|
type: 'Ready';
|
|
5440
5518
|
}
|
|
5441
5519
|
|
|
5520
|
+
/**
|
|
5521
|
+
* The shorthand block type IDs for the blur blocks. These are the IDs used to create new blurs
|
|
5522
|
+
* using `cesdk.engine.block.createBlur(id)`.
|
|
5523
|
+
* @public
|
|
5524
|
+
*/
|
|
5525
|
+
export declare const BLUR_TYPES: readonly ["uniform", "linear", "mirrored", "radial"];
|
|
5526
|
+
|
|
5442
5527
|
/**
|
|
5443
5528
|
* The block type IDs for the blur blocks. These are the IDs used to create new blurs
|
|
5444
5529
|
* using `cesdk.engine.block.createBlur(id)`.
|
|
@@ -5454,12 +5539,8 @@ export declare type BlurType = BlurTypeShorthand | BlurTypeLonghand;
|
|
|
5454
5539
|
*/
|
|
5455
5540
|
export declare type BlurTypeLonghand = `//ly.img.ubq/blur/${BlurTypeShorthand}`;
|
|
5456
5541
|
|
|
5457
|
-
/**
|
|
5458
|
-
|
|
5459
|
-
* using `cesdk.engine.block.createBlur(id)`.
|
|
5460
|
-
* @public
|
|
5461
|
-
*/
|
|
5462
|
-
export declare type BlurTypeShorthand = 'uniform' | 'linear' | 'mirrored' | 'radial';
|
|
5542
|
+
/** @public */
|
|
5543
|
+
export declare type BlurTypeShorthand = (typeof BLUR_TYPES)[number];
|
|
5463
5544
|
|
|
5464
5545
|
/**
|
|
5465
5546
|
* Represents the names of boolean operations.
|
|
@@ -5474,6 +5555,9 @@ export declare type BlurTypeShorthand = 'uniform' | 'linear' | 'mirrored' | 'rad
|
|
|
5474
5555
|
*/
|
|
5475
5556
|
export declare type BooleanOperation = 'Difference' | 'Intersection' | 'Union' | 'XOR';
|
|
5476
5557
|
|
|
5558
|
+
/** @public */
|
|
5559
|
+
export declare type BoolPropertyName = 'alwaysOnBottom' | 'alwaysOnTop' | 'clipped' | 'flip/horizontal' | 'flip/vertical' | 'highlightEnabled' | 'includedInExport' | 'placeholder/enabled' | 'playback/playing' | 'playback/soloPlaybackEnabled' | 'scene/aspectRatioLock' | 'selected' | 'transformLocked' | 'visible' | 'blur/enabled' | 'dropShadow/clip' | 'dropShadow/enabled' | 'fill/enabled' | 'page/marginEnabled' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'playback/looping' | 'playback/muted' | 'stroke/enabled' | 'backgroundColor/enabled' | 'placeholderBehavior/enabled' | 'text/automaticFontSizeEnabled' | 'text/clipLinesOutsideOfFrame' | 'text/hasClippedLines' | 'track/automaticallyManageBlockOffsets' | 'caption/automaticFontSizeEnabled' | 'caption/clipLinesOutsideOfFrame' | 'caption/hasClippedLines' | 'captionTrack/automaticallyManageBlockOffsets' | 'animation/slide/fade' | 'animation/pan/fade' | 'animation/blur/fade' | 'animation/zoom/fade' | 'animation/crop_zoom/fade' | 'animation/spin/fade' | 'animation/block_swipe_text/useTextColor' | 'animation/spread_text/fade' | 'animation/ken_burns/fade' | 'effect/enabled' | (string & {});
|
|
5560
|
+
|
|
5477
5561
|
/**
|
|
5478
5562
|
* Represents a buffer of data.
|
|
5479
5563
|
*
|
|
@@ -5488,6 +5572,24 @@ declare interface Buffer_2 {
|
|
|
5488
5572
|
}
|
|
5489
5573
|
export { Buffer_2 as Buffer }
|
|
5490
5574
|
|
|
5575
|
+
/** @public */
|
|
5576
|
+
export declare type CameraClampingOvershootMode = (typeof CameraClampingOvershootModeValues)[number];
|
|
5577
|
+
|
|
5578
|
+
/** @public */
|
|
5579
|
+
export declare const CameraClampingOvershootModeValues: readonly ["Center", "Reverse"];
|
|
5580
|
+
|
|
5581
|
+
/** @public */
|
|
5582
|
+
export declare type CaptionHorizontalAlignment = (typeof CaptionHorizontalAlignmentValues)[number];
|
|
5583
|
+
|
|
5584
|
+
/** @public */
|
|
5585
|
+
export declare const CaptionHorizontalAlignmentValues: readonly ["Left", "Right", "Center"];
|
|
5586
|
+
|
|
5587
|
+
/** @public */
|
|
5588
|
+
export declare type CaptionVerticalAlignment = (typeof CaptionVerticalAlignmentValues)[number];
|
|
5589
|
+
|
|
5590
|
+
/** @public */
|
|
5591
|
+
export declare const CaptionVerticalAlignmentValues: readonly ["Top", "Bottom", "Center"];
|
|
5592
|
+
|
|
5491
5593
|
/**
|
|
5492
5594
|
* Represents a color in the CMYK color space.
|
|
5493
5595
|
*
|
|
@@ -5539,6 +5641,9 @@ export declare interface CMYKColor {
|
|
|
5539
5641
|
*/
|
|
5540
5642
|
export declare type Color = RGBAColor | CMYKColor | SpotColor;
|
|
5541
5643
|
|
|
5644
|
+
/** @public */
|
|
5645
|
+
export declare type ColorPropertyName = 'dropShadow/color' | 'fill/solid/color' | 'stroke/color' | 'backgroundColor/color' | 'animation/block_swipe_text/blockColor' | 'effect/duotone_filter/darkColor' | 'effect/duotone_filter/lightColor' | 'effect/green_screen/fromColor' | 'effect/recolor/fromColor' | 'effect/recolor/toColor' | 'fill/color/value' | (string & {});
|
|
5646
|
+
|
|
5542
5647
|
/**
|
|
5543
5648
|
* Represents the color space used in the editor.
|
|
5544
5649
|
*
|
|
@@ -5621,19 +5726,11 @@ export declare interface Configuration {
|
|
|
5621
5726
|
role?: RoleString;
|
|
5622
5727
|
}
|
|
5623
5728
|
|
|
5624
|
-
/**
|
|
5625
|
-
|
|
5626
|
-
|
|
5627
|
-
|
|
5628
|
-
|
|
5629
|
-
* covering, and containing the content.
|
|
5630
|
-
*
|
|
5631
|
-
* @categoryDescription ContentFillMode
|
|
5632
|
-
* Methods for configuring the mode for filling content within a block.
|
|
5633
|
-
*
|
|
5634
|
-
* @public
|
|
5635
|
-
*/
|
|
5636
|
-
export declare type ContentFillMode = 'Crop' | 'Cover' | 'Contain';
|
|
5729
|
+
/** @public */
|
|
5730
|
+
export declare type ContentFillMode = (typeof ContentFillModeValues)[number];
|
|
5731
|
+
|
|
5732
|
+
/** @public */
|
|
5733
|
+
export declare const ContentFillModeValues: readonly ["Crop", "Cover", "Contain"];
|
|
5637
5734
|
|
|
5638
5735
|
/**
|
|
5639
5736
|
* Options for creating a video scene.
|
|
@@ -5661,6 +5758,10 @@ export declare type CreateSceneOptions = {
|
|
|
5661
5758
|
*/
|
|
5662
5759
|
declare class CreativeEngine {
|
|
5663
5760
|
#private;
|
|
5761
|
+
/**
|
|
5762
|
+
* The version of the CE.SDK Node package.
|
|
5763
|
+
*/
|
|
5764
|
+
static readonly version: string;
|
|
5664
5765
|
asset: AssetAPI;
|
|
5665
5766
|
block: BlockAPI;
|
|
5666
5767
|
editor: EditorAPI;
|
|
@@ -5698,8 +5799,8 @@ declare class CreativeEngine {
|
|
|
5698
5799
|
* - `'ly.img.filter.lut'` - LUT effects of various kinds
|
|
5699
5800
|
* - `'ly.img.filter.duotone'` - Color effects of various kinds
|
|
5700
5801
|
*
|
|
5701
|
-
* These assets are parsed
|
|
5702
|
-
* `base_url` defaults to
|
|
5802
|
+
* These assets are parsed at \{\{base_url\}\}/<id>/content.json, where
|
|
5803
|
+
* `base_url` defaults to the IMG.LY CDN.
|
|
5703
5804
|
* Each source is created via `addLocalSource` and populated with the parsed assets. To modify the available
|
|
5704
5805
|
* assets, you may either exclude certain IDs via `excludeAssetSourceIds` or alter the sources after creation.
|
|
5705
5806
|
*
|
|
@@ -5708,7 +5809,7 @@ declare class CreativeEngine {
|
|
|
5708
5809
|
* @returns A promise that resolves when all asset sources are loaded.
|
|
5709
5810
|
*/
|
|
5710
5811
|
addDefaultAssetSources({ baseURL, excludeAssetSourceIds }?: {
|
|
5711
|
-
/** The source of the asset definitions, must be absolute. Defaults to
|
|
5812
|
+
/** The source of the asset definitions, must be absolute. Defaults to IMG.LY CDN. */
|
|
5712
5813
|
baseURL?: string;
|
|
5713
5814
|
/** A list of IDs, that will be ignored during load. */
|
|
5714
5815
|
excludeAssetSourceIds?: DefaultAssetSourceId[];
|
|
@@ -5730,7 +5831,9 @@ declare class CreativeEngine {
|
|
|
5730
5831
|
* @param options - Configuration options for loading demo asset sources.
|
|
5731
5832
|
* @returns A promise that resolves when all demo asset sources are loaded.
|
|
5732
5833
|
*/
|
|
5733
|
-
addDemoAssetSources({ excludeAssetSourceIds, sceneMode, withUploadAssetSources }?: {
|
|
5834
|
+
addDemoAssetSources({ baseURL, excludeAssetSourceIds, sceneMode, withUploadAssetSources }?: {
|
|
5835
|
+
/** The source of the demo asset definitions, must be absolute. Defaults to IMG.LY CDN. */
|
|
5836
|
+
baseURL?: string;
|
|
5734
5837
|
/** A list of IDs, that will be ignored during load */
|
|
5735
5838
|
excludeAssetSourceIds?: DemoAssetSourceId[];
|
|
5736
5839
|
/** If 'Video' video specific demo asset sources will be loaded as well (default 'Design') */
|
|
@@ -5738,23 +5841,25 @@ declare class CreativeEngine {
|
|
|
5738
5841
|
/** If 'true' asset sources for uploads are added (default false) */
|
|
5739
5842
|
withUploadAssetSources?: boolean;
|
|
5740
5843
|
}): Promise<void>;
|
|
5844
|
+
/**
|
|
5845
|
+
* Returns the configured base URL for the engine's assets.
|
|
5846
|
+
*
|
|
5847
|
+
* @category Engine Management
|
|
5848
|
+
* @returns The absolute base URL configured for this engine instance.
|
|
5849
|
+
*
|
|
5850
|
+
* @example
|
|
5851
|
+
* ```typescript
|
|
5852
|
+
* const engine = await CreativeEngine.init({
|
|
5853
|
+
* baseURL: 'https://my-cdn.example.com/assets/'
|
|
5854
|
+
* });
|
|
5855
|
+
*
|
|
5856
|
+
* console.log(engine.getBaseURL()); // 'https://my-cdn.example.com/assets/'
|
|
5857
|
+
* ```
|
|
5858
|
+
*/
|
|
5859
|
+
getBaseURL(): string;
|
|
5741
5860
|
}
|
|
5742
5861
|
export default CreativeEngine;
|
|
5743
5862
|
|
|
5744
|
-
/**
|
|
5745
|
-
* Represents the operation performed on a cutout.
|
|
5746
|
-
*
|
|
5747
|
-
* @categoryDescription Cutout Operation
|
|
5748
|
-
* Defines the possible operations for a cutout.
|
|
5749
|
-
* - 'Difference': The difference between two shapes.
|
|
5750
|
-
* - 'Intersection': The intersection of two shapes.
|
|
5751
|
-
* - 'Union': The union of two shapes.
|
|
5752
|
-
* - 'XOR': The exclusive OR of two shapes.
|
|
5753
|
-
*
|
|
5754
|
-
* @public
|
|
5755
|
-
*/
|
|
5756
|
-
export declare type CutoutOperation = 'Difference' | 'Intersection' | 'Union' | 'XOR';
|
|
5757
|
-
|
|
5758
5863
|
/**
|
|
5759
5864
|
* Represents the type of a cutout.
|
|
5760
5865
|
*
|
|
@@ -5765,7 +5870,13 @@ export declare type CutoutOperation = 'Difference' | 'Intersection' | 'Union' |
|
|
|
5765
5870
|
*
|
|
5766
5871
|
* @public
|
|
5767
5872
|
*/
|
|
5768
|
-
export declare type
|
|
5873
|
+
export declare type CutoutOperation = 'Difference' | 'Intersection' | 'Union' | 'XOR';
|
|
5874
|
+
|
|
5875
|
+
/** @public */
|
|
5876
|
+
export declare type CutoutType = (typeof CutoutTypeValues)[number];
|
|
5877
|
+
|
|
5878
|
+
/** @public */
|
|
5879
|
+
export declare const CutoutTypeValues: readonly ["Solid", "Dashed"];
|
|
5769
5880
|
|
|
5770
5881
|
/**
|
|
5771
5882
|
* Represents the default asset source IDs used in the editor.
|
|
@@ -5808,6 +5919,13 @@ export declare type DefaultAssetSourceId = 'ly.img.sticker' | 'ly.img.vectorpath
|
|
|
5808
5919
|
*/
|
|
5809
5920
|
export declare type DemoAssetSourceId = 'ly.img.template' | 'ly.img.image.upload' | 'ly.img.video.upload' | 'ly.img.audio.upload' | 'ly.img.image' | 'ly.img.video' | 'ly.img.video.template' | 'ly.img.audio' | 'ly.img.textComponents';
|
|
5810
5921
|
|
|
5922
|
+
/**
|
|
5923
|
+
* The shorthand block type IDs for the top-level design blocks. These are the IDs used to create new blocks
|
|
5924
|
+
* using `cesdk.engine.block.create(id)`.
|
|
5925
|
+
* @public
|
|
5926
|
+
*/
|
|
5927
|
+
export declare const DESIGN_BLOCK_TYPES: readonly ["scene", "stack", "camera", "page", "graphic", "audio", "text", "group", "cutout", "track", "caption", "captionTrack"];
|
|
5928
|
+
|
|
5811
5929
|
/**
|
|
5812
5930
|
* A numerical identifier for a design block
|
|
5813
5931
|
* @public
|
|
@@ -5829,18 +5947,17 @@ export declare type DesignBlockType = DesignBlockTypeShorthand | DesignBlockType
|
|
|
5829
5947
|
*/
|
|
5830
5948
|
export declare type DesignBlockTypeLonghand = `//ly.img.ubq/${DesignBlockTypeShorthand}`;
|
|
5831
5949
|
|
|
5832
|
-
/**
|
|
5833
|
-
|
|
5834
|
-
* using `cesdk.engine.block.create(id)`.
|
|
5835
|
-
* @public
|
|
5836
|
-
*/
|
|
5837
|
-
export declare type DesignBlockTypeShorthand = 'scene' | 'stack' | 'camera' | 'page' | 'graphic' | 'audio' | 'text' | 'group' | 'cutout' | 'track' | 'caption' | 'captionTrack';
|
|
5950
|
+
/** @public */
|
|
5951
|
+
export declare type DesignBlockTypeShorthand = (typeof DESIGN_BLOCK_TYPES)[number];
|
|
5838
5952
|
|
|
5839
|
-
/**
|
|
5840
|
-
|
|
5841
|
-
|
|
5842
|
-
*/
|
|
5843
|
-
export declare
|
|
5953
|
+
/** @public */
|
|
5954
|
+
export declare type DoubleClickSelectionMode = (typeof DoubleClickSelectionModeValues)[number];
|
|
5955
|
+
|
|
5956
|
+
/** @public */
|
|
5957
|
+
export declare const DoubleClickSelectionModeValues: readonly ["Direct", "Hierarchical"];
|
|
5958
|
+
|
|
5959
|
+
/** @public */
|
|
5960
|
+
export declare type DoublePropertyName = 'playback/time' | 'playback/duration' | 'playback/timeOffset' | 'audio/totalDuration' | 'playback/trimLength' | 'playback/trimOffset' | 'fill/video/totalDuration' | (string & {});
|
|
5844
5961
|
|
|
5845
5962
|
/**
|
|
5846
5963
|
* Information about a single audio track from a video.
|
|
@@ -5894,14 +6011,6 @@ export declare type EditMode = 'Transform' | 'Crop' | 'Text' | 'Playback' | 'Tri
|
|
|
5894
6011
|
* resource handling, and global scope controls. It serves as the central configuration and control interface
|
|
5895
6012
|
* for the design editor engine.
|
|
5896
6013
|
*
|
|
5897
|
-
* ## Settings API
|
|
5898
|
-
*
|
|
5899
|
-
* The recommended way to work with settings is through the unified API:
|
|
5900
|
-
* - `setSetting<K>(key: K, value: Settings[K])` - Set any setting value
|
|
5901
|
-
* - `getSetting<K>(key: K): Settings[K]` - Get any setting value
|
|
5902
|
-
*
|
|
5903
|
-
* Legacy methods are available in the `deprecated` namespace for backward compatibility.
|
|
5904
|
-
*
|
|
5905
6014
|
* @categoryDescription Edit Mode Management
|
|
5906
6015
|
* Control the editor's current editing mode and interaction state.
|
|
5907
6016
|
*
|
|
@@ -6153,7 +6262,7 @@ export declare class EditorAPI {
|
|
|
6153
6262
|
onRoleChanged: (callback: (role: RoleString) => void) => (() => void);
|
|
6154
6263
|
/**
|
|
6155
6264
|
* Set a setting value using the unified API.
|
|
6156
|
-
* The type
|
|
6265
|
+
* The value type is automatically validated based on the key.
|
|
6157
6266
|
*
|
|
6158
6267
|
* @category Editor Settings
|
|
6159
6268
|
* @param keypath - The setting key from Settings
|
|
@@ -6201,102 +6310,114 @@ export declare class EditorAPI {
|
|
|
6201
6310
|
/**
|
|
6202
6311
|
* Set a boolean setting value.
|
|
6203
6312
|
*
|
|
6204
|
-
* @deprecated Use setSetting() instead.
|
|
6205
|
-
*
|
|
6206
6313
|
* @category Editor Settings
|
|
6207
6314
|
* @param keypath - The settings keypath, e.g. `doubleClickToCropEnabled`.
|
|
6208
6315
|
* @param value - The boolean value to set.
|
|
6209
6316
|
* @throws Error if the keypath is invalid.
|
|
6210
6317
|
*/
|
|
6211
|
-
setSettingBool(keypath:
|
|
6318
|
+
setSettingBool(keypath: SettingsBool, value: boolean): void;
|
|
6319
|
+
/** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
|
|
6320
|
+
setSettingBool(keypath: `ubq://${SettingsBool}`, value: boolean): void;
|
|
6212
6321
|
/**
|
|
6213
6322
|
* Get a boolean setting value.
|
|
6214
6323
|
*
|
|
6215
|
-
* @deprecated Use getSetting() instead.
|
|
6216
6324
|
* @category Editor Settings
|
|
6217
6325
|
* @param keypath - The settings keypath, e.g. `doubleClickToCropEnabled`.
|
|
6218
6326
|
* @returns The boolean value of the setting.
|
|
6219
6327
|
* @throws Error if the keypath is invalid.
|
|
6220
6328
|
*/
|
|
6221
|
-
getSettingBool(keypath:
|
|
6329
|
+
getSettingBool(keypath: SettingsBool): boolean;
|
|
6330
|
+
/** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
|
|
6331
|
+
getSettingBool(keypath: `ubq://${SettingsBool}`): boolean;
|
|
6332
|
+
getSettingBool(keypath: SettingBoolPropertyName): boolean;
|
|
6222
6333
|
/**
|
|
6223
6334
|
* Set an integer setting value.
|
|
6224
6335
|
*
|
|
6225
|
-
* @deprecated Use setSetting() instead.
|
|
6226
6336
|
* @category Editor Settings
|
|
6227
6337
|
* @param keypath - The settings keypath.
|
|
6228
6338
|
* @param value - The integer value to set.
|
|
6229
6339
|
* @throws Error if the keypath is invalid.
|
|
6230
6340
|
*/
|
|
6231
6341
|
setSettingInt(keypath: SettingsInt, value: number): void;
|
|
6342
|
+
setSettingInt(keypath: SettingIntPropertyName, value: number): void;
|
|
6232
6343
|
/**
|
|
6233
6344
|
* Get an integer setting value.
|
|
6234
6345
|
*
|
|
6235
|
-
* @deprecated Use getSetting() instead.
|
|
6236
6346
|
* @category Editor Settings
|
|
6237
6347
|
* @param keypath - The settings keypath.
|
|
6238
6348
|
* @returns The integer value of the setting.
|
|
6239
6349
|
* @throws Error if the keypath is invalid.
|
|
6240
6350
|
*/
|
|
6241
6351
|
getSettingInt(keypath: SettingsInt): number;
|
|
6352
|
+
getSettingInt(keypath: SettingIntPropertyName): number;
|
|
6242
6353
|
/**
|
|
6243
6354
|
* Set a float setting value.
|
|
6244
6355
|
*
|
|
6245
|
-
* @deprecated Use setSetting() instead.
|
|
6246
6356
|
* @category Editor Settings
|
|
6247
6357
|
* @param keypath - The settings keypath, e.g. `positionSnappingThreshold`.
|
|
6248
6358
|
* @param value - The float value to set.
|
|
6249
6359
|
* @throws Error if the keypath is invalid.
|
|
6250
6360
|
*/
|
|
6251
|
-
setSettingFloat(keypath:
|
|
6361
|
+
setSettingFloat(keypath: SettingsFloat, value: number): void;
|
|
6362
|
+
/** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
|
|
6363
|
+
setSettingFloat(keypath: `ubq://${SettingsFloat}`, value: number): void;
|
|
6364
|
+
setSettingFloat(keypath: SettingFloatPropertyName, value: number): void;
|
|
6252
6365
|
/**
|
|
6253
6366
|
* Get a float setting value.
|
|
6254
6367
|
*
|
|
6255
|
-
* @deprecated Use getSetting() instead.
|
|
6256
6368
|
* @category Editor Settings
|
|
6257
6369
|
* @param keypath - The settings keypath, e.g. `positionSnappingThreshold`.
|
|
6258
6370
|
* @returns The float value of the setting.
|
|
6259
6371
|
* @throws Error if the keypath is invalid.
|
|
6260
6372
|
*/
|
|
6261
|
-
getSettingFloat(keypath:
|
|
6373
|
+
getSettingFloat(keypath: SettingsFloat): number;
|
|
6374
|
+
/** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
|
|
6375
|
+
getSettingFloat(keypath: `ubq://${SettingsFloat}`): number;
|
|
6376
|
+
getSettingFloat(keypath: SettingFloatPropertyName): number;
|
|
6262
6377
|
/**
|
|
6263
6378
|
* Set a string setting value.
|
|
6264
6379
|
*
|
|
6265
|
-
* @deprecated Use setSetting() instead.
|
|
6266
6380
|
* @category Editor Settings
|
|
6267
6381
|
* @param keypath - The settings keypath, e.g. `license`.
|
|
6268
6382
|
* @param value - The string value to set.
|
|
6269
6383
|
* @throws Error if the keypath is invalid.
|
|
6270
6384
|
*/
|
|
6271
|
-
setSettingString(keypath:
|
|
6385
|
+
setSettingString(keypath: SettingsString, value: string): void;
|
|
6386
|
+
/** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
|
|
6387
|
+
setSettingString(keypath: `ubq://${SettingsString}`, value: string): void;
|
|
6388
|
+
setSettingString(keypath: SettingStringPropertyName, value: string): void;
|
|
6272
6389
|
/**
|
|
6273
6390
|
* Get a string setting value.
|
|
6274
6391
|
*
|
|
6275
|
-
* @deprecated Use getSetting() instead.
|
|
6276
6392
|
* @category Editor Settings
|
|
6277
6393
|
* @param keypath - The settings keypath, e.g. `license`.
|
|
6278
6394
|
* @returns The string value of the setting.
|
|
6279
6395
|
* @throws Error if the keypath is invalid.
|
|
6280
6396
|
*/
|
|
6281
|
-
getSettingString(keypath:
|
|
6397
|
+
getSettingString(keypath: SettingsString): string;
|
|
6398
|
+
/** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
|
|
6399
|
+
getSettingString(keypath: `ubq://${SettingsString}`): string;
|
|
6400
|
+
getSettingString(keypath: SettingStringPropertyName): string;
|
|
6282
6401
|
/**
|
|
6283
6402
|
* Set a color setting.
|
|
6284
|
-
*
|
|
6285
|
-
* @deprecated Use setSetting() instead.
|
|
6286
6403
|
* @category Editor Settings
|
|
6287
6404
|
* @param keypath - The settings keypath, e.g. `highlightColor`.
|
|
6288
6405
|
* @param value - The The value to set.
|
|
6289
6406
|
*/
|
|
6290
|
-
setSettingColor(keypath:
|
|
6407
|
+
setSettingColor(keypath: SettingsColor, value: Color): void;
|
|
6408
|
+
/** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
|
|
6409
|
+
setSettingColor(keypath: `ubq://${SettingsColor}`, value: Color): void;
|
|
6410
|
+
setSettingColor(keypath: SettingColorPropertyName, value: Color): void;
|
|
6291
6411
|
/**
|
|
6292
6412
|
* Get a color setting.
|
|
6293
|
-
*
|
|
6294
|
-
* @deprecated Use getSetting() instead.
|
|
6295
6413
|
* @category Editor Settings
|
|
6296
6414
|
* @param keypath - The settings keypath, e.g. `highlightColor`.
|
|
6297
6415
|
* @throws An error, if the keypath is invalid.
|
|
6298
6416
|
*/
|
|
6299
|
-
getSettingColor(keypath:
|
|
6417
|
+
getSettingColor(keypath: SettingsColor): Color;
|
|
6418
|
+
/** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
|
|
6419
|
+
getSettingColor(keypath: `ubq://${SettingsColor}`): Color;
|
|
6420
|
+
getSettingColor(keypath: SettingColorPropertyName): Color;
|
|
6300
6421
|
/**
|
|
6301
6422
|
* Set a color setting.
|
|
6302
6423
|
* @param keypath - The settings keypath, e.g. `highlightColor`.
|
|
@@ -6306,39 +6427,38 @@ export declare class EditorAPI {
|
|
|
6306
6427
|
* @param a - The alpha color component in the range of 0 to 1.
|
|
6307
6428
|
* @deprecated Use setSettingColor() instead.
|
|
6308
6429
|
*/
|
|
6309
|
-
setSettingColorRGBA(keypath:
|
|
6430
|
+
setSettingColorRGBA(keypath: SettingsColorRGBA | `ubq://${SettingsColorRGBA}`, r: number, g: number, b: number, a?: number): void;
|
|
6310
6431
|
/**
|
|
6311
6432
|
* Get a color setting.
|
|
6312
6433
|
* @param keypath - The settings keypath, e.g. `highlightColor`.
|
|
6313
6434
|
* @returns A tuple of channels red, green, blue and alpha in the range of 0 to 1.
|
|
6314
6435
|
* @deprecated Use getSettingColor() instead.
|
|
6315
6436
|
*/
|
|
6316
|
-
getSettingColorRGBA(keypath:
|
|
6437
|
+
getSettingColorRGBA(keypath: SettingsColorRGBA | `ubq://${SettingsColorRGBA}`): RGBA;
|
|
6317
6438
|
/**
|
|
6318
6439
|
* Set an enum setting.
|
|
6319
|
-
*
|
|
6320
|
-
* @deprecated Use setSetting() instead.
|
|
6321
6440
|
* @category Editor Settings
|
|
6322
6441
|
* @param keypath - The settings keypath, e.g. `doubleClickSelectionMode`.
|
|
6323
6442
|
* @param value - The enum value as string.
|
|
6324
6443
|
*/
|
|
6325
|
-
setSettingEnum<T extends keyof
|
|
6444
|
+
setSettingEnum<T extends keyof SettingEnumType>(keypath: T, value: SettingEnumType[T]): void;
|
|
6445
|
+
setSettingEnum(keypath: string, value: string): void;
|
|
6326
6446
|
/**
|
|
6327
6447
|
* Get an enum setting.
|
|
6328
|
-
*
|
|
6329
|
-
* @deprecated Use getSetting() instead.
|
|
6330
6448
|
* @category Editor Settings
|
|
6331
6449
|
* @param keypath - The settings keypath, e.g. `doubleClickSelectionMode`.
|
|
6332
6450
|
* @returns The value as string.
|
|
6333
6451
|
*/
|
|
6334
|
-
getSettingEnum<T extends keyof
|
|
6452
|
+
getSettingEnum<T extends keyof SettingEnumType>(keypath: T): SettingEnumType[T];
|
|
6453
|
+
getSettingEnum(keypath: string): string;
|
|
6335
6454
|
/**
|
|
6336
6455
|
* Get the possible enum options for a given enum setting.
|
|
6337
6456
|
* @category Editor Settings
|
|
6338
6457
|
* @param keypath - The settings keypath, e.g. `doubleClickSelectionMode`.
|
|
6339
6458
|
* @returns The possible enum options as strings.
|
|
6340
6459
|
*/
|
|
6341
|
-
getSettingEnumOptions<T extends keyof
|
|
6460
|
+
getSettingEnumOptions<T extends keyof SettingEnumType>(keypath: T): SettingEnumType[T][];
|
|
6461
|
+
getSettingEnumOptions(keypath: string): string[];
|
|
6342
6462
|
/**
|
|
6343
6463
|
* Set the user role and apply role-dependent defaults.
|
|
6344
6464
|
*
|
|
@@ -6360,7 +6480,7 @@ export declare class EditorAPI {
|
|
|
6360
6480
|
* @category Editor Settings
|
|
6361
6481
|
* @returns A list of settings keypaths.
|
|
6362
6482
|
*/
|
|
6363
|
-
findAllSettings():
|
|
6483
|
+
findAllSettings(): string[];
|
|
6364
6484
|
/**
|
|
6365
6485
|
* Returns the type of a setting.
|
|
6366
6486
|
* @category Editor Settings
|
|
@@ -6716,6 +6836,37 @@ export declare class EditorAPI {
|
|
|
6716
6836
|
* @param enabled - Whether or not the block should show highlighting when selected or hovered.
|
|
6717
6837
|
*/
|
|
6718
6838
|
setHighlightingEnabled(id: DesignBlockId, enabled: boolean): void;
|
|
6839
|
+
/**
|
|
6840
|
+
* Set global safe area insets for UI overlays.
|
|
6841
|
+
*
|
|
6842
|
+
* Safe area insets define UI-safe regions by specifying padding from screen edges.
|
|
6843
|
+
* These insets are automatically applied to all camera operations (zoom, pan, clamping)
|
|
6844
|
+
* to ensure important content remains visible when UI elements overlap the viewport edges.
|
|
6845
|
+
* Set to zero to disable (default state).
|
|
6846
|
+
*
|
|
6847
|
+
* @param insets - The inset values in CSS pixels (device-independent)
|
|
6848
|
+
* @public
|
|
6849
|
+
* @category Viewport
|
|
6850
|
+
*/
|
|
6851
|
+
setSafeAreaInsets(insets: {
|
|
6852
|
+
left?: number;
|
|
6853
|
+
top?: number;
|
|
6854
|
+
right?: number;
|
|
6855
|
+
bottom?: number;
|
|
6856
|
+
}): void;
|
|
6857
|
+
/**
|
|
6858
|
+
* Get the current global safe area insets configuration.
|
|
6859
|
+
*
|
|
6860
|
+
* @returns The current inset values in CSS pixels (device-independent)
|
|
6861
|
+
* @public
|
|
6862
|
+
* @category Viewport
|
|
6863
|
+
*/
|
|
6864
|
+
getSafeAreaInsets(): {
|
|
6865
|
+
left: number;
|
|
6866
|
+
top: number;
|
|
6867
|
+
right: number;
|
|
6868
|
+
bottom: number;
|
|
6869
|
+
};
|
|
6719
6870
|
/**
|
|
6720
6871
|
* Checks whether the block can currently be selected.
|
|
6721
6872
|
*
|
|
@@ -6740,6 +6891,13 @@ export declare class EditorAPI {
|
|
|
6740
6891
|
setSelectionEnabled(id: DesignBlockId, enabled: boolean): void;
|
|
6741
6892
|
}
|
|
6742
6893
|
|
|
6894
|
+
/**
|
|
6895
|
+
* The shorthand block type IDs for the effect blocks. These are the IDs used to create new effects
|
|
6896
|
+
* using `cesdk.engine.block.createEffect(id)`.
|
|
6897
|
+
* @public
|
|
6898
|
+
*/
|
|
6899
|
+
export declare const EFFECT_TYPES: readonly ["adjustments", "cross_cut", "dot_pattern", "duotone_filter", "extrude_blur", "glow", "green_screen", "half_tone", "linocut", "liquid", "lut_filter", "mirror", "outliner", "pixelize", "posterize", "radial_pixel", "recolor", "sharpie", "shifter", "tilt_shift", "tv_glitch", "vignette"];
|
|
6900
|
+
|
|
6743
6901
|
/**
|
|
6744
6902
|
* The block type IDs for the effect blocks. These are the IDs used to create new effects
|
|
6745
6903
|
* using `cesdk.engine.block.createEffect(id)`.
|
|
@@ -6755,12 +6913,8 @@ export declare type EffectType = EffectTypeShorthand | EffectTypeLonghand;
|
|
|
6755
6913
|
*/
|
|
6756
6914
|
export declare type EffectTypeLonghand = `//ly.img.ubq/effect/${EffectTypeShorthand}`;
|
|
6757
6915
|
|
|
6758
|
-
/**
|
|
6759
|
-
|
|
6760
|
-
* using `cesdk.engine.block.createEffect(id)`.
|
|
6761
|
-
* @public
|
|
6762
|
-
*/
|
|
6763
|
-
export declare type EffectTypeShorthand = 'adjustments' | 'cross_cut' | 'dot_pattern' | 'duotone_filter' | 'extrude_blur' | 'glow' | 'green_screen' | 'half_tone' | 'linocut' | 'liquid' | 'lut_filter' | 'mirror' | 'outliner' | 'pixelize' | 'posterize' | 'radial_pixel' | 'recolor' | 'sharpie' | 'shifter' | 'tilt_shift' | 'tv_glitch' | 'vignette';
|
|
6916
|
+
/** @public */
|
|
6917
|
+
export declare type EffectTypeShorthand = (typeof EFFECT_TYPES)[number];
|
|
6764
6918
|
|
|
6765
6919
|
/**
|
|
6766
6920
|
* Represents an engine plugin.
|
|
@@ -6790,6 +6944,12 @@ export declare type EnginePluginContext = {
|
|
|
6790
6944
|
engine: CreativeEngine;
|
|
6791
6945
|
};
|
|
6792
6946
|
|
|
6947
|
+
/** @public */
|
|
6948
|
+
export declare type EnumPropertyName = 'blend/mode' | 'contentFill/mode' | 'height/mode' | 'position/x/mode' | 'position/y/mode' | 'scene/designUnit' | 'scene/layout' | 'scene/mode' | 'width/mode' | 'stroke/cornerGeometry' | 'stroke/position' | 'stroke/style' | 'text/horizontalAlignment' | 'text/verticalAlignment' | 'cutout/type' | 'caption/horizontalAlignment' | 'caption/verticalAlignment' | 'animationEasing' | 'textAnimationWritingStyle' | 'animation/grow/direction' | 'animation/wipe/direction' | 'animation/baseline/direction' | 'animation/spin/direction' | 'animation/spin_loop/direction' | 'animation/jump_loop/direction' | 'animation/typewriter_text/writingStyle' | 'animation/block_swipe_text/direction' | 'animation/merge_text/direction' | 'animation/ken_burns/direction' | 'fill/pixelStream/orientation' | (string & {});
|
|
6949
|
+
|
|
6950
|
+
/** @public */
|
|
6951
|
+
export declare type EnumValues = BlendMode | ContentFillMode | HeightMode | PositionXMode | PositionYMode | SceneDesignUnit | SceneLayout | SceneMode | WidthMode | StrokeCornerGeometry | StrokePosition | StrokeStyle | TextHorizontalAlignment | TextVerticalAlignment | CutoutType | CaptionHorizontalAlignment | CaptionVerticalAlignment | AnimationEasing | TextAnimationWritingStyle | AnimationGrowDirection | AnimationWipeDirection | AnimationBaselineDirection | AnimationSpinDirection | AnimationSpinLoopDirection | AnimationJumpLoopDirection | AnimationTypewriterTextWritingStyle | AnimationBlockSwipeTextDirection | AnimationMergeTextDirection | AnimationKenBurnsDirection | FillPixelStreamOrientation | (string & {});
|
|
6952
|
+
|
|
6793
6953
|
/**
|
|
6794
6954
|
* @public Subscribe to block lifecycle events in the design engine.
|
|
6795
6955
|
*
|
|
@@ -6903,6 +7063,19 @@ export declare type ExportOptions = {
|
|
|
6903
7063
|
abortSignal?: AbortSignal;
|
|
6904
7064
|
};
|
|
6905
7065
|
|
|
7066
|
+
/**
|
|
7067
|
+
* The shorthand block type IDs for the fill blocks. These are the IDs used to create new fills
|
|
7068
|
+
* using `cesdk.engine.block.createFill(id)`.
|
|
7069
|
+
* @public
|
|
7070
|
+
*/
|
|
7071
|
+
export declare const FILL_TYPES: readonly ["color", "gradient/linear", "gradient/radial", "gradient/conical", "image", "video", "pixelStream"];
|
|
7072
|
+
|
|
7073
|
+
/** @public */
|
|
7074
|
+
export declare type FillPixelStreamOrientation = (typeof FillPixelStreamOrientationValues)[number];
|
|
7075
|
+
|
|
7076
|
+
/** @public */
|
|
7077
|
+
export declare const FillPixelStreamOrientationValues: readonly ["Up", "Down", "Left", "Right", "UpMirrored", "DownMirrored", "LeftMirrored", "RightMirrored"];
|
|
7078
|
+
|
|
6906
7079
|
/**
|
|
6907
7080
|
* The block type IDs for the fill blocks. These are the IDs used to create new fills
|
|
6908
7081
|
* using `cesdk.engine.block.createFill(id)`.
|
|
@@ -6918,12 +7091,8 @@ export declare type FillType = FillTypeShorthand | FillTypeLonghand;
|
|
|
6918
7091
|
*/
|
|
6919
7092
|
export declare type FillTypeLonghand = `//ly.img.ubq/fill/${FillTypeShorthand}`;
|
|
6920
7093
|
|
|
6921
|
-
/**
|
|
6922
|
-
|
|
6923
|
-
* using `cesdk.engine.block.createFill(id)`.
|
|
6924
|
-
* @public
|
|
6925
|
-
*/
|
|
6926
|
-
export declare type FillTypeShorthand = 'color' | 'gradient/linear' | 'gradient/radial' | 'gradient/conical' | 'image' | 'video' | 'pixelStream';
|
|
7094
|
+
/** @public */
|
|
7095
|
+
export declare type FillTypeShorthand = (typeof FILL_TYPES)[number];
|
|
6927
7096
|
|
|
6928
7097
|
/**
|
|
6929
7098
|
* Represents a query for finding assets.
|
|
@@ -6965,6 +7134,9 @@ declare interface Flip {
|
|
|
6965
7134
|
vertical: boolean;
|
|
6966
7135
|
}
|
|
6967
7136
|
|
|
7137
|
+
/** @public */
|
|
7138
|
+
export declare type FloatPropertyName = 'globalBoundingBox/height' | 'globalBoundingBox/width' | 'globalBoundingBox/x' | 'globalBoundingBox/y' | 'height' | 'lastFrame/height' | 'lastFrame/width' | 'lastFrame/x' | 'lastFrame/y' | 'position/x' | 'position/y' | 'rotation' | 'scene/dpi' | 'scene/pageDimensions/height' | 'scene/pageDimensions/width' | 'scene/pixelScaleFactor' | 'width' | 'camera/pixelRatio' | 'camera/resolution/height' | 'camera/resolution/width' | 'camera/zoomLevel' | 'dropShadow/blurRadius/x' | 'dropShadow/blurRadius/y' | 'dropShadow/offset/x' | 'dropShadow/offset/y' | 'page/margin/bottom' | 'page/margin/left' | 'page/margin/right' | 'page/margin/top' | 'playback/speed' | 'playback/volume' | 'stroke/width' | 'opacity' | 'backgroundColor/cornerRadius' | 'backgroundColor/paddingBottom' | 'backgroundColor/paddingLeft' | 'backgroundColor/paddingRight' | 'backgroundColor/paddingTop' | 'text/fontSize' | 'text/letterSpacing' | 'text/lineHeight' | 'text/maxAutomaticFontSize' | 'text/minAutomaticFontSize' | 'text/paragraphSpacing' | 'cutout/offset' | 'cutout/smoothing' | 'caption/fontSize' | 'caption/letterSpacing' | 'caption/lineHeight' | 'caption/maxAutomaticFontSize' | 'caption/minAutomaticFontSize' | 'caption/paragraphSpacing' | 'animation/slide/direction' | 'textAnimationOverlap' | 'animation/pan/direction' | 'animation/pan/distance' | 'animation/blur/intensity' | 'animation/crop_zoom/scale' | 'animation/spin/intensity' | 'animation/blur_loop/intensity' | 'animation/pulsating_loop/intensity' | 'animation/breathing_loop/intensity' | 'animation/jump_loop/intensity' | 'animation/sway_loop/intensity' | 'animation/spread_text/intensity' | 'animation/merge_text/intensity' | 'animation/ken_burns/travelDistanceRatio' | 'animation/ken_burns/zoomIntensity' | 'blur/uniform/intensity' | 'blur/linear/blurRadius' | 'blur/linear/x1' | 'blur/linear/x2' | 'blur/linear/y1' | 'blur/linear/y2' | 'blur/mirrored/blurRadius' | 'blur/mirrored/gradientSize' | 'blur/mirrored/size' | 'blur/mirrored/x1' | 'blur/mirrored/x2' | 'blur/mirrored/y1' | 'blur/mirrored/y2' | 'blur/radial/blurRadius' | 'blur/radial/gradientRadius' | 'blur/radial/radius' | 'blur/radial/x' | 'blur/radial/y' | 'effect/adjustments/blacks' | 'effect/adjustments/brightness' | 'effect/adjustments/clarity' | 'effect/adjustments/contrast' | 'effect/adjustments/exposure' | 'effect/adjustments/gamma' | 'effect/adjustments/highlights' | 'effect/adjustments/saturation' | 'effect/adjustments/shadows' | 'effect/adjustments/sharpness' | 'effect/adjustments/temperature' | 'effect/adjustments/whites' | 'effect/cross_cut/offset' | 'effect/cross_cut/slices' | 'effect/cross_cut/speedV' | 'effect/cross_cut/time' | 'effect/dot_pattern/blur' | 'effect/dot_pattern/dots' | 'effect/dot_pattern/size' | 'effect/duotone_filter/intensity' | 'effect/extrude_blur/amount' | 'effect/glow/amount' | 'effect/glow/darkness' | 'effect/glow/size' | 'effect/green_screen/colorMatch' | 'effect/green_screen/smoothness' | 'effect/green_screen/spill' | 'effect/half_tone/angle' | 'effect/half_tone/scale' | 'effect/linocut/scale' | 'effect/liquid/amount' | 'effect/liquid/scale' | 'effect/liquid/time' | 'effect/lut_filter/intensity' | 'effect/outliner/amount' | 'effect/outliner/passthrough' | 'effect/posterize/levels' | 'effect/radial_pixel/radius' | 'effect/radial_pixel/segments' | 'effect/recolor/brightnessMatch' | 'effect/recolor/colorMatch' | 'effect/recolor/smoothness' | 'effect/shifter/amount' | 'effect/shifter/angle' | 'effect/tilt_shift/amount' | 'effect/tilt_shift/position' | 'effect/tv_glitch/distortion' | 'effect/tv_glitch/distortion2' | 'effect/tv_glitch/rollSpeed' | 'effect/tv_glitch/speed' | 'effect/vignette/darkness' | 'effect/vignette/offset' | 'fill/gradient/linear/endPointX' | 'fill/gradient/linear/endPointY' | 'fill/gradient/linear/startPointX' | 'fill/gradient/linear/startPointY' | 'fill/gradient/radial/centerPointX' | 'fill/gradient/radial/centerPointY' | 'fill/gradient/radial/radius' | 'fill/gradient/conical/centerPointX' | 'fill/gradient/conical/centerPointY' | 'shape/rect/cornerRadiusBL' | 'shape/rect/cornerRadiusBR' | 'shape/rect/cornerRadiusTL' | 'shape/rect/cornerRadiusTR' | 'shape/polygon/cornerRadius' | 'shape/star/innerDiameter' | 'shape/vector_path/height' | 'shape/vector_path/width' | (string & {});
|
|
7139
|
+
|
|
6968
7140
|
/**
|
|
6969
7141
|
* Represents a font.
|
|
6970
7142
|
*
|
|
@@ -6982,10 +7154,10 @@ export declare interface Font {
|
|
|
6982
7154
|
|
|
6983
7155
|
/**
|
|
6984
7156
|
* Extended design unit type that includes Point for font size operations.
|
|
6985
|
-
* Maintains consistency with
|
|
7157
|
+
* Maintains consistency with SceneDesignUnit's capitalized naming convention.
|
|
6986
7158
|
* @public
|
|
6987
7159
|
*/
|
|
6988
|
-
export declare type FontSizeUnit =
|
|
7160
|
+
export declare type FontSizeUnit = SceneDesignUnit | 'Point';
|
|
6989
7161
|
|
|
6990
7162
|
/**
|
|
6991
7163
|
* Represents the style of a font.
|
|
@@ -7042,6 +7214,12 @@ b: number,
|
|
|
7042
7214
|
a: number
|
|
7043
7215
|
];
|
|
7044
7216
|
|
|
7217
|
+
/** @public */
|
|
7218
|
+
export declare type HeightMode = (typeof HeightModeValues)[number];
|
|
7219
|
+
|
|
7220
|
+
/** @public */
|
|
7221
|
+
export declare const HeightModeValues: readonly ["Absolute", "Percent", "Auto"];
|
|
7222
|
+
|
|
7045
7223
|
/**
|
|
7046
7224
|
* Represents a hexadecimal color value (RGB or RGBA) that starts with a '#'.
|
|
7047
7225
|
*
|
|
@@ -7060,25 +7238,8 @@ export declare type HexColorString = string;
|
|
|
7060
7238
|
*/
|
|
7061
7239
|
export declare type HistoryId = number;
|
|
7062
7240
|
|
|
7063
|
-
/**
|
|
7064
|
-
|
|
7065
|
-
*
|
|
7066
|
-
* The `HorizontalBlockAlignment` type provides a set of values that control the
|
|
7067
|
-
* horizontal alignment of blocks. These options include settings for aligning
|
|
7068
|
-
* blocks to the left, right, or center.
|
|
7069
|
-
*
|
|
7070
|
-
* @categoryDescription HorizontalBlockAlignment
|
|
7071
|
-
* Methods for configuring the horizontal alignment of blocks.
|
|
7072
|
-
*
|
|
7073
|
-
* @public
|
|
7074
|
-
*/
|
|
7075
|
-
export declare type HorizontalBlockAlignment = 'Left' | 'Right' | 'Center';
|
|
7076
|
-
|
|
7077
|
-
/**
|
|
7078
|
-
* The horizontal text alignment options.
|
|
7079
|
-
* @public
|
|
7080
|
-
*/
|
|
7081
|
-
export declare type HorizontalTextAlignment = 'Left' | 'Right' | 'Center';
|
|
7241
|
+
/** @public */
|
|
7242
|
+
export declare type HorizontalBlockAlignment = TextHorizontalAlignment;
|
|
7082
7243
|
|
|
7083
7244
|
/**
|
|
7084
7245
|
* Represents the image MIME types used in the editor.
|
|
@@ -7094,6 +7255,9 @@ export declare type HorizontalTextAlignment = 'Left' | 'Right' | 'Center';
|
|
|
7094
7255
|
*/
|
|
7095
7256
|
export declare type ImageMimeType = Extract<MimeType_2, 'image/png' | 'image/jpeg' | 'image/webp' | 'image/x-tga'>;
|
|
7096
7257
|
|
|
7258
|
+
/** @public */
|
|
7259
|
+
export declare type IntPropertyName = 'effect/lut_filter/horizontalTileCount' | 'effect/lut_filter/verticalTileCount' | 'effect/mirror/side' | 'effect/pixelize/horizontalPixelSize' | 'effect/pixelize/verticalPixelSize' | 'shape/polygon/sides' | 'shape/star/points' | (string & {});
|
|
7260
|
+
|
|
7097
7261
|
/**
|
|
7098
7262
|
* Type guard for {@link CMYKColor}.
|
|
7099
7263
|
*
|
|
@@ -7257,10 +7421,7 @@ export declare type ObjectTypeLonghand = DesignBlockTypeLonghand | ShapeTypeLong
|
|
|
7257
7421
|
*/
|
|
7258
7422
|
export declare type ObjectTypeShorthand = DesignBlockTypeShorthand | `shape/${ShapeTypeShorthand}` | `fill/${FillTypeShorthand}` | `effect/${EffectTypeShorthand}` | `blur/${BlurTypeShorthand}` | `animation/${AnimationTypeShorthand}`;
|
|
7259
7423
|
|
|
7260
|
-
/**
|
|
7261
|
-
* Type helper for settings keypaths that can optionally include the 'ubq://' prefix.
|
|
7262
|
-
* @public
|
|
7263
|
-
*/
|
|
7424
|
+
/** @public */
|
|
7264
7425
|
export declare type OptionalPrefix<T extends string> = `ubq://${T}` | T;
|
|
7265
7426
|
|
|
7266
7427
|
/** @public */
|
|
@@ -7285,19 +7446,20 @@ export declare interface PageDuration {
|
|
|
7285
7446
|
*/
|
|
7286
7447
|
export declare type PaletteColor = HexColorString | RGBColor | RGBAColor | SpotColor;
|
|
7287
7448
|
|
|
7288
|
-
/**
|
|
7289
|
-
|
|
7290
|
-
|
|
7291
|
-
|
|
7292
|
-
|
|
7293
|
-
|
|
7294
|
-
|
|
7295
|
-
|
|
7296
|
-
|
|
7297
|
-
|
|
7298
|
-
|
|
7299
|
-
|
|
7300
|
-
|
|
7449
|
+
/** @public */
|
|
7450
|
+
export declare type PositionMode = PositionXMode | PositionYMode;
|
|
7451
|
+
|
|
7452
|
+
/** @public */
|
|
7453
|
+
export declare type PositionXMode = (typeof PositionXModeValues)[number];
|
|
7454
|
+
|
|
7455
|
+
/** @public */
|
|
7456
|
+
export declare const PositionXModeValues: readonly ["Absolute", "Percent", "Auto"];
|
|
7457
|
+
|
|
7458
|
+
/** @public */
|
|
7459
|
+
export declare type PositionYMode = (typeof PositionYModeValues)[number];
|
|
7460
|
+
|
|
7461
|
+
/** @public */
|
|
7462
|
+
export declare const PositionYModeValues: readonly ["Absolute", "Percent", "Auto"];
|
|
7301
7463
|
|
|
7302
7464
|
/**
|
|
7303
7465
|
* Represents the various types of properties that can be associated with design blocks.
|
|
@@ -7621,7 +7783,7 @@ export declare class SceneAPI {
|
|
|
7621
7783
|
* @category Scene Properties
|
|
7622
7784
|
* @param designUnit - The new design unit of the scene
|
|
7623
7785
|
*/
|
|
7624
|
-
setDesignUnit(designUnit:
|
|
7786
|
+
setDesignUnit(designUnit: SceneDesignUnit): void;
|
|
7625
7787
|
/**
|
|
7626
7788
|
* Returns the design unit of the current scene.
|
|
7627
7789
|
*
|
|
@@ -7632,7 +7794,7 @@ export declare class SceneAPI {
|
|
|
7632
7794
|
* @category Scene Properties
|
|
7633
7795
|
* @returns The current design unit.
|
|
7634
7796
|
*/
|
|
7635
|
-
getDesignUnit():
|
|
7797
|
+
getDesignUnit(): SceneDesignUnit;
|
|
7636
7798
|
/**
|
|
7637
7799
|
* Get the sorted list of pages in the scene.
|
|
7638
7800
|
*
|
|
@@ -7942,17 +8104,25 @@ export declare class SceneAPI {
|
|
|
7942
8104
|
setPlaying(play: boolean): void;
|
|
7943
8105
|
}
|
|
7944
8106
|
|
|
7945
|
-
/**
|
|
7946
|
-
|
|
7947
|
-
|
|
7948
|
-
|
|
7949
|
-
export declare type SceneLayout = 'Free' | 'VerticalStack' | 'HorizontalStack' | 'DepthStack';
|
|
8107
|
+
/** @public */
|
|
8108
|
+
declare type SceneDesignUnit = (typeof SceneDesignUnitValues)[number];
|
|
8109
|
+
export { SceneDesignUnit as DesignUnit }
|
|
8110
|
+
export { SceneDesignUnit }
|
|
7950
8111
|
|
|
7951
|
-
/**
|
|
7952
|
-
|
|
7953
|
-
|
|
7954
|
-
*/
|
|
7955
|
-
export declare type
|
|
8112
|
+
/** @public */
|
|
8113
|
+
export declare const SceneDesignUnitValues: readonly ["Pixel", "Millimeter", "Inch"];
|
|
8114
|
+
|
|
8115
|
+
/** @public */
|
|
8116
|
+
export declare type SceneLayout = (typeof SceneLayoutValues)[number];
|
|
8117
|
+
|
|
8118
|
+
/** @public */
|
|
8119
|
+
export declare const SceneLayoutValues: readonly ["Free", "VerticalStack", "HorizontalStack", "DepthStack"];
|
|
8120
|
+
|
|
8121
|
+
/** @public */
|
|
8122
|
+
export declare type SceneMode = (typeof SceneModeValues)[number];
|
|
8123
|
+
|
|
8124
|
+
/** @public */
|
|
8125
|
+
export declare const SceneModeValues: readonly ["Design", "Video"];
|
|
7956
8126
|
|
|
7957
8127
|
/**
|
|
7958
8128
|
* @public
|
|
@@ -7971,6 +8141,32 @@ export declare type SceneMode = 'Design' | 'Video';
|
|
|
7971
8141
|
*/
|
|
7972
8142
|
export declare type Scope = 'text/edit' | 'text/character' | 'fill/change' | 'fill/changeType' | 'stroke/change' | 'shape/change' | 'layer/move' | 'layer/resize' | 'layer/rotate' | 'layer/flip' | 'layer/crop' | 'layer/opacity' | 'layer/blendMode' | 'layer/visibility' | 'layer/clipping' | 'appearance/adjustments' | 'appearance/filter' | 'appearance/effect' | 'appearance/blur' | 'appearance/shadow' | 'appearance/animation' | 'lifecycle/destroy' | 'lifecycle/duplicate' | 'editor/add' | 'editor/select';
|
|
7973
8143
|
|
|
8144
|
+
/** @public */
|
|
8145
|
+
export declare type SettingBoolPropertyName = 'alwaysHighlightPlaceholders' | 'doubleClickToCropEnabled' | 'showBuildVersion' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'blockAnimations/enabled' | 'renderTextCursorAndSelectionInEngine' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning' | 'mouse/enableZoom' | 'mouse/enableScroll' | 'controlGizmo/showCropHandles' | 'controlGizmo/showMoveHandles' | 'controlGizmo/showResizeHandles' | 'controlGizmo/showScaleHandles' | 'controlGizmo/showRotateHandles' | 'controlGizmo/showCropScaleHandles' | 'page/title/show' | 'page/title/showPageTitleTemplate' | 'page/title/appendPageName' | 'page/title/showOnSinglePage' | 'page/dimOutOfPageAreas' | 'page/allowCropInteraction' | 'page/allowResizeInteraction' | 'page/restrictResizeInteractionToFixedAspectRatio' | 'page/allowRotateInteraction' | 'page/allowMoveInteraction' | 'page/moveChildrenWhenCroppingFill' | 'page/selectWhenNoBlocksSelected' | 'colorMaskingSettings/secondPass' | 'clampThumbnailTextureSizes' | 'useSystemFontFallback' | 'forceSystemEmojis' | (string & {});
|
|
8146
|
+
|
|
8147
|
+
/** @public */
|
|
8148
|
+
export declare type SettingColorPropertyName = 'clearColor' | 'handleFillColor' | 'highlightColor' | 'placeholderHighlightColor' | 'snappingGuideColor' | 'rotationSnappingGuideColor' | 'cropOverlayColor' | 'textVariableHighlightColor' | 'borderOutlineColor' | 'progressColor' | 'errorStateColor' | 'page/title/color' | 'page/marginFillColor' | 'page/marginFrameColor' | 'page/innerBorderColor' | 'page/outerBorderColor' | 'colorMaskingSettings/maskColor' | (string & {});
|
|
8149
|
+
|
|
8150
|
+
/** @public */
|
|
8151
|
+
export declare type SettingEnumPropertyName = 'touch/pinchAction' | 'touch/rotateAction' | 'camera/clamping/overshootMode' | 'doubleClickSelectionMode' | (string & {});
|
|
8152
|
+
|
|
8153
|
+
/** @public */
|
|
8154
|
+
export declare type SettingEnumType = {
|
|
8155
|
+
'touch/pinchAction': TouchPinchAction;
|
|
8156
|
+
'touch/rotateAction': TouchRotateAction;
|
|
8157
|
+
'camera/clamping/overshootMode': CameraClampingOvershootMode;
|
|
8158
|
+
doubleClickSelectionMode: DoubleClickSelectionMode;
|
|
8159
|
+
};
|
|
8160
|
+
|
|
8161
|
+
/** @public */
|
|
8162
|
+
export declare type SettingEnumValues = TouchPinchAction | TouchRotateAction | CameraClampingOvershootMode | DoubleClickSelectionMode | (string & {});
|
|
8163
|
+
|
|
8164
|
+
/** @public */
|
|
8165
|
+
export declare type SettingFloatPropertyName = 'positionSnappingThreshold' | 'rotationSnappingThreshold' | 'controlGizmo/blockScaleDownLimit' | (string & {});
|
|
8166
|
+
|
|
8167
|
+
/** @public */
|
|
8168
|
+
export declare type SettingIntPropertyName = 'maxImageSize' | (string & {});
|
|
8169
|
+
|
|
7974
8170
|
/**
|
|
7975
8171
|
* Union type of all valid setting keys.
|
|
7976
8172
|
* @public
|
|
@@ -8161,68 +8357,78 @@ export declare interface Settings {
|
|
|
8161
8357
|
|
|
8162
8358
|
}
|
|
8163
8359
|
|
|
8164
|
-
/**
|
|
8165
|
-
|
|
8166
|
-
*
|
|
8167
|
-
* @deprecated Use keyof Settings or extract the boolean keys from Settings instead.
|
|
8168
|
-
* @public
|
|
8169
|
-
*/
|
|
8170
|
-
export declare type SettingsBool = {
|
|
8171
|
-
[K in keyof Settings]: Settings[K] extends boolean ? K : never;
|
|
8172
|
-
}[keyof Settings];
|
|
8360
|
+
/** @public */
|
|
8361
|
+
export declare type SettingsBool = SettingBoolPropertyName;
|
|
8173
8362
|
|
|
8174
8363
|
/**
|
|
8175
8364
|
* Represents the color settings available in the editor.
|
|
8176
8365
|
*
|
|
8177
|
-
* @
|
|
8366
|
+
* @categoryDescription Color Settings
|
|
8367
|
+
* Defines the possible color settings in the editor.
|
|
8368
|
+
* - 'borderOutlineColor': The color of the border outline.
|
|
8369
|
+
* - 'clearColor': The clear color.
|
|
8370
|
+
* - 'colorMaskingSettings/maskColor': The color used for masking.
|
|
8371
|
+
* - 'cropOverlayColor': The color of the crop overlay.
|
|
8372
|
+
* - 'errorStateColor': The color indicating an error state.
|
|
8373
|
+
* - 'highlightColor': The highlight color.
|
|
8374
|
+
* - 'page/innerBorderColor': The color of the inner border of the page.
|
|
8375
|
+
* - 'page/marginFillColor': The color of the margin fill.
|
|
8376
|
+
* - 'page/marginFrameColor': The color of the margin frame.
|
|
8377
|
+
* - 'page/outerBorderColor': The color of the outer border of the page.
|
|
8378
|
+
* - 'page/title/color': The color of the page title.
|
|
8379
|
+
* - 'placeholderHighlightColor': The highlight color for placeholders.
|
|
8380
|
+
* - 'progressColor': The color indicating progress.
|
|
8381
|
+
* - 'rotationSnappingGuideColor': The color of the rotation snapping guide.
|
|
8382
|
+
* - 'ruleOfThirdsLineColor': The color of the rule of thirds lines.
|
|
8383
|
+
* - 'snappingGuideColor': The color of the snapping guide.
|
|
8384
|
+
* - 'textVariableHighlightColor': The highlight color for text variables.
|
|
8385
|
+
*
|
|
8178
8386
|
* @public
|
|
8179
8387
|
*/
|
|
8180
|
-
export declare type SettingsColor =
|
|
8181
|
-
[K in keyof Settings]: Settings[K] extends Color ? K : never;
|
|
8182
|
-
}[keyof Settings];
|
|
8388
|
+
export declare type SettingsColor = SettingColorPropertyName;
|
|
8183
8389
|
|
|
8184
8390
|
/**
|
|
8185
8391
|
* Represents the color settings available in the editor.
|
|
8186
8392
|
*
|
|
8393
|
+
* @categoryDescription Color Settings
|
|
8394
|
+
* Defines the possible color settings in the editor.
|
|
8395
|
+
* - 'borderOutlineColor': The color of the border outline.
|
|
8396
|
+
* - 'clearColor': The clear color.
|
|
8397
|
+
* - 'colorMaskingSettings/maskColor': The color used for masking.
|
|
8398
|
+
* - 'cropOverlayColor': The color of the crop overlay.
|
|
8399
|
+
* - 'errorStateColor': The color indicating an error state.
|
|
8400
|
+
* - 'highlightColor': The highlight color.
|
|
8401
|
+
* - 'page/innerBorderColor': The color of the inner border of the page.
|
|
8402
|
+
* - 'page/marginFillColor': The color of the margin fill.
|
|
8403
|
+
* - 'page/marginFrameColor': The color of the margin frame.
|
|
8404
|
+
* - 'page/outerBorderColor': The color of the outer border of the page.
|
|
8405
|
+
* - 'page/title/color': The color of the page title.
|
|
8406
|
+
* - 'placeholderHighlightColor': The highlight color for placeholders.
|
|
8407
|
+
* - 'progressColor': The color indicating progress.
|
|
8408
|
+
* - 'rotationSnappingGuideColor': The color of the rotation snapping guide.
|
|
8409
|
+
* - 'ruleOfThirdsLineColor': The color of the rule of thirds lines.
|
|
8410
|
+
* - 'snappingGuideColor': The color of the snapping guide.
|
|
8411
|
+
* - 'textVariableHighlightColor': The highlight color for text variables.
|
|
8412
|
+
*
|
|
8187
8413
|
* @public
|
|
8188
8414
|
* @deprecated Use SettingsColor instead.
|
|
8189
8415
|
*/
|
|
8190
8416
|
export declare type SettingsColorRGBA = SettingsColor;
|
|
8191
8417
|
|
|
8192
|
-
/**
|
|
8193
|
-
|
|
8194
|
-
*
|
|
8195
|
-
* @deprecated Use keyof Settings or extract the enum keys from Settings instead.
|
|
8196
|
-
* @public
|
|
8197
|
-
*/
|
|
8198
|
-
export declare type SettingsEnum = Pick<Settings, 'doubleClickSelectionMode' | 'touch/pinchAction' | 'touch/rotateAction' | 'camera/clamping/overshootMode' | 'dock/iconSize'>;
|
|
8418
|
+
/** @public */
|
|
8419
|
+
export declare type SettingsEnum = SettingEnumType;
|
|
8199
8420
|
|
|
8200
|
-
/**
|
|
8201
|
-
|
|
8202
|
-
*
|
|
8203
|
-
* @deprecated Use keyof Settings or extract the float keys from Settings instead.
|
|
8204
|
-
* @public
|
|
8205
|
-
*/
|
|
8206
|
-
export declare type SettingsFloat = Exclude<{
|
|
8207
|
-
[K in keyof Settings]: Settings[K] extends number ? K : never;
|
|
8208
|
-
}[keyof Settings], SettingsInt>;
|
|
8421
|
+
/** @public */
|
|
8422
|
+
export declare type SettingsFloat = SettingFloatPropertyName;
|
|
8209
8423
|
|
|
8210
|
-
/**
|
|
8211
|
-
|
|
8212
|
-
*
|
|
8213
|
-
* @public
|
|
8214
|
-
*/
|
|
8215
|
-
export declare type SettingsInt = 'maxImageSize';
|
|
8424
|
+
/** @public */
|
|
8425
|
+
export declare type SettingsInt = SettingIntPropertyName;
|
|
8216
8426
|
|
|
8217
|
-
/**
|
|
8218
|
-
|
|
8219
|
-
|
|
8220
|
-
|
|
8221
|
-
|
|
8222
|
-
*/
|
|
8223
|
-
export declare type SettingsString = Exclude<{
|
|
8224
|
-
[K in keyof Settings]: Settings[K] extends string ? K : never;
|
|
8225
|
-
}[keyof Settings], keyof SettingsEnum | 'renderMode'>;
|
|
8427
|
+
/** @public */
|
|
8428
|
+
export declare type SettingsString = SettingStringPropertyName;
|
|
8429
|
+
|
|
8430
|
+
/** @public */
|
|
8431
|
+
export declare type SettingStringPropertyName = 'basePath' | 'defaultEmojiFontFileUri' | 'defaultFontFileUri' | 'upload/supportedMimeTypes' | 'license' | 'page/title/separator' | 'page/title/fontFileUri' | 'fallbackFontUri' | (string & {});
|
|
8226
8432
|
|
|
8227
8433
|
/**
|
|
8228
8434
|
* Represents the type of a setting.
|
|
@@ -8246,6 +8452,13 @@ export declare type SettingType = 'Bool' | 'Int' | 'Float' | 'String' | 'Color'
|
|
|
8246
8452
|
*/
|
|
8247
8453
|
export declare type SettingValueType<K extends SettingKey> = Settings[K];
|
|
8248
8454
|
|
|
8455
|
+
/**
|
|
8456
|
+
* The shorthand block type IDs for the shape blocks. These are the IDs used to create new shapes
|
|
8457
|
+
* using `cesdk.engine.block.createShape(id)`.
|
|
8458
|
+
* @public
|
|
8459
|
+
*/
|
|
8460
|
+
export declare const SHAPE_TYPES: readonly ["rect", "line", "ellipse", "polygon", "star", "vector_path"];
|
|
8461
|
+
|
|
8249
8462
|
/**
|
|
8250
8463
|
* The block type IDs for the shape blocks. These are the IDs used to create new shapes
|
|
8251
8464
|
* using `cesdk.engine.block.createShape(id)`.
|
|
@@ -8261,12 +8474,8 @@ export declare type ShapeType = ShapeTypeShorthand | ShapeTypeLonghand;
|
|
|
8261
8474
|
*/
|
|
8262
8475
|
export declare type ShapeTypeLonghand = `//ly.img.ubq/shape/${ShapeTypeShorthand}`;
|
|
8263
8476
|
|
|
8264
|
-
/**
|
|
8265
|
-
|
|
8266
|
-
* using `cesdk.engine.block.createShape(id)`.
|
|
8267
|
-
* @public
|
|
8268
|
-
*/
|
|
8269
|
-
export declare type ShapeTypeShorthand = 'rect' | 'line' | 'ellipse' | 'polygon' | 'star' | 'vector_path';
|
|
8477
|
+
/** @public */
|
|
8478
|
+
export declare type ShapeTypeShorthand = (typeof SHAPE_TYPES)[number];
|
|
8270
8479
|
|
|
8271
8480
|
/** @public */
|
|
8272
8481
|
export declare interface Size2 {
|
|
@@ -8274,19 +8483,8 @@ export declare interface Size2 {
|
|
|
8274
8483
|
height: number;
|
|
8275
8484
|
}
|
|
8276
8485
|
|
|
8277
|
-
/**
|
|
8278
|
-
|
|
8279
|
-
*
|
|
8280
|
-
* The `SizeMode` type provides a set of values that control the mode for sizing
|
|
8281
|
-
* blocks. These options include settings for absolute sizing, percentage-based
|
|
8282
|
-
* sizing, and automatic sizing.
|
|
8283
|
-
*
|
|
8284
|
-
* @categoryDescription SizeMode
|
|
8285
|
-
* Methods for configuring the mode for sizing blocks.
|
|
8286
|
-
*
|
|
8287
|
-
* @public
|
|
8288
|
-
*/
|
|
8289
|
-
export declare type SizeMode = 'Absolute' | 'Percent' | 'Auto';
|
|
8486
|
+
/** @public */
|
|
8487
|
+
export declare type SizeMode = WidthMode | HeightMode;
|
|
8290
8488
|
|
|
8291
8489
|
/**
|
|
8292
8490
|
* The order to sort by if the asset source supports sorting.
|
|
@@ -8305,6 +8503,9 @@ export declare interface Source {
|
|
|
8305
8503
|
height: number;
|
|
8306
8504
|
}
|
|
8307
8505
|
|
|
8506
|
+
/** @public */
|
|
8507
|
+
export declare type SourceSetPropertyName = 'fill/image/sourceSet' | (string & {});
|
|
8508
|
+
|
|
8308
8509
|
/**
|
|
8309
8510
|
* Options for configuring block split operations.
|
|
8310
8511
|
* @public
|
|
@@ -8343,47 +8544,26 @@ export declare interface SpotColor {
|
|
|
8343
8544
|
externalReference: string;
|
|
8344
8545
|
}
|
|
8345
8546
|
|
|
8346
|
-
/**
|
|
8347
|
-
|
|
8348
|
-
*
|
|
8349
|
-
* @categoryDescription Stroke Corner Geometry
|
|
8350
|
-
* Defines the possible corner geometries for a stroke.
|
|
8351
|
-
* - 'Bevel': A beveled corner.
|
|
8352
|
-
* - 'Miter': A mitered corner.
|
|
8353
|
-
* - 'Round': A rounded corner.
|
|
8354
|
-
*
|
|
8355
|
-
* @public
|
|
8356
|
-
*/
|
|
8357
|
-
export declare type StrokeCornerGeometry = 'Bevel' | 'Miter' | 'Round';
|
|
8547
|
+
/** @public */
|
|
8548
|
+
export declare type StringPropertyName = 'name' | 'scene/pageFormatId' | 'type' | 'uuid' | 'page/titleTemplate' | 'audio/fileURI' | 'text/externalReference' | 'text/fontFileUri' | 'text/text' | 'text/typeface' | 'cutout/path' | 'caption/externalReference' | 'caption/fontFileUri' | 'caption/text' | 'caption/typeface' | 'effect/lut_filter/lutFileURI' | 'fill/image/externalReference' | 'fill/image/imageFileURI' | 'fill/image/previewFileURI' | 'fill/video/fileURI' | 'shape/vector_path/path' | (string & {});
|
|
8358
8549
|
|
|
8359
|
-
/**
|
|
8360
|
-
|
|
8361
|
-
*
|
|
8362
|
-
* @categoryDescription Stroke Position
|
|
8363
|
-
* Defines the possible positions for a stroke relative to the shape's boundary.
|
|
8364
|
-
* - 'Center': The stroke is centered on the shape's boundary.
|
|
8365
|
-
* - 'Inner': The stroke is inside the shape's boundary.
|
|
8366
|
-
* - 'Outer': The stroke is outside the shape's boundary.
|
|
8367
|
-
*
|
|
8368
|
-
* @public
|
|
8369
|
-
*/
|
|
8370
|
-
export declare type StrokePosition = 'Center' | 'Inner' | 'Outer';
|
|
8550
|
+
/** @public */
|
|
8551
|
+
export declare type StrokeCornerGeometry = (typeof StrokeCornerGeometryValues)[number];
|
|
8371
8552
|
|
|
8372
|
-
/**
|
|
8373
|
-
|
|
8374
|
-
|
|
8375
|
-
|
|
8376
|
-
|
|
8377
|
-
|
|
8378
|
-
|
|
8379
|
-
|
|
8380
|
-
|
|
8381
|
-
|
|
8382
|
-
|
|
8383
|
-
|
|
8384
|
-
|
|
8385
|
-
|
|
8386
|
-
export declare type StrokeStyle = 'Dashed' | 'DashedRound' | 'Dotted' | 'LongDashed' | 'LongDashedRound' | 'Solid';
|
|
8553
|
+
/** @public */
|
|
8554
|
+
export declare const StrokeCornerGeometryValues: readonly ["Bevel", "Miter", "Round"];
|
|
8555
|
+
|
|
8556
|
+
/** @public */
|
|
8557
|
+
export declare type StrokePosition = (typeof StrokePositionValues)[number];
|
|
8558
|
+
|
|
8559
|
+
/** @public */
|
|
8560
|
+
export declare const StrokePositionValues: readonly ["Center", "Inner", "Outer"];
|
|
8561
|
+
|
|
8562
|
+
/** @public */
|
|
8563
|
+
export declare type StrokeStyle = (typeof StrokeStyleValues)[number];
|
|
8564
|
+
|
|
8565
|
+
/** @public */
|
|
8566
|
+
export declare const StrokeStyleValues: readonly ["Dashed", "DashedRound", "Dotted", "LongDashed", "LongDashedRound", "Solid"];
|
|
8387
8567
|
|
|
8388
8568
|
/**
|
|
8389
8569
|
* Represents a subscription to an event.
|
|
@@ -8397,6 +8577,12 @@ export declare type StrokeStyle = 'Dashed' | 'DashedRound' | 'Dotted' | 'LongDas
|
|
|
8397
8577
|
*/
|
|
8398
8578
|
declare type Subscription = number;
|
|
8399
8579
|
|
|
8580
|
+
/** @public */
|
|
8581
|
+
export declare type TextAnimationWritingStyle = (typeof TextAnimationWritingStyleValues)[number];
|
|
8582
|
+
|
|
8583
|
+
/** @public */
|
|
8584
|
+
export declare const TextAnimationWritingStyleValues: readonly ["Block", "Line", "Character", "Word"];
|
|
8585
|
+
|
|
8400
8586
|
/**
|
|
8401
8587
|
* Represents the text case of a text block.
|
|
8402
8588
|
*
|
|
@@ -8424,6 +8610,34 @@ export declare interface TextFontSizeOptions {
|
|
|
8424
8610
|
to?: number;
|
|
8425
8611
|
}
|
|
8426
8612
|
|
|
8613
|
+
/** @public */
|
|
8614
|
+
declare type TextHorizontalAlignment = (typeof TextHorizontalAlignmentValues)[number];
|
|
8615
|
+
export { TextHorizontalAlignment as HorizontalTextAlignment }
|
|
8616
|
+
export { TextHorizontalAlignment }
|
|
8617
|
+
|
|
8618
|
+
/** @public */
|
|
8619
|
+
export declare const TextHorizontalAlignmentValues: readonly ["Left", "Right", "Center"];
|
|
8620
|
+
|
|
8621
|
+
/** @public */
|
|
8622
|
+
declare type TextVerticalAlignment = (typeof TextVerticalAlignmentValues)[number];
|
|
8623
|
+
export { TextVerticalAlignment }
|
|
8624
|
+
export { TextVerticalAlignment as VerticalTextAlignment }
|
|
8625
|
+
|
|
8626
|
+
/** @public */
|
|
8627
|
+
export declare const TextVerticalAlignmentValues: readonly ["Top", "Bottom", "Center"];
|
|
8628
|
+
|
|
8629
|
+
/** @public */
|
|
8630
|
+
export declare type TouchPinchAction = (typeof TouchPinchActionValues)[number];
|
|
8631
|
+
|
|
8632
|
+
/** @public */
|
|
8633
|
+
export declare const TouchPinchActionValues: readonly ["None", "Zoom", "Scale"];
|
|
8634
|
+
|
|
8635
|
+
/** @public */
|
|
8636
|
+
export declare type TouchRotateAction = (typeof TouchRotateActionValues)[number];
|
|
8637
|
+
|
|
8638
|
+
/** @public */
|
|
8639
|
+
export declare const TouchRotateActionValues: readonly ["None", "Rotate"];
|
|
8640
|
+
|
|
8427
8641
|
/**
|
|
8428
8642
|
* Represents a transient resource.
|
|
8429
8643
|
*
|
|
@@ -8638,25 +8852,8 @@ export declare interface Vec3 {
|
|
|
8638
8852
|
z: number;
|
|
8639
8853
|
}
|
|
8640
8854
|
|
|
8641
|
-
/**
|
|
8642
|
-
|
|
8643
|
-
*
|
|
8644
|
-
* The `VerticalBlockAlignment` type provides a set of values that control the
|
|
8645
|
-
* vertical alignment of blocks. These options include settings for aligning
|
|
8646
|
-
* blocks to the top, bottom, or center.
|
|
8647
|
-
*
|
|
8648
|
-
* @categoryDescription VerticalBlockAlignment
|
|
8649
|
-
* Methods for configuring the vertical alignment of blocks.
|
|
8650
|
-
*
|
|
8651
|
-
* @public
|
|
8652
|
-
*/
|
|
8653
|
-
export declare type VerticalBlockAlignment = 'Top' | 'Bottom' | 'Center';
|
|
8654
|
-
|
|
8655
|
-
/**
|
|
8656
|
-
* The vertical text alignment options.
|
|
8657
|
-
* @public
|
|
8658
|
-
*/
|
|
8659
|
-
export declare type VerticalTextAlignment = 'Top' | 'Bottom' | 'Center';
|
|
8855
|
+
/** @public */
|
|
8856
|
+
export declare type VerticalBlockAlignment = TextVerticalAlignment;
|
|
8660
8857
|
|
|
8661
8858
|
/**
|
|
8662
8859
|
* Represents the options for exporting a video.
|
|
@@ -8761,6 +8958,12 @@ export declare type VideoExportOptions = {
|
|
|
8761
8958
|
*/
|
|
8762
8959
|
export declare type VideoMimeType = Extract<MimeType_2, 'video/mp4' | 'video/quicktime'>;
|
|
8763
8960
|
|
|
8961
|
+
/** @public */
|
|
8962
|
+
export declare type WidthMode = (typeof WidthModeValues)[number];
|
|
8963
|
+
|
|
8964
|
+
/** @public */
|
|
8965
|
+
export declare const WidthModeValues: readonly ["Absolute", "Percent", "Auto"];
|
|
8966
|
+
|
|
8764
8967
|
/**
|
|
8765
8968
|
* Describes a rectangle on the screen.
|
|
8766
8969
|
*
|