@cesdk/node 1.64.0-nightly.20251030 → 1.64.0-nightly.20251105
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.20251105-EI2EU6XZ.wasm} +0 -0
- package/index.d.ts +592 -370
- 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.20251105-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.
|
|
@@ -294,13 +357,20 @@ export declare class AssetAPI {
|
|
|
294
357
|
* and an `assets` array with asset definitions. Each asset should have an `id`, localized `label` object,
|
|
295
358
|
* and a `meta` object containing asset-specific properties like `uri`, `thumbUri`, `blockType`, etc.
|
|
296
359
|
*
|
|
360
|
+
* Optionally, you can provide a `basePath` for resolving relative URLs and additional options including a
|
|
361
|
+
* `matcher` array to filter which assets are loaded based on their IDs. The matcher patterns support wildcard
|
|
362
|
+
* matching using `*`. If multiple patterns are provided, an asset is included if it matches ANY of the patterns.
|
|
363
|
+
*
|
|
297
364
|
* @category Asset Source Management
|
|
298
365
|
* @param contentJSON - The JSON string containing the asset definitions.
|
|
299
366
|
* @param basePath - An optional base path with which \{\{base_url\}\} strings in the assets should be replaced. If no value is provided, settings.basePath is used.
|
|
367
|
+
* @param options - Optional configuration:
|
|
368
|
+
* - `matcher`: Array of patterns to filter assets by ID. Supports `*` wildcard. An asset is included if it matches ANY pattern.
|
|
300
369
|
* @returns The ID of the newly created asset source (as specified in the JSON's `id` field).
|
|
301
370
|
*
|
|
302
371
|
* @example
|
|
303
372
|
* ```javascript
|
|
373
|
+
* // Load all assets from JSON
|
|
304
374
|
* const json = JSON.stringify({
|
|
305
375
|
* "version": "2.0.0",
|
|
306
376
|
* "id": "my.custom.assets",
|
|
@@ -318,9 +388,31 @@ export declare class AssetAPI {
|
|
|
318
388
|
* });
|
|
319
389
|
* const sourceId = await engine.asset.addLocalAssetSourceFromJSONString(json);
|
|
320
390
|
* console.log('Created asset source:', sourceId); // "my.custom.assets"
|
|
391
|
+
*
|
|
392
|
+
* // Load with custom base path
|
|
393
|
+
* const sourceId2 = await engine.asset.addLocalAssetSourceFromJSONString(
|
|
394
|
+
* json,
|
|
395
|
+
* 'https://example.com/'
|
|
396
|
+
* );
|
|
397
|
+
*
|
|
398
|
+
* // Load only assets matching one of the patterns
|
|
399
|
+
* const sourceId3 = await engine.asset.addLocalAssetSourceFromJSONString(
|
|
400
|
+
* json,
|
|
401
|
+
* undefined,
|
|
402
|
+
* { matcher: ['sample_*', '*_asset'] }
|
|
403
|
+
* );
|
|
404
|
+
*
|
|
405
|
+
* // Load with custom base path and matcher
|
|
406
|
+
* const sourceId4 = await engine.asset.addLocalAssetSourceFromJSONString(
|
|
407
|
+
* json,
|
|
408
|
+
* 'https://example.com/',
|
|
409
|
+
* { matcher: ['portrait_*', 'landscape_*'] }
|
|
410
|
+
* );
|
|
321
411
|
* ```
|
|
322
412
|
*/
|
|
323
|
-
addLocalAssetSourceFromJSONString(contentJSON: string, basePath?: string
|
|
413
|
+
addLocalAssetSourceFromJSONString(contentJSON: string, basePath?: string, options?: {
|
|
414
|
+
matcher?: string[];
|
|
415
|
+
}): Promise<string>;
|
|
324
416
|
/**
|
|
325
417
|
* Creates a new local asset source from a JSON URI.
|
|
326
418
|
*
|
|
@@ -334,38 +426,28 @@ export declare class AssetAPI {
|
|
|
334
426
|
*
|
|
335
427
|
* @category Asset Source Management
|
|
336
428
|
* @param contentURI - The URI for the JSON file to load and parse.
|
|
429
|
+
* @param options - Optional configuration:
|
|
430
|
+
* - `matcher`: Array of patterns to filter assets by ID. Supports `*` wildcard. An asset is included if it matches ANY pattern.
|
|
337
431
|
* @returns The ID of the newly created asset source (as specified in the JSON's `id` field).
|
|
338
432
|
*
|
|
339
433
|
* @example
|
|
340
434
|
* ```javascript
|
|
341
|
-
* // Load audio assets from IMG.LY's CDN
|
|
435
|
+
* // Load all audio assets from IMG.LY's CDN
|
|
342
436
|
* const sourceId = await engine.asset.addLocalAssetSourceFromJSONURI(
|
|
343
437
|
* 'https://cdn.img.ly/assets/demo/v2/ly.img.audio/content.json'
|
|
344
438
|
* );
|
|
345
439
|
* console.log('Loaded asset source:', sourceId); // "ly.img.audio"
|
|
346
440
|
*
|
|
347
|
-
* //
|
|
348
|
-
*
|
|
349
|
-
*
|
|
350
|
-
*
|
|
351
|
-
*
|
|
352
|
-
*
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
* // "label": { "en": "Dance Harder" },
|
|
358
|
-
* // "meta": {
|
|
359
|
-
* // "uri": "https://cdn.img.ly/.../dance_harder.m4a",
|
|
360
|
-
* // "blockType": "//ly.img.ubq/audio",
|
|
361
|
-
* // "mimeType": "audio/x-m4a"
|
|
362
|
-
* // }
|
|
363
|
-
* // }
|
|
364
|
-
* // ]
|
|
365
|
-
* // }
|
|
366
|
-
* ```
|
|
367
|
-
*/
|
|
368
|
-
addLocalAssetSourceFromJSONURI(contentURI: string): Promise<string>;
|
|
441
|
+
* // Load only assets matching one of the patterns
|
|
442
|
+
* const sourceId2 = await engine.asset.addLocalAssetSourceFromJSONURI(
|
|
443
|
+
* 'https://cdn.img.ly/assets/demo/v2/ly.img.image/content.json',
|
|
444
|
+
* { matcher: ['image-portrait-*', 'image-landscape-*'] }
|
|
445
|
+
* );
|
|
446
|
+
* ```
|
|
447
|
+
*/
|
|
448
|
+
addLocalAssetSourceFromJSONURI(contentURI: string, options?: {
|
|
449
|
+
matcher?: string[];
|
|
450
|
+
}): Promise<string>;
|
|
369
451
|
/**
|
|
370
452
|
* Remove a registered asset source.
|
|
371
453
|
*
|
|
@@ -820,7 +902,7 @@ export declare interface AssetFixedSize {
|
|
|
820
902
|
type: 'FixedSize';
|
|
821
903
|
width: number;
|
|
822
904
|
height: number;
|
|
823
|
-
designUnit:
|
|
905
|
+
designUnit: SceneDesignUnit;
|
|
824
906
|
}
|
|
825
907
|
|
|
826
908
|
/**
|
|
@@ -1240,42 +1322,11 @@ export declare interface AudioTrackInfo {
|
|
|
1240
1322
|
language: string;
|
|
1241
1323
|
}
|
|
1242
1324
|
|
|
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';
|
|
1325
|
+
/** @public */
|
|
1326
|
+
export declare type BlendMode = (typeof BlendModeValues)[number];
|
|
1327
|
+
|
|
1328
|
+
/** @public */
|
|
1329
|
+
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
1330
|
|
|
1280
1331
|
/**
|
|
1281
1332
|
* Create, manipulate, and query the building blocks of your design.
|
|
@@ -2069,7 +2120,7 @@ export declare class BlockAPI {
|
|
|
2069
2120
|
* @param id - The block to query.
|
|
2070
2121
|
* @returns The current mode for the x position: 'Absolute' or 'Percent'.
|
|
2071
2122
|
*/
|
|
2072
|
-
getPositionXMode(id: DesignBlockId):
|
|
2123
|
+
getPositionXMode(id: DesignBlockId): PositionXMode;
|
|
2073
2124
|
/**
|
|
2074
2125
|
* Gets the Y position of a block.
|
|
2075
2126
|
*
|
|
@@ -2085,7 +2136,7 @@ export declare class BlockAPI {
|
|
|
2085
2136
|
* @param id - The block to query.
|
|
2086
2137
|
* @returns The current mode for the y position: 'Absolute' or 'Percent'.
|
|
2087
2138
|
*/
|
|
2088
|
-
getPositionYMode(id: DesignBlockId):
|
|
2139
|
+
getPositionYMode(id: DesignBlockId): PositionYMode;
|
|
2089
2140
|
/**
|
|
2090
2141
|
* Sets the X position of a block.
|
|
2091
2142
|
*
|
|
@@ -2111,7 +2162,7 @@ export declare class BlockAPI {
|
|
|
2111
2162
|
* @param id - The block to update.
|
|
2112
2163
|
* @param mode - The x position mode: 'Absolute' or 'Percent'.
|
|
2113
2164
|
*/
|
|
2114
|
-
setPositionXMode(id: DesignBlockId, mode:
|
|
2165
|
+
setPositionXMode(id: DesignBlockId, mode: PositionXMode): void;
|
|
2115
2166
|
/**
|
|
2116
2167
|
* Sets the Y position of a block.
|
|
2117
2168
|
*
|
|
@@ -2137,7 +2188,7 @@ export declare class BlockAPI {
|
|
|
2137
2188
|
* @param id - The block to update.
|
|
2138
2189
|
* @param mode - The y position mode: 'Absolute' or 'Percent'.
|
|
2139
2190
|
*/
|
|
2140
|
-
setPositionYMode(id: DesignBlockId, mode:
|
|
2191
|
+
setPositionYMode(id: DesignBlockId, mode: PositionYMode): void;
|
|
2141
2192
|
/**
|
|
2142
2193
|
* Sets a block to always be rendered on top of its siblings.
|
|
2143
2194
|
*
|
|
@@ -2300,7 +2351,7 @@ export declare class BlockAPI {
|
|
|
2300
2351
|
* @param id - The block to query.
|
|
2301
2352
|
* @returns The current mode for the width: 'Absolute', 'Percent' or 'Auto'.
|
|
2302
2353
|
*/
|
|
2303
|
-
getWidthMode(id: DesignBlockId):
|
|
2354
|
+
getWidthMode(id: DesignBlockId): WidthMode;
|
|
2304
2355
|
/**
|
|
2305
2356
|
* Gets the height of a block in the current height mode.
|
|
2306
2357
|
*
|
|
@@ -2324,7 +2375,7 @@ export declare class BlockAPI {
|
|
|
2324
2375
|
* @param id - The block to query.
|
|
2325
2376
|
* @returns The current mode for the height: 'Absolute', 'Percent' or 'Auto'.
|
|
2326
2377
|
*/
|
|
2327
|
-
getHeightMode(id: DesignBlockId):
|
|
2378
|
+
getHeightMode(id: DesignBlockId): HeightMode;
|
|
2328
2379
|
/**
|
|
2329
2380
|
* Update a block's size.
|
|
2330
2381
|
*
|
|
@@ -2379,7 +2430,7 @@ export declare class BlockAPI {
|
|
|
2379
2430
|
* @param id - The block to update.
|
|
2380
2431
|
* @param mode - The width mode: 'Absolute', 'Percent' or 'Auto'.
|
|
2381
2432
|
*/
|
|
2382
|
-
setWidthMode(id: DesignBlockId, mode:
|
|
2433
|
+
setWidthMode(id: DesignBlockId, mode: WidthMode): void;
|
|
2383
2434
|
/**
|
|
2384
2435
|
* Sets the height of a block in the current height mode.
|
|
2385
2436
|
*
|
|
@@ -2407,7 +2458,7 @@ export declare class BlockAPI {
|
|
|
2407
2458
|
* @param id - The block to update.
|
|
2408
2459
|
* @param mode - The height mode: 'Absolute', 'Percent' or 'Auto'.
|
|
2409
2460
|
*/
|
|
2410
|
-
setHeightMode(id: DesignBlockId, mode:
|
|
2461
|
+
setHeightMode(id: DesignBlockId, mode: HeightMode): void;
|
|
2411
2462
|
/**
|
|
2412
2463
|
* Gets the final calculated X position of a block's frame.
|
|
2413
2464
|
*
|
|
@@ -2636,7 +2687,7 @@ export declare class BlockAPI {
|
|
|
2636
2687
|
* @param ids - A non-empty array of block ids.
|
|
2637
2688
|
* @param horizontalBlockAlignment - How they should be aligned: 'Left', 'Right', or 'Center'.
|
|
2638
2689
|
*/
|
|
2639
|
-
alignHorizontally(ids: DesignBlockId[], horizontalBlockAlignment:
|
|
2690
|
+
alignHorizontally(ids: DesignBlockId[], horizontalBlockAlignment: TextHorizontalAlignment): void;
|
|
2640
2691
|
/**
|
|
2641
2692
|
* Aligns blocks vertically.
|
|
2642
2693
|
*
|
|
@@ -2646,7 +2697,7 @@ export declare class BlockAPI {
|
|
|
2646
2697
|
* @param ids - A non-empty array of block ids.
|
|
2647
2698
|
* @param verticalBlockAlignment - How they should be aligned: 'Top', 'Bottom', or 'Center'.
|
|
2648
2699
|
*/
|
|
2649
|
-
alignVertically(ids: DesignBlockId[], verticalBlockAlignment:
|
|
2700
|
+
alignVertically(ids: DesignBlockId[], verticalBlockAlignment: TextVerticalAlignment): void;
|
|
2650
2701
|
/**
|
|
2651
2702
|
* Checks if a set of blocks can be aligned.
|
|
2652
2703
|
*
|
|
@@ -2776,7 +2827,7 @@ export declare class BlockAPI {
|
|
|
2776
2827
|
* @param property - The name of the property to set.
|
|
2777
2828
|
* @param value - The value to set.
|
|
2778
2829
|
*/
|
|
2779
|
-
setBool(id: DesignBlockId, property:
|
|
2830
|
+
setBool(id: DesignBlockId, property: BoolPropertyName, value: boolean): void;
|
|
2780
2831
|
/**
|
|
2781
2832
|
* Gets a boolean property from a block.
|
|
2782
2833
|
*
|
|
@@ -2789,7 +2840,7 @@ export declare class BlockAPI {
|
|
|
2789
2840
|
* @param property - The name of the property to query.
|
|
2790
2841
|
* @returns The value of the property.
|
|
2791
2842
|
*/
|
|
2792
|
-
getBool(id: DesignBlockId, property:
|
|
2843
|
+
getBool(id: DesignBlockId, property: BoolPropertyName): boolean;
|
|
2793
2844
|
/**
|
|
2794
2845
|
* Sets an integer property on a block.
|
|
2795
2846
|
*
|
|
@@ -2802,7 +2853,7 @@ export declare class BlockAPI {
|
|
|
2802
2853
|
* @param property - The name of the property to set.
|
|
2803
2854
|
* @param value - The value to set.
|
|
2804
2855
|
*/
|
|
2805
|
-
setInt(id: DesignBlockId, property:
|
|
2856
|
+
setInt(id: DesignBlockId, property: IntPropertyName, value: number): void;
|
|
2806
2857
|
/**
|
|
2807
2858
|
* Gets an integer property from a block.
|
|
2808
2859
|
*
|
|
@@ -2815,7 +2866,7 @@ export declare class BlockAPI {
|
|
|
2815
2866
|
* @param property - The name of the property to query.
|
|
2816
2867
|
* @returns The value of the property.
|
|
2817
2868
|
*/
|
|
2818
|
-
getInt(id: DesignBlockId, property:
|
|
2869
|
+
getInt(id: DesignBlockId, property: IntPropertyName): number;
|
|
2819
2870
|
/**
|
|
2820
2871
|
* Sets a float property on a block.
|
|
2821
2872
|
*
|
|
@@ -2829,7 +2880,7 @@ export declare class BlockAPI {
|
|
|
2829
2880
|
* @param property - The name of the property to set.
|
|
2830
2881
|
* @param value - The value to set.
|
|
2831
2882
|
*/
|
|
2832
|
-
setFloat(id: DesignBlockId, property:
|
|
2883
|
+
setFloat(id: DesignBlockId, property: FloatPropertyName, value: number): void;
|
|
2833
2884
|
/**
|
|
2834
2885
|
* Gets a float property from a block.
|
|
2835
2886
|
*
|
|
@@ -2842,7 +2893,7 @@ export declare class BlockAPI {
|
|
|
2842
2893
|
* @param property - The name of the property to query.
|
|
2843
2894
|
* @returns The value of the property.
|
|
2844
2895
|
*/
|
|
2845
|
-
getFloat(id: DesignBlockId, property:
|
|
2896
|
+
getFloat(id: DesignBlockId, property: FloatPropertyName): number;
|
|
2846
2897
|
/**
|
|
2847
2898
|
* Sets a double-precision float property on a block.
|
|
2848
2899
|
*
|
|
@@ -2855,7 +2906,7 @@ export declare class BlockAPI {
|
|
|
2855
2906
|
* @param property - The name of the property to set.
|
|
2856
2907
|
* @param value - The value to set.
|
|
2857
2908
|
*/
|
|
2858
|
-
setDouble(id: DesignBlockId, property:
|
|
2909
|
+
setDouble(id: DesignBlockId, property: DoublePropertyName, value: number): void;
|
|
2859
2910
|
/**
|
|
2860
2911
|
* Gets a double-precision float property from a block.
|
|
2861
2912
|
*
|
|
@@ -2868,7 +2919,7 @@ export declare class BlockAPI {
|
|
|
2868
2919
|
* @param property - The name of the property to query.
|
|
2869
2920
|
* @returns The value of the property.
|
|
2870
2921
|
*/
|
|
2871
|
-
getDouble(id: DesignBlockId, property:
|
|
2922
|
+
getDouble(id: DesignBlockId, property: DoublePropertyName): number;
|
|
2872
2923
|
/**
|
|
2873
2924
|
* Sets a string property on a block.
|
|
2874
2925
|
*
|
|
@@ -2882,7 +2933,7 @@ export declare class BlockAPI {
|
|
|
2882
2933
|
* @param property - The name of the property to set.
|
|
2883
2934
|
* @param value - The value to set.
|
|
2884
2935
|
*/
|
|
2885
|
-
setString(id: DesignBlockId, property:
|
|
2936
|
+
setString(id: DesignBlockId, property: StringPropertyName, value: string): void;
|
|
2886
2937
|
/**
|
|
2887
2938
|
* Gets a string property from a block.
|
|
2888
2939
|
*
|
|
@@ -2896,7 +2947,7 @@ export declare class BlockAPI {
|
|
|
2896
2947
|
* @param property - The name of the property to query.
|
|
2897
2948
|
* @returns The value of the property.
|
|
2898
2949
|
*/
|
|
2899
|
-
getString(id: DesignBlockId, property:
|
|
2950
|
+
getString(id: DesignBlockId, property: StringPropertyName): string;
|
|
2900
2951
|
/**
|
|
2901
2952
|
* Sets a color property on a block.
|
|
2902
2953
|
*
|
|
@@ -2910,7 +2961,7 @@ export declare class BlockAPI {
|
|
|
2910
2961
|
* @param property - The name of the property to set.
|
|
2911
2962
|
* @param value - The value to set.
|
|
2912
2963
|
*/
|
|
2913
|
-
setColor(id: DesignBlockId, property:
|
|
2964
|
+
setColor(id: DesignBlockId, property: ColorPropertyName, value: Color): void;
|
|
2914
2965
|
/**
|
|
2915
2966
|
* Gets a color property from a block.
|
|
2916
2967
|
*
|
|
@@ -2923,7 +2974,7 @@ export declare class BlockAPI {
|
|
|
2923
2974
|
* @param property - The name of the property to query.
|
|
2924
2975
|
* @returns The value of the property.
|
|
2925
2976
|
*/
|
|
2926
|
-
getColor(id: DesignBlockId, property:
|
|
2977
|
+
getColor(id: DesignBlockId, property: ColorPropertyName): Color;
|
|
2927
2978
|
/**
|
|
2928
2979
|
* Sets a color property on a block using RGBA values.
|
|
2929
2980
|
*
|
|
@@ -3019,7 +3070,7 @@ export declare class BlockAPI {
|
|
|
3019
3070
|
* @param property - The name of the property to query, e.g. 'fill/image/sourceSet'.
|
|
3020
3071
|
* @returns The block's source set.
|
|
3021
3072
|
*/
|
|
3022
|
-
getSourceSet(id: DesignBlockId, property:
|
|
3073
|
+
getSourceSet(id: DesignBlockId, property: SourceSetPropertyName): Source[];
|
|
3023
3074
|
/**
|
|
3024
3075
|
* Sets the source set for a block property.
|
|
3025
3076
|
*
|
|
@@ -3038,7 +3089,7 @@ export declare class BlockAPI {
|
|
|
3038
3089
|
* @param property - The name of the property to set.
|
|
3039
3090
|
* @param sourceSet - The block's new source set.
|
|
3040
3091
|
*/
|
|
3041
|
-
setSourceSet(id: DesignBlockId, property:
|
|
3092
|
+
setSourceSet(id: DesignBlockId, property: SourceSetPropertyName, sourceSet: Source[]): void;
|
|
3042
3093
|
/**
|
|
3043
3094
|
* Adds an image file URI to a source set property.
|
|
3044
3095
|
*
|
|
@@ -3054,7 +3105,7 @@ export declare class BlockAPI {
|
|
|
3054
3105
|
* @param uri - The source to add to the source set.
|
|
3055
3106
|
* @returns A promise that resolves when the operation is complete.
|
|
3056
3107
|
*/
|
|
3057
|
-
addImageFileURIToSourceSet(id: DesignBlockId, property:
|
|
3108
|
+
addImageFileURIToSourceSet(id: DesignBlockId, property: SourceSetPropertyName, uri: string): Promise<void>;
|
|
3058
3109
|
/**
|
|
3059
3110
|
* Adds a video file URI to a source set property.
|
|
3060
3111
|
*
|
|
@@ -3070,7 +3121,7 @@ export declare class BlockAPI {
|
|
|
3070
3121
|
* @param uri - The source to add to the source set.
|
|
3071
3122
|
* @returns A promise that resolves when the operation is complete.
|
|
3072
3123
|
*/
|
|
3073
|
-
addVideoFileURIToSourceSet(id: DesignBlockId, property:
|
|
3124
|
+
addVideoFileURIToSourceSet(id: DesignBlockId, property: SourceSetPropertyName, uri: string): Promise<void>;
|
|
3074
3125
|
/**
|
|
3075
3126
|
* Sets an enum property on a block.
|
|
3076
3127
|
*
|
|
@@ -3084,7 +3135,8 @@ export declare class BlockAPI {
|
|
|
3084
3135
|
* @param property - The name of the property to set.
|
|
3085
3136
|
* @param value - The enum value as a string.
|
|
3086
3137
|
*/
|
|
3087
|
-
setEnum<T extends
|
|
3138
|
+
setEnum<T extends keyof BlockEnumType>(id: DesignBlockId, property: T, value: BlockEnumType[T]): void;
|
|
3139
|
+
setEnum(id: DesignBlockId, property: string, value: string): void;
|
|
3088
3140
|
/**
|
|
3089
3141
|
* Gets an enum property from a block.
|
|
3090
3142
|
*
|
|
@@ -3098,7 +3150,8 @@ export declare class BlockAPI {
|
|
|
3098
3150
|
* @param property - The name of the property to query.
|
|
3099
3151
|
* @returns The value as a string.
|
|
3100
3152
|
*/
|
|
3101
|
-
getEnum<T extends
|
|
3153
|
+
getEnum<T extends keyof BlockEnumType>(id: DesignBlockId, property: T): BlockEnumType[T];
|
|
3154
|
+
getEnum(id: DesignBlockId, property: string): string;
|
|
3102
3155
|
/**
|
|
3103
3156
|
* Checks if a block has crop properties.
|
|
3104
3157
|
*
|
|
@@ -5021,6 +5074,14 @@ export declare class BlockAPI {
|
|
|
5021
5074
|
* @param muted - Whether the audio should be muted.
|
|
5022
5075
|
*/
|
|
5023
5076
|
setMuted(id: DesignBlockId, muted: boolean): void;
|
|
5077
|
+
/**
|
|
5078
|
+
* Checks if a block's audio is muted due to engine rules.
|
|
5079
|
+
*
|
|
5080
|
+
* @category Block Video
|
|
5081
|
+
* @param id - The block to query.
|
|
5082
|
+
* @returns Whether the block is force muted.
|
|
5083
|
+
*/
|
|
5084
|
+
isForceMuted(id: DesignBlockId): boolean;
|
|
5024
5085
|
/**
|
|
5025
5086
|
* Checks if a block's audio is muted.
|
|
5026
5087
|
*
|
|
@@ -5048,10 +5109,12 @@ export declare class BlockAPI {
|
|
|
5048
5109
|
/**
|
|
5049
5110
|
* Sets the playback speed multiplier of a block that supports playback control.
|
|
5050
5111
|
* Note: This also adjusts the trim and duration of the block.
|
|
5112
|
+
* Video fills running faster than 3.0x are force muted until reduced to 3.0x or below.
|
|
5051
5113
|
*
|
|
5052
5114
|
* @category Block Video
|
|
5053
5115
|
* @param id - The block or video fill to update.
|
|
5054
|
-
* @param speed - The desired playback speed multiplier
|
|
5116
|
+
* @param speed - The desired playback speed multiplier. Valid range is [0.25, 3.0] for audio blocks and
|
|
5117
|
+
* [0.25, infinity) for video fills.
|
|
5055
5118
|
*/
|
|
5056
5119
|
setPlaybackSpeed(id: DesignBlockId, speed: number): void;
|
|
5057
5120
|
/**
|
|
@@ -5374,6 +5437,40 @@ export declare class BlockAPI {
|
|
|
5374
5437
|
moveToBackgroundTrack(block: DesignBlockId): void;
|
|
5375
5438
|
}
|
|
5376
5439
|
|
|
5440
|
+
/** @public */
|
|
5441
|
+
export declare type BlockEnumType = {
|
|
5442
|
+
'blend/mode': BlendMode;
|
|
5443
|
+
'contentFill/mode': ContentFillMode;
|
|
5444
|
+
'height/mode': HeightMode;
|
|
5445
|
+
'position/x/mode': PositionXMode;
|
|
5446
|
+
'position/y/mode': PositionYMode;
|
|
5447
|
+
'scene/designUnit': SceneDesignUnit;
|
|
5448
|
+
'scene/layout': SceneLayout;
|
|
5449
|
+
'scene/mode': SceneMode;
|
|
5450
|
+
'width/mode': WidthMode;
|
|
5451
|
+
'stroke/cornerGeometry': StrokeCornerGeometry;
|
|
5452
|
+
'stroke/position': StrokePosition;
|
|
5453
|
+
'stroke/style': StrokeStyle;
|
|
5454
|
+
'text/horizontalAlignment': TextHorizontalAlignment;
|
|
5455
|
+
'text/verticalAlignment': TextVerticalAlignment;
|
|
5456
|
+
'cutout/type': CutoutType;
|
|
5457
|
+
'caption/horizontalAlignment': CaptionHorizontalAlignment;
|
|
5458
|
+
'caption/verticalAlignment': CaptionVerticalAlignment;
|
|
5459
|
+
animationEasing: AnimationEasing;
|
|
5460
|
+
textAnimationWritingStyle: TextAnimationWritingStyle;
|
|
5461
|
+
'animation/grow/direction': AnimationGrowDirection;
|
|
5462
|
+
'animation/wipe/direction': AnimationWipeDirection;
|
|
5463
|
+
'animation/baseline/direction': AnimationBaselineDirection;
|
|
5464
|
+
'animation/spin/direction': AnimationSpinDirection;
|
|
5465
|
+
'animation/spin_loop/direction': AnimationSpinLoopDirection;
|
|
5466
|
+
'animation/jump_loop/direction': AnimationJumpLoopDirection;
|
|
5467
|
+
'animation/typewriter_text/writingStyle': AnimationTypewriterTextWritingStyle;
|
|
5468
|
+
'animation/block_swipe_text/direction': AnimationBlockSwipeTextDirection;
|
|
5469
|
+
'animation/merge_text/direction': AnimationMergeTextDirection;
|
|
5470
|
+
'animation/ken_burns/direction': AnimationKenBurnsDirection;
|
|
5471
|
+
'fill/pixelStream/orientation': FillPixelStreamOrientation;
|
|
5472
|
+
};
|
|
5473
|
+
|
|
5377
5474
|
/**
|
|
5378
5475
|
* Represents an event related to a design block.
|
|
5379
5476
|
*
|
|
@@ -5439,6 +5536,13 @@ export declare interface BlockStateReady {
|
|
|
5439
5536
|
type: 'Ready';
|
|
5440
5537
|
}
|
|
5441
5538
|
|
|
5539
|
+
/**
|
|
5540
|
+
* The shorthand block type IDs for the blur blocks. These are the IDs used to create new blurs
|
|
5541
|
+
* using `cesdk.engine.block.createBlur(id)`.
|
|
5542
|
+
* @public
|
|
5543
|
+
*/
|
|
5544
|
+
export declare const BLUR_TYPES: readonly ["uniform", "linear", "mirrored", "radial"];
|
|
5545
|
+
|
|
5442
5546
|
/**
|
|
5443
5547
|
* The block type IDs for the blur blocks. These are the IDs used to create new blurs
|
|
5444
5548
|
* using `cesdk.engine.block.createBlur(id)`.
|
|
@@ -5454,12 +5558,8 @@ export declare type BlurType = BlurTypeShorthand | BlurTypeLonghand;
|
|
|
5454
5558
|
*/
|
|
5455
5559
|
export declare type BlurTypeLonghand = `//ly.img.ubq/blur/${BlurTypeShorthand}`;
|
|
5456
5560
|
|
|
5457
|
-
/**
|
|
5458
|
-
|
|
5459
|
-
* using `cesdk.engine.block.createBlur(id)`.
|
|
5460
|
-
* @public
|
|
5461
|
-
*/
|
|
5462
|
-
export declare type BlurTypeShorthand = 'uniform' | 'linear' | 'mirrored' | 'radial';
|
|
5561
|
+
/** @public */
|
|
5562
|
+
export declare type BlurTypeShorthand = (typeof BLUR_TYPES)[number];
|
|
5463
5563
|
|
|
5464
5564
|
/**
|
|
5465
5565
|
* Represents the names of boolean operations.
|
|
@@ -5474,6 +5574,9 @@ export declare type BlurTypeShorthand = 'uniform' | 'linear' | 'mirrored' | 'rad
|
|
|
5474
5574
|
*/
|
|
5475
5575
|
export declare type BooleanOperation = 'Difference' | 'Intersection' | 'Union' | 'XOR';
|
|
5476
5576
|
|
|
5577
|
+
/** @public */
|
|
5578
|
+
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 & {});
|
|
5579
|
+
|
|
5477
5580
|
/**
|
|
5478
5581
|
* Represents a buffer of data.
|
|
5479
5582
|
*
|
|
@@ -5488,6 +5591,24 @@ declare interface Buffer_2 {
|
|
|
5488
5591
|
}
|
|
5489
5592
|
export { Buffer_2 as Buffer }
|
|
5490
5593
|
|
|
5594
|
+
/** @public */
|
|
5595
|
+
export declare type CameraClampingOvershootMode = (typeof CameraClampingOvershootModeValues)[number];
|
|
5596
|
+
|
|
5597
|
+
/** @public */
|
|
5598
|
+
export declare const CameraClampingOvershootModeValues: readonly ["Center", "Reverse"];
|
|
5599
|
+
|
|
5600
|
+
/** @public */
|
|
5601
|
+
export declare type CaptionHorizontalAlignment = (typeof CaptionHorizontalAlignmentValues)[number];
|
|
5602
|
+
|
|
5603
|
+
/** @public */
|
|
5604
|
+
export declare const CaptionHorizontalAlignmentValues: readonly ["Left", "Right", "Center"];
|
|
5605
|
+
|
|
5606
|
+
/** @public */
|
|
5607
|
+
export declare type CaptionVerticalAlignment = (typeof CaptionVerticalAlignmentValues)[number];
|
|
5608
|
+
|
|
5609
|
+
/** @public */
|
|
5610
|
+
export declare const CaptionVerticalAlignmentValues: readonly ["Top", "Bottom", "Center"];
|
|
5611
|
+
|
|
5491
5612
|
/**
|
|
5492
5613
|
* Represents a color in the CMYK color space.
|
|
5493
5614
|
*
|
|
@@ -5539,6 +5660,9 @@ export declare interface CMYKColor {
|
|
|
5539
5660
|
*/
|
|
5540
5661
|
export declare type Color = RGBAColor | CMYKColor | SpotColor;
|
|
5541
5662
|
|
|
5663
|
+
/** @public */
|
|
5664
|
+
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 & {});
|
|
5665
|
+
|
|
5542
5666
|
/**
|
|
5543
5667
|
* Represents the color space used in the editor.
|
|
5544
5668
|
*
|
|
@@ -5621,19 +5745,11 @@ export declare interface Configuration {
|
|
|
5621
5745
|
role?: RoleString;
|
|
5622
5746
|
}
|
|
5623
5747
|
|
|
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';
|
|
5748
|
+
/** @public */
|
|
5749
|
+
export declare type ContentFillMode = (typeof ContentFillModeValues)[number];
|
|
5750
|
+
|
|
5751
|
+
/** @public */
|
|
5752
|
+
export declare const ContentFillModeValues: readonly ["Crop", "Cover", "Contain"];
|
|
5637
5753
|
|
|
5638
5754
|
/**
|
|
5639
5755
|
* Options for creating a video scene.
|
|
@@ -5661,6 +5777,10 @@ export declare type CreateSceneOptions = {
|
|
|
5661
5777
|
*/
|
|
5662
5778
|
declare class CreativeEngine {
|
|
5663
5779
|
#private;
|
|
5780
|
+
/**
|
|
5781
|
+
* The version of the CE.SDK Node package.
|
|
5782
|
+
*/
|
|
5783
|
+
static readonly version: string;
|
|
5664
5784
|
asset: AssetAPI;
|
|
5665
5785
|
block: BlockAPI;
|
|
5666
5786
|
editor: EditorAPI;
|
|
@@ -5698,8 +5818,8 @@ declare class CreativeEngine {
|
|
|
5698
5818
|
* - `'ly.img.filter.lut'` - LUT effects of various kinds
|
|
5699
5819
|
* - `'ly.img.filter.duotone'` - Color effects of various kinds
|
|
5700
5820
|
*
|
|
5701
|
-
* These assets are parsed
|
|
5702
|
-
* `base_url` defaults to
|
|
5821
|
+
* These assets are parsed at \{\{base_url\}\}/<id>/content.json, where
|
|
5822
|
+
* `base_url` defaults to the IMG.LY CDN.
|
|
5703
5823
|
* Each source is created via `addLocalSource` and populated with the parsed assets. To modify the available
|
|
5704
5824
|
* assets, you may either exclude certain IDs via `excludeAssetSourceIds` or alter the sources after creation.
|
|
5705
5825
|
*
|
|
@@ -5708,7 +5828,7 @@ declare class CreativeEngine {
|
|
|
5708
5828
|
* @returns A promise that resolves when all asset sources are loaded.
|
|
5709
5829
|
*/
|
|
5710
5830
|
addDefaultAssetSources({ baseURL, excludeAssetSourceIds }?: {
|
|
5711
|
-
/** The source of the asset definitions, must be absolute. Defaults to
|
|
5831
|
+
/** The source of the asset definitions, must be absolute. Defaults to IMG.LY CDN. */
|
|
5712
5832
|
baseURL?: string;
|
|
5713
5833
|
/** A list of IDs, that will be ignored during load. */
|
|
5714
5834
|
excludeAssetSourceIds?: DefaultAssetSourceId[];
|
|
@@ -5730,7 +5850,9 @@ declare class CreativeEngine {
|
|
|
5730
5850
|
* @param options - Configuration options for loading demo asset sources.
|
|
5731
5851
|
* @returns A promise that resolves when all demo asset sources are loaded.
|
|
5732
5852
|
*/
|
|
5733
|
-
addDemoAssetSources({ excludeAssetSourceIds, sceneMode, withUploadAssetSources }?: {
|
|
5853
|
+
addDemoAssetSources({ baseURL, excludeAssetSourceIds, sceneMode, withUploadAssetSources }?: {
|
|
5854
|
+
/** The source of the demo asset definitions, must be absolute. Defaults to IMG.LY CDN. */
|
|
5855
|
+
baseURL?: string;
|
|
5734
5856
|
/** A list of IDs, that will be ignored during load */
|
|
5735
5857
|
excludeAssetSourceIds?: DemoAssetSourceId[];
|
|
5736
5858
|
/** If 'Video' video specific demo asset sources will be loaded as well (default 'Design') */
|
|
@@ -5738,23 +5860,25 @@ declare class CreativeEngine {
|
|
|
5738
5860
|
/** If 'true' asset sources for uploads are added (default false) */
|
|
5739
5861
|
withUploadAssetSources?: boolean;
|
|
5740
5862
|
}): Promise<void>;
|
|
5863
|
+
/**
|
|
5864
|
+
* Returns the configured base URL for the engine's assets.
|
|
5865
|
+
*
|
|
5866
|
+
* @category Engine Management
|
|
5867
|
+
* @returns The absolute base URL configured for this engine instance.
|
|
5868
|
+
*
|
|
5869
|
+
* @example
|
|
5870
|
+
* ```typescript
|
|
5871
|
+
* const engine = await CreativeEngine.init({
|
|
5872
|
+
* baseURL: 'https://my-cdn.example.com/assets/'
|
|
5873
|
+
* });
|
|
5874
|
+
*
|
|
5875
|
+
* console.log(engine.getBaseURL()); // 'https://my-cdn.example.com/assets/'
|
|
5876
|
+
* ```
|
|
5877
|
+
*/
|
|
5878
|
+
getBaseURL(): string;
|
|
5741
5879
|
}
|
|
5742
5880
|
export default CreativeEngine;
|
|
5743
5881
|
|
|
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
5882
|
/**
|
|
5759
5883
|
* Represents the type of a cutout.
|
|
5760
5884
|
*
|
|
@@ -5765,7 +5889,13 @@ export declare type CutoutOperation = 'Difference' | 'Intersection' | 'Union' |
|
|
|
5765
5889
|
*
|
|
5766
5890
|
* @public
|
|
5767
5891
|
*/
|
|
5768
|
-
export declare type
|
|
5892
|
+
export declare type CutoutOperation = 'Difference' | 'Intersection' | 'Union' | 'XOR';
|
|
5893
|
+
|
|
5894
|
+
/** @public */
|
|
5895
|
+
export declare type CutoutType = (typeof CutoutTypeValues)[number];
|
|
5896
|
+
|
|
5897
|
+
/** @public */
|
|
5898
|
+
export declare const CutoutTypeValues: readonly ["Solid", "Dashed"];
|
|
5769
5899
|
|
|
5770
5900
|
/**
|
|
5771
5901
|
* Represents the default asset source IDs used in the editor.
|
|
@@ -5808,6 +5938,13 @@ export declare type DefaultAssetSourceId = 'ly.img.sticker' | 'ly.img.vectorpath
|
|
|
5808
5938
|
*/
|
|
5809
5939
|
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
5940
|
|
|
5941
|
+
/**
|
|
5942
|
+
* The shorthand block type IDs for the top-level design blocks. These are the IDs used to create new blocks
|
|
5943
|
+
* using `cesdk.engine.block.create(id)`.
|
|
5944
|
+
* @public
|
|
5945
|
+
*/
|
|
5946
|
+
export declare const DESIGN_BLOCK_TYPES: readonly ["scene", "stack", "camera", "page", "graphic", "audio", "text", "group", "cutout", "track", "caption", "captionTrack"];
|
|
5947
|
+
|
|
5811
5948
|
/**
|
|
5812
5949
|
* A numerical identifier for a design block
|
|
5813
5950
|
* @public
|
|
@@ -5829,18 +5966,17 @@ export declare type DesignBlockType = DesignBlockTypeShorthand | DesignBlockType
|
|
|
5829
5966
|
*/
|
|
5830
5967
|
export declare type DesignBlockTypeLonghand = `//ly.img.ubq/${DesignBlockTypeShorthand}`;
|
|
5831
5968
|
|
|
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';
|
|
5969
|
+
/** @public */
|
|
5970
|
+
export declare type DesignBlockTypeShorthand = (typeof DESIGN_BLOCK_TYPES)[number];
|
|
5838
5971
|
|
|
5839
|
-
/**
|
|
5840
|
-
|
|
5841
|
-
|
|
5842
|
-
*/
|
|
5843
|
-
export declare
|
|
5972
|
+
/** @public */
|
|
5973
|
+
export declare type DoubleClickSelectionMode = (typeof DoubleClickSelectionModeValues)[number];
|
|
5974
|
+
|
|
5975
|
+
/** @public */
|
|
5976
|
+
export declare const DoubleClickSelectionModeValues: readonly ["Direct", "Hierarchical"];
|
|
5977
|
+
|
|
5978
|
+
/** @public */
|
|
5979
|
+
export declare type DoublePropertyName = 'playback/time' | 'playback/duration' | 'playback/timeOffset' | 'audio/totalDuration' | 'playback/trimLength' | 'playback/trimOffset' | 'fill/video/totalDuration' | (string & {});
|
|
5844
5980
|
|
|
5845
5981
|
/**
|
|
5846
5982
|
* Information about a single audio track from a video.
|
|
@@ -5894,14 +6030,6 @@ export declare type EditMode = 'Transform' | 'Crop' | 'Text' | 'Playback' | 'Tri
|
|
|
5894
6030
|
* resource handling, and global scope controls. It serves as the central configuration and control interface
|
|
5895
6031
|
* for the design editor engine.
|
|
5896
6032
|
*
|
|
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
6033
|
* @categoryDescription Edit Mode Management
|
|
5906
6034
|
* Control the editor's current editing mode and interaction state.
|
|
5907
6035
|
*
|
|
@@ -6153,7 +6281,7 @@ export declare class EditorAPI {
|
|
|
6153
6281
|
onRoleChanged: (callback: (role: RoleString) => void) => (() => void);
|
|
6154
6282
|
/**
|
|
6155
6283
|
* Set a setting value using the unified API.
|
|
6156
|
-
* The type
|
|
6284
|
+
* The value type is automatically validated based on the key.
|
|
6157
6285
|
*
|
|
6158
6286
|
* @category Editor Settings
|
|
6159
6287
|
* @param keypath - The setting key from Settings
|
|
@@ -6201,102 +6329,114 @@ export declare class EditorAPI {
|
|
|
6201
6329
|
/**
|
|
6202
6330
|
* Set a boolean setting value.
|
|
6203
6331
|
*
|
|
6204
|
-
* @deprecated Use setSetting() instead.
|
|
6205
|
-
*
|
|
6206
6332
|
* @category Editor Settings
|
|
6207
6333
|
* @param keypath - The settings keypath, e.g. `doubleClickToCropEnabled`.
|
|
6208
6334
|
* @param value - The boolean value to set.
|
|
6209
6335
|
* @throws Error if the keypath is invalid.
|
|
6210
6336
|
*/
|
|
6211
|
-
setSettingBool(keypath:
|
|
6337
|
+
setSettingBool(keypath: SettingsBool, value: boolean): void;
|
|
6338
|
+
/** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
|
|
6339
|
+
setSettingBool(keypath: `ubq://${SettingsBool}`, value: boolean): void;
|
|
6212
6340
|
/**
|
|
6213
6341
|
* Get a boolean setting value.
|
|
6214
6342
|
*
|
|
6215
|
-
* @deprecated Use getSetting() instead.
|
|
6216
6343
|
* @category Editor Settings
|
|
6217
6344
|
* @param keypath - The settings keypath, e.g. `doubleClickToCropEnabled`.
|
|
6218
6345
|
* @returns The boolean value of the setting.
|
|
6219
6346
|
* @throws Error if the keypath is invalid.
|
|
6220
6347
|
*/
|
|
6221
|
-
getSettingBool(keypath:
|
|
6348
|
+
getSettingBool(keypath: SettingsBool): boolean;
|
|
6349
|
+
/** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
|
|
6350
|
+
getSettingBool(keypath: `ubq://${SettingsBool}`): boolean;
|
|
6351
|
+
getSettingBool(keypath: SettingBoolPropertyName): boolean;
|
|
6222
6352
|
/**
|
|
6223
6353
|
* Set an integer setting value.
|
|
6224
6354
|
*
|
|
6225
|
-
* @deprecated Use setSetting() instead.
|
|
6226
6355
|
* @category Editor Settings
|
|
6227
6356
|
* @param keypath - The settings keypath.
|
|
6228
6357
|
* @param value - The integer value to set.
|
|
6229
6358
|
* @throws Error if the keypath is invalid.
|
|
6230
6359
|
*/
|
|
6231
6360
|
setSettingInt(keypath: SettingsInt, value: number): void;
|
|
6361
|
+
setSettingInt(keypath: SettingIntPropertyName, value: number): void;
|
|
6232
6362
|
/**
|
|
6233
6363
|
* Get an integer setting value.
|
|
6234
6364
|
*
|
|
6235
|
-
* @deprecated Use getSetting() instead.
|
|
6236
6365
|
* @category Editor Settings
|
|
6237
6366
|
* @param keypath - The settings keypath.
|
|
6238
6367
|
* @returns The integer value of the setting.
|
|
6239
6368
|
* @throws Error if the keypath is invalid.
|
|
6240
6369
|
*/
|
|
6241
6370
|
getSettingInt(keypath: SettingsInt): number;
|
|
6371
|
+
getSettingInt(keypath: SettingIntPropertyName): number;
|
|
6242
6372
|
/**
|
|
6243
6373
|
* Set a float setting value.
|
|
6244
6374
|
*
|
|
6245
|
-
* @deprecated Use setSetting() instead.
|
|
6246
6375
|
* @category Editor Settings
|
|
6247
6376
|
* @param keypath - The settings keypath, e.g. `positionSnappingThreshold`.
|
|
6248
6377
|
* @param value - The float value to set.
|
|
6249
6378
|
* @throws Error if the keypath is invalid.
|
|
6250
6379
|
*/
|
|
6251
|
-
setSettingFloat(keypath:
|
|
6380
|
+
setSettingFloat(keypath: SettingsFloat, value: number): void;
|
|
6381
|
+
/** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
|
|
6382
|
+
setSettingFloat(keypath: `ubq://${SettingsFloat}`, value: number): void;
|
|
6383
|
+
setSettingFloat(keypath: SettingFloatPropertyName, value: number): void;
|
|
6252
6384
|
/**
|
|
6253
6385
|
* Get a float setting value.
|
|
6254
6386
|
*
|
|
6255
|
-
* @deprecated Use getSetting() instead.
|
|
6256
6387
|
* @category Editor Settings
|
|
6257
6388
|
* @param keypath - The settings keypath, e.g. `positionSnappingThreshold`.
|
|
6258
6389
|
* @returns The float value of the setting.
|
|
6259
6390
|
* @throws Error if the keypath is invalid.
|
|
6260
6391
|
*/
|
|
6261
|
-
getSettingFloat(keypath:
|
|
6392
|
+
getSettingFloat(keypath: SettingsFloat): number;
|
|
6393
|
+
/** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
|
|
6394
|
+
getSettingFloat(keypath: `ubq://${SettingsFloat}`): number;
|
|
6395
|
+
getSettingFloat(keypath: SettingFloatPropertyName): number;
|
|
6262
6396
|
/**
|
|
6263
6397
|
* Set a string setting value.
|
|
6264
6398
|
*
|
|
6265
|
-
* @deprecated Use setSetting() instead.
|
|
6266
6399
|
* @category Editor Settings
|
|
6267
6400
|
* @param keypath - The settings keypath, e.g. `license`.
|
|
6268
6401
|
* @param value - The string value to set.
|
|
6269
6402
|
* @throws Error if the keypath is invalid.
|
|
6270
6403
|
*/
|
|
6271
|
-
setSettingString(keypath:
|
|
6404
|
+
setSettingString(keypath: SettingsString, value: string): void;
|
|
6405
|
+
/** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
|
|
6406
|
+
setSettingString(keypath: `ubq://${SettingsString}`, value: string): void;
|
|
6407
|
+
setSettingString(keypath: SettingStringPropertyName, value: string): void;
|
|
6272
6408
|
/**
|
|
6273
6409
|
* Get a string setting value.
|
|
6274
6410
|
*
|
|
6275
|
-
* @deprecated Use getSetting() instead.
|
|
6276
6411
|
* @category Editor Settings
|
|
6277
6412
|
* @param keypath - The settings keypath, e.g. `license`.
|
|
6278
6413
|
* @returns The string value of the setting.
|
|
6279
6414
|
* @throws Error if the keypath is invalid.
|
|
6280
6415
|
*/
|
|
6281
|
-
getSettingString(keypath:
|
|
6416
|
+
getSettingString(keypath: SettingsString): string;
|
|
6417
|
+
/** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
|
|
6418
|
+
getSettingString(keypath: `ubq://${SettingsString}`): string;
|
|
6419
|
+
getSettingString(keypath: SettingStringPropertyName): string;
|
|
6282
6420
|
/**
|
|
6283
6421
|
* Set a color setting.
|
|
6284
|
-
*
|
|
6285
|
-
* @deprecated Use setSetting() instead.
|
|
6286
6422
|
* @category Editor Settings
|
|
6287
6423
|
* @param keypath - The settings keypath, e.g. `highlightColor`.
|
|
6288
6424
|
* @param value - The The value to set.
|
|
6289
6425
|
*/
|
|
6290
|
-
setSettingColor(keypath:
|
|
6426
|
+
setSettingColor(keypath: SettingsColor, value: Color): void;
|
|
6427
|
+
/** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
|
|
6428
|
+
setSettingColor(keypath: `ubq://${SettingsColor}`, value: Color): void;
|
|
6429
|
+
setSettingColor(keypath: SettingColorPropertyName, value: Color): void;
|
|
6291
6430
|
/**
|
|
6292
6431
|
* Get a color setting.
|
|
6293
|
-
*
|
|
6294
|
-
* @deprecated Use getSetting() instead.
|
|
6295
6432
|
* @category Editor Settings
|
|
6296
6433
|
* @param keypath - The settings keypath, e.g. `highlightColor`.
|
|
6297
6434
|
* @throws An error, if the keypath is invalid.
|
|
6298
6435
|
*/
|
|
6299
|
-
getSettingColor(keypath:
|
|
6436
|
+
getSettingColor(keypath: SettingsColor): Color;
|
|
6437
|
+
/** @deprecated Support for `ubq://` prefixed keypaths will be removed in a future release. */
|
|
6438
|
+
getSettingColor(keypath: `ubq://${SettingsColor}`): Color;
|
|
6439
|
+
getSettingColor(keypath: SettingColorPropertyName): Color;
|
|
6300
6440
|
/**
|
|
6301
6441
|
* Set a color setting.
|
|
6302
6442
|
* @param keypath - The settings keypath, e.g. `highlightColor`.
|
|
@@ -6306,39 +6446,38 @@ export declare class EditorAPI {
|
|
|
6306
6446
|
* @param a - The alpha color component in the range of 0 to 1.
|
|
6307
6447
|
* @deprecated Use setSettingColor() instead.
|
|
6308
6448
|
*/
|
|
6309
|
-
setSettingColorRGBA(keypath:
|
|
6449
|
+
setSettingColorRGBA(keypath: SettingsColorRGBA | `ubq://${SettingsColorRGBA}`, r: number, g: number, b: number, a?: number): void;
|
|
6310
6450
|
/**
|
|
6311
6451
|
* Get a color setting.
|
|
6312
6452
|
* @param keypath - The settings keypath, e.g. `highlightColor`.
|
|
6313
6453
|
* @returns A tuple of channels red, green, blue and alpha in the range of 0 to 1.
|
|
6314
6454
|
* @deprecated Use getSettingColor() instead.
|
|
6315
6455
|
*/
|
|
6316
|
-
getSettingColorRGBA(keypath:
|
|
6456
|
+
getSettingColorRGBA(keypath: SettingsColorRGBA | `ubq://${SettingsColorRGBA}`): RGBA;
|
|
6317
6457
|
/**
|
|
6318
6458
|
* Set an enum setting.
|
|
6319
|
-
*
|
|
6320
|
-
* @deprecated Use setSetting() instead.
|
|
6321
6459
|
* @category Editor Settings
|
|
6322
6460
|
* @param keypath - The settings keypath, e.g. `doubleClickSelectionMode`.
|
|
6323
6461
|
* @param value - The enum value as string.
|
|
6324
6462
|
*/
|
|
6325
|
-
setSettingEnum<T extends keyof
|
|
6463
|
+
setSettingEnum<T extends keyof SettingEnumType>(keypath: T, value: SettingEnumType[T]): void;
|
|
6464
|
+
setSettingEnum(keypath: string, value: string): void;
|
|
6326
6465
|
/**
|
|
6327
6466
|
* Get an enum setting.
|
|
6328
|
-
*
|
|
6329
|
-
* @deprecated Use getSetting() instead.
|
|
6330
6467
|
* @category Editor Settings
|
|
6331
6468
|
* @param keypath - The settings keypath, e.g. `doubleClickSelectionMode`.
|
|
6332
6469
|
* @returns The value as string.
|
|
6333
6470
|
*/
|
|
6334
|
-
getSettingEnum<T extends keyof
|
|
6471
|
+
getSettingEnum<T extends keyof SettingEnumType>(keypath: T): SettingEnumType[T];
|
|
6472
|
+
getSettingEnum(keypath: string): string;
|
|
6335
6473
|
/**
|
|
6336
6474
|
* Get the possible enum options for a given enum setting.
|
|
6337
6475
|
* @category Editor Settings
|
|
6338
6476
|
* @param keypath - The settings keypath, e.g. `doubleClickSelectionMode`.
|
|
6339
6477
|
* @returns The possible enum options as strings.
|
|
6340
6478
|
*/
|
|
6341
|
-
getSettingEnumOptions<T extends keyof
|
|
6479
|
+
getSettingEnumOptions<T extends keyof SettingEnumType>(keypath: T): SettingEnumType[T][];
|
|
6480
|
+
getSettingEnumOptions(keypath: string): string[];
|
|
6342
6481
|
/**
|
|
6343
6482
|
* Set the user role and apply role-dependent defaults.
|
|
6344
6483
|
*
|
|
@@ -6360,7 +6499,7 @@ export declare class EditorAPI {
|
|
|
6360
6499
|
* @category Editor Settings
|
|
6361
6500
|
* @returns A list of settings keypaths.
|
|
6362
6501
|
*/
|
|
6363
|
-
findAllSettings():
|
|
6502
|
+
findAllSettings(): string[];
|
|
6364
6503
|
/**
|
|
6365
6504
|
* Returns the type of a setting.
|
|
6366
6505
|
* @category Editor Settings
|
|
@@ -6716,6 +6855,37 @@ export declare class EditorAPI {
|
|
|
6716
6855
|
* @param enabled - Whether or not the block should show highlighting when selected or hovered.
|
|
6717
6856
|
*/
|
|
6718
6857
|
setHighlightingEnabled(id: DesignBlockId, enabled: boolean): void;
|
|
6858
|
+
/**
|
|
6859
|
+
* Set global safe area insets for UI overlays.
|
|
6860
|
+
*
|
|
6861
|
+
* Safe area insets define UI-safe regions by specifying padding from screen edges.
|
|
6862
|
+
* These insets are automatically applied to all camera operations (zoom, pan, clamping)
|
|
6863
|
+
* to ensure important content remains visible when UI elements overlap the viewport edges.
|
|
6864
|
+
* Set to zero to disable (default state).
|
|
6865
|
+
*
|
|
6866
|
+
* @param insets - The inset values in CSS pixels (device-independent)
|
|
6867
|
+
* @public
|
|
6868
|
+
* @category Viewport
|
|
6869
|
+
*/
|
|
6870
|
+
setSafeAreaInsets(insets: {
|
|
6871
|
+
left?: number;
|
|
6872
|
+
top?: number;
|
|
6873
|
+
right?: number;
|
|
6874
|
+
bottom?: number;
|
|
6875
|
+
}): void;
|
|
6876
|
+
/**
|
|
6877
|
+
* Get the current global safe area insets configuration.
|
|
6878
|
+
*
|
|
6879
|
+
* @returns The current inset values in CSS pixels (device-independent)
|
|
6880
|
+
* @public
|
|
6881
|
+
* @category Viewport
|
|
6882
|
+
*/
|
|
6883
|
+
getSafeAreaInsets(): {
|
|
6884
|
+
left: number;
|
|
6885
|
+
top: number;
|
|
6886
|
+
right: number;
|
|
6887
|
+
bottom: number;
|
|
6888
|
+
};
|
|
6719
6889
|
/**
|
|
6720
6890
|
* Checks whether the block can currently be selected.
|
|
6721
6891
|
*
|
|
@@ -6740,6 +6910,13 @@ export declare class EditorAPI {
|
|
|
6740
6910
|
setSelectionEnabled(id: DesignBlockId, enabled: boolean): void;
|
|
6741
6911
|
}
|
|
6742
6912
|
|
|
6913
|
+
/**
|
|
6914
|
+
* The shorthand block type IDs for the effect blocks. These are the IDs used to create new effects
|
|
6915
|
+
* using `cesdk.engine.block.createEffect(id)`.
|
|
6916
|
+
* @public
|
|
6917
|
+
*/
|
|
6918
|
+
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"];
|
|
6919
|
+
|
|
6743
6920
|
/**
|
|
6744
6921
|
* The block type IDs for the effect blocks. These are the IDs used to create new effects
|
|
6745
6922
|
* using `cesdk.engine.block.createEffect(id)`.
|
|
@@ -6755,12 +6932,8 @@ export declare type EffectType = EffectTypeShorthand | EffectTypeLonghand;
|
|
|
6755
6932
|
*/
|
|
6756
6933
|
export declare type EffectTypeLonghand = `//ly.img.ubq/effect/${EffectTypeShorthand}`;
|
|
6757
6934
|
|
|
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';
|
|
6935
|
+
/** @public */
|
|
6936
|
+
export declare type EffectTypeShorthand = (typeof EFFECT_TYPES)[number];
|
|
6764
6937
|
|
|
6765
6938
|
/**
|
|
6766
6939
|
* Represents an engine plugin.
|
|
@@ -6790,6 +6963,12 @@ export declare type EnginePluginContext = {
|
|
|
6790
6963
|
engine: CreativeEngine;
|
|
6791
6964
|
};
|
|
6792
6965
|
|
|
6966
|
+
/** @public */
|
|
6967
|
+
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 & {});
|
|
6968
|
+
|
|
6969
|
+
/** @public */
|
|
6970
|
+
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 & {});
|
|
6971
|
+
|
|
6793
6972
|
/**
|
|
6794
6973
|
* @public Subscribe to block lifecycle events in the design engine.
|
|
6795
6974
|
*
|
|
@@ -6903,6 +7082,19 @@ export declare type ExportOptions = {
|
|
|
6903
7082
|
abortSignal?: AbortSignal;
|
|
6904
7083
|
};
|
|
6905
7084
|
|
|
7085
|
+
/**
|
|
7086
|
+
* The shorthand block type IDs for the fill blocks. These are the IDs used to create new fills
|
|
7087
|
+
* using `cesdk.engine.block.createFill(id)`.
|
|
7088
|
+
* @public
|
|
7089
|
+
*/
|
|
7090
|
+
export declare const FILL_TYPES: readonly ["color", "gradient/linear", "gradient/radial", "gradient/conical", "image", "video", "pixelStream"];
|
|
7091
|
+
|
|
7092
|
+
/** @public */
|
|
7093
|
+
export declare type FillPixelStreamOrientation = (typeof FillPixelStreamOrientationValues)[number];
|
|
7094
|
+
|
|
7095
|
+
/** @public */
|
|
7096
|
+
export declare const FillPixelStreamOrientationValues: readonly ["Up", "Down", "Left", "Right", "UpMirrored", "DownMirrored", "LeftMirrored", "RightMirrored"];
|
|
7097
|
+
|
|
6906
7098
|
/**
|
|
6907
7099
|
* The block type IDs for the fill blocks. These are the IDs used to create new fills
|
|
6908
7100
|
* using `cesdk.engine.block.createFill(id)`.
|
|
@@ -6918,12 +7110,8 @@ export declare type FillType = FillTypeShorthand | FillTypeLonghand;
|
|
|
6918
7110
|
*/
|
|
6919
7111
|
export declare type FillTypeLonghand = `//ly.img.ubq/fill/${FillTypeShorthand}`;
|
|
6920
7112
|
|
|
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';
|
|
7113
|
+
/** @public */
|
|
7114
|
+
export declare type FillTypeShorthand = (typeof FILL_TYPES)[number];
|
|
6927
7115
|
|
|
6928
7116
|
/**
|
|
6929
7117
|
* Represents a query for finding assets.
|
|
@@ -6965,6 +7153,9 @@ declare interface Flip {
|
|
|
6965
7153
|
vertical: boolean;
|
|
6966
7154
|
}
|
|
6967
7155
|
|
|
7156
|
+
/** @public */
|
|
7157
|
+
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 & {});
|
|
7158
|
+
|
|
6968
7159
|
/**
|
|
6969
7160
|
* Represents a font.
|
|
6970
7161
|
*
|
|
@@ -6982,10 +7173,10 @@ export declare interface Font {
|
|
|
6982
7173
|
|
|
6983
7174
|
/**
|
|
6984
7175
|
* Extended design unit type that includes Point for font size operations.
|
|
6985
|
-
* Maintains consistency with
|
|
7176
|
+
* Maintains consistency with SceneDesignUnit's capitalized naming convention.
|
|
6986
7177
|
* @public
|
|
6987
7178
|
*/
|
|
6988
|
-
export declare type FontSizeUnit =
|
|
7179
|
+
export declare type FontSizeUnit = SceneDesignUnit | 'Point';
|
|
6989
7180
|
|
|
6990
7181
|
/**
|
|
6991
7182
|
* Represents the style of a font.
|
|
@@ -7042,6 +7233,12 @@ b: number,
|
|
|
7042
7233
|
a: number
|
|
7043
7234
|
];
|
|
7044
7235
|
|
|
7236
|
+
/** @public */
|
|
7237
|
+
export declare type HeightMode = (typeof HeightModeValues)[number];
|
|
7238
|
+
|
|
7239
|
+
/** @public */
|
|
7240
|
+
export declare const HeightModeValues: readonly ["Absolute", "Percent", "Auto"];
|
|
7241
|
+
|
|
7045
7242
|
/**
|
|
7046
7243
|
* Represents a hexadecimal color value (RGB or RGBA) that starts with a '#'.
|
|
7047
7244
|
*
|
|
@@ -7060,25 +7257,8 @@ export declare type HexColorString = string;
|
|
|
7060
7257
|
*/
|
|
7061
7258
|
export declare type HistoryId = number;
|
|
7062
7259
|
|
|
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';
|
|
7260
|
+
/** @public */
|
|
7261
|
+
export declare type HorizontalBlockAlignment = TextHorizontalAlignment;
|
|
7082
7262
|
|
|
7083
7263
|
/**
|
|
7084
7264
|
* Represents the image MIME types used in the editor.
|
|
@@ -7094,6 +7274,9 @@ export declare type HorizontalTextAlignment = 'Left' | 'Right' | 'Center';
|
|
|
7094
7274
|
*/
|
|
7095
7275
|
export declare type ImageMimeType = Extract<MimeType_2, 'image/png' | 'image/jpeg' | 'image/webp' | 'image/x-tga'>;
|
|
7096
7276
|
|
|
7277
|
+
/** @public */
|
|
7278
|
+
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 & {});
|
|
7279
|
+
|
|
7097
7280
|
/**
|
|
7098
7281
|
* Type guard for {@link CMYKColor}.
|
|
7099
7282
|
*
|
|
@@ -7257,10 +7440,7 @@ export declare type ObjectTypeLonghand = DesignBlockTypeLonghand | ShapeTypeLong
|
|
|
7257
7440
|
*/
|
|
7258
7441
|
export declare type ObjectTypeShorthand = DesignBlockTypeShorthand | `shape/${ShapeTypeShorthand}` | `fill/${FillTypeShorthand}` | `effect/${EffectTypeShorthand}` | `blur/${BlurTypeShorthand}` | `animation/${AnimationTypeShorthand}`;
|
|
7259
7442
|
|
|
7260
|
-
/**
|
|
7261
|
-
* Type helper for settings keypaths that can optionally include the 'ubq://' prefix.
|
|
7262
|
-
* @public
|
|
7263
|
-
*/
|
|
7443
|
+
/** @public */
|
|
7264
7444
|
export declare type OptionalPrefix<T extends string> = `ubq://${T}` | T;
|
|
7265
7445
|
|
|
7266
7446
|
/** @public */
|
|
@@ -7285,19 +7465,20 @@ export declare interface PageDuration {
|
|
|
7285
7465
|
*/
|
|
7286
7466
|
export declare type PaletteColor = HexColorString | RGBColor | RGBAColor | SpotColor;
|
|
7287
7467
|
|
|
7288
|
-
/**
|
|
7289
|
-
|
|
7290
|
-
|
|
7291
|
-
|
|
7292
|
-
|
|
7293
|
-
|
|
7294
|
-
|
|
7295
|
-
|
|
7296
|
-
|
|
7297
|
-
|
|
7298
|
-
|
|
7299
|
-
|
|
7300
|
-
|
|
7468
|
+
/** @public */
|
|
7469
|
+
export declare type PositionMode = PositionXMode | PositionYMode;
|
|
7470
|
+
|
|
7471
|
+
/** @public */
|
|
7472
|
+
export declare type PositionXMode = (typeof PositionXModeValues)[number];
|
|
7473
|
+
|
|
7474
|
+
/** @public */
|
|
7475
|
+
export declare const PositionXModeValues: readonly ["Absolute", "Percent", "Auto"];
|
|
7476
|
+
|
|
7477
|
+
/** @public */
|
|
7478
|
+
export declare type PositionYMode = (typeof PositionYModeValues)[number];
|
|
7479
|
+
|
|
7480
|
+
/** @public */
|
|
7481
|
+
export declare const PositionYModeValues: readonly ["Absolute", "Percent", "Auto"];
|
|
7301
7482
|
|
|
7302
7483
|
/**
|
|
7303
7484
|
* Represents the various types of properties that can be associated with design blocks.
|
|
@@ -7621,7 +7802,7 @@ export declare class SceneAPI {
|
|
|
7621
7802
|
* @category Scene Properties
|
|
7622
7803
|
* @param designUnit - The new design unit of the scene
|
|
7623
7804
|
*/
|
|
7624
|
-
setDesignUnit(designUnit:
|
|
7805
|
+
setDesignUnit(designUnit: SceneDesignUnit): void;
|
|
7625
7806
|
/**
|
|
7626
7807
|
* Returns the design unit of the current scene.
|
|
7627
7808
|
*
|
|
@@ -7632,7 +7813,7 @@ export declare class SceneAPI {
|
|
|
7632
7813
|
* @category Scene Properties
|
|
7633
7814
|
* @returns The current design unit.
|
|
7634
7815
|
*/
|
|
7635
|
-
getDesignUnit():
|
|
7816
|
+
getDesignUnit(): SceneDesignUnit;
|
|
7636
7817
|
/**
|
|
7637
7818
|
* Get the sorted list of pages in the scene.
|
|
7638
7819
|
*
|
|
@@ -7942,17 +8123,25 @@ export declare class SceneAPI {
|
|
|
7942
8123
|
setPlaying(play: boolean): void;
|
|
7943
8124
|
}
|
|
7944
8125
|
|
|
7945
|
-
/**
|
|
7946
|
-
|
|
7947
|
-
|
|
7948
|
-
|
|
7949
|
-
export declare type SceneLayout = 'Free' | 'VerticalStack' | 'HorizontalStack' | 'DepthStack';
|
|
8126
|
+
/** @public */
|
|
8127
|
+
declare type SceneDesignUnit = (typeof SceneDesignUnitValues)[number];
|
|
8128
|
+
export { SceneDesignUnit as DesignUnit }
|
|
8129
|
+
export { SceneDesignUnit }
|
|
7950
8130
|
|
|
7951
|
-
/**
|
|
7952
|
-
|
|
7953
|
-
|
|
7954
|
-
*/
|
|
7955
|
-
export declare type
|
|
8131
|
+
/** @public */
|
|
8132
|
+
export declare const SceneDesignUnitValues: readonly ["Pixel", "Millimeter", "Inch"];
|
|
8133
|
+
|
|
8134
|
+
/** @public */
|
|
8135
|
+
export declare type SceneLayout = (typeof SceneLayoutValues)[number];
|
|
8136
|
+
|
|
8137
|
+
/** @public */
|
|
8138
|
+
export declare const SceneLayoutValues: readonly ["Free", "VerticalStack", "HorizontalStack", "DepthStack"];
|
|
8139
|
+
|
|
8140
|
+
/** @public */
|
|
8141
|
+
export declare type SceneMode = (typeof SceneModeValues)[number];
|
|
8142
|
+
|
|
8143
|
+
/** @public */
|
|
8144
|
+
export declare const SceneModeValues: readonly ["Design", "Video"];
|
|
7956
8145
|
|
|
7957
8146
|
/**
|
|
7958
8147
|
* @public
|
|
@@ -7971,6 +8160,32 @@ export declare type SceneMode = 'Design' | 'Video';
|
|
|
7971
8160
|
*/
|
|
7972
8161
|
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
8162
|
|
|
8163
|
+
/** @public */
|
|
8164
|
+
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 & {});
|
|
8165
|
+
|
|
8166
|
+
/** @public */
|
|
8167
|
+
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 & {});
|
|
8168
|
+
|
|
8169
|
+
/** @public */
|
|
8170
|
+
export declare type SettingEnumPropertyName = 'touch/pinchAction' | 'touch/rotateAction' | 'camera/clamping/overshootMode' | 'doubleClickSelectionMode' | (string & {});
|
|
8171
|
+
|
|
8172
|
+
/** @public */
|
|
8173
|
+
export declare type SettingEnumType = {
|
|
8174
|
+
'touch/pinchAction': TouchPinchAction;
|
|
8175
|
+
'touch/rotateAction': TouchRotateAction;
|
|
8176
|
+
'camera/clamping/overshootMode': CameraClampingOvershootMode;
|
|
8177
|
+
doubleClickSelectionMode: DoubleClickSelectionMode;
|
|
8178
|
+
};
|
|
8179
|
+
|
|
8180
|
+
/** @public */
|
|
8181
|
+
export declare type SettingEnumValues = TouchPinchAction | TouchRotateAction | CameraClampingOvershootMode | DoubleClickSelectionMode | (string & {});
|
|
8182
|
+
|
|
8183
|
+
/** @public */
|
|
8184
|
+
export declare type SettingFloatPropertyName = 'positionSnappingThreshold' | 'rotationSnappingThreshold' | 'controlGizmo/blockScaleDownLimit' | (string & {});
|
|
8185
|
+
|
|
8186
|
+
/** @public */
|
|
8187
|
+
export declare type SettingIntPropertyName = 'maxImageSize' | (string & {});
|
|
8188
|
+
|
|
7974
8189
|
/**
|
|
7975
8190
|
* Union type of all valid setting keys.
|
|
7976
8191
|
* @public
|
|
@@ -8161,68 +8376,78 @@ export declare interface Settings {
|
|
|
8161
8376
|
|
|
8162
8377
|
}
|
|
8163
8378
|
|
|
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];
|
|
8379
|
+
/** @public */
|
|
8380
|
+
export declare type SettingsBool = SettingBoolPropertyName;
|
|
8173
8381
|
|
|
8174
8382
|
/**
|
|
8175
8383
|
* Represents the color settings available in the editor.
|
|
8176
8384
|
*
|
|
8177
|
-
* @
|
|
8385
|
+
* @categoryDescription Color Settings
|
|
8386
|
+
* Defines the possible color settings in the editor.
|
|
8387
|
+
* - 'borderOutlineColor': The color of the border outline.
|
|
8388
|
+
* - 'clearColor': The clear color.
|
|
8389
|
+
* - 'colorMaskingSettings/maskColor': The color used for masking.
|
|
8390
|
+
* - 'cropOverlayColor': The color of the crop overlay.
|
|
8391
|
+
* - 'errorStateColor': The color indicating an error state.
|
|
8392
|
+
* - 'highlightColor': The highlight color.
|
|
8393
|
+
* - 'page/innerBorderColor': The color of the inner border of the page.
|
|
8394
|
+
* - 'page/marginFillColor': The color of the margin fill.
|
|
8395
|
+
* - 'page/marginFrameColor': The color of the margin frame.
|
|
8396
|
+
* - 'page/outerBorderColor': The color of the outer border of the page.
|
|
8397
|
+
* - 'page/title/color': The color of the page title.
|
|
8398
|
+
* - 'placeholderHighlightColor': The highlight color for placeholders.
|
|
8399
|
+
* - 'progressColor': The color indicating progress.
|
|
8400
|
+
* - 'rotationSnappingGuideColor': The color of the rotation snapping guide.
|
|
8401
|
+
* - 'ruleOfThirdsLineColor': The color of the rule of thirds lines.
|
|
8402
|
+
* - 'snappingGuideColor': The color of the snapping guide.
|
|
8403
|
+
* - 'textVariableHighlightColor': The highlight color for text variables.
|
|
8404
|
+
*
|
|
8178
8405
|
* @public
|
|
8179
8406
|
*/
|
|
8180
|
-
export declare type SettingsColor =
|
|
8181
|
-
[K in keyof Settings]: Settings[K] extends Color ? K : never;
|
|
8182
|
-
}[keyof Settings];
|
|
8407
|
+
export declare type SettingsColor = SettingColorPropertyName;
|
|
8183
8408
|
|
|
8184
8409
|
/**
|
|
8185
8410
|
* Represents the color settings available in the editor.
|
|
8186
8411
|
*
|
|
8412
|
+
* @categoryDescription Color Settings
|
|
8413
|
+
* Defines the possible color settings in the editor.
|
|
8414
|
+
* - 'borderOutlineColor': The color of the border outline.
|
|
8415
|
+
* - 'clearColor': The clear color.
|
|
8416
|
+
* - 'colorMaskingSettings/maskColor': The color used for masking.
|
|
8417
|
+
* - 'cropOverlayColor': The color of the crop overlay.
|
|
8418
|
+
* - 'errorStateColor': The color indicating an error state.
|
|
8419
|
+
* - 'highlightColor': The highlight color.
|
|
8420
|
+
* - 'page/innerBorderColor': The color of the inner border of the page.
|
|
8421
|
+
* - 'page/marginFillColor': The color of the margin fill.
|
|
8422
|
+
* - 'page/marginFrameColor': The color of the margin frame.
|
|
8423
|
+
* - 'page/outerBorderColor': The color of the outer border of the page.
|
|
8424
|
+
* - 'page/title/color': The color of the page title.
|
|
8425
|
+
* - 'placeholderHighlightColor': The highlight color for placeholders.
|
|
8426
|
+
* - 'progressColor': The color indicating progress.
|
|
8427
|
+
* - 'rotationSnappingGuideColor': The color of the rotation snapping guide.
|
|
8428
|
+
* - 'ruleOfThirdsLineColor': The color of the rule of thirds lines.
|
|
8429
|
+
* - 'snappingGuideColor': The color of the snapping guide.
|
|
8430
|
+
* - 'textVariableHighlightColor': The highlight color for text variables.
|
|
8431
|
+
*
|
|
8187
8432
|
* @public
|
|
8188
8433
|
* @deprecated Use SettingsColor instead.
|
|
8189
8434
|
*/
|
|
8190
8435
|
export declare type SettingsColorRGBA = SettingsColor;
|
|
8191
8436
|
|
|
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'>;
|
|
8437
|
+
/** @public */
|
|
8438
|
+
export declare type SettingsEnum = SettingEnumType;
|
|
8199
8439
|
|
|
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>;
|
|
8440
|
+
/** @public */
|
|
8441
|
+
export declare type SettingsFloat = SettingFloatPropertyName;
|
|
8209
8442
|
|
|
8210
|
-
/**
|
|
8211
|
-
|
|
8212
|
-
*
|
|
8213
|
-
* @public
|
|
8214
|
-
*/
|
|
8215
|
-
export declare type SettingsInt = 'maxImageSize';
|
|
8443
|
+
/** @public */
|
|
8444
|
+
export declare type SettingsInt = SettingIntPropertyName;
|
|
8216
8445
|
|
|
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'>;
|
|
8446
|
+
/** @public */
|
|
8447
|
+
export declare type SettingsString = SettingStringPropertyName;
|
|
8448
|
+
|
|
8449
|
+
/** @public */
|
|
8450
|
+
export declare type SettingStringPropertyName = 'basePath' | 'defaultEmojiFontFileUri' | 'defaultFontFileUri' | 'upload/supportedMimeTypes' | 'license' | 'page/title/separator' | 'page/title/fontFileUri' | 'fallbackFontUri' | (string & {});
|
|
8226
8451
|
|
|
8227
8452
|
/**
|
|
8228
8453
|
* Represents the type of a setting.
|
|
@@ -8246,6 +8471,13 @@ export declare type SettingType = 'Bool' | 'Int' | 'Float' | 'String' | 'Color'
|
|
|
8246
8471
|
*/
|
|
8247
8472
|
export declare type SettingValueType<K extends SettingKey> = Settings[K];
|
|
8248
8473
|
|
|
8474
|
+
/**
|
|
8475
|
+
* The shorthand block type IDs for the shape blocks. These are the IDs used to create new shapes
|
|
8476
|
+
* using `cesdk.engine.block.createShape(id)`.
|
|
8477
|
+
* @public
|
|
8478
|
+
*/
|
|
8479
|
+
export declare const SHAPE_TYPES: readonly ["rect", "line", "ellipse", "polygon", "star", "vector_path"];
|
|
8480
|
+
|
|
8249
8481
|
/**
|
|
8250
8482
|
* The block type IDs for the shape blocks. These are the IDs used to create new shapes
|
|
8251
8483
|
* using `cesdk.engine.block.createShape(id)`.
|
|
@@ -8261,12 +8493,8 @@ export declare type ShapeType = ShapeTypeShorthand | ShapeTypeLonghand;
|
|
|
8261
8493
|
*/
|
|
8262
8494
|
export declare type ShapeTypeLonghand = `//ly.img.ubq/shape/${ShapeTypeShorthand}`;
|
|
8263
8495
|
|
|
8264
|
-
/**
|
|
8265
|
-
|
|
8266
|
-
* using `cesdk.engine.block.createShape(id)`.
|
|
8267
|
-
* @public
|
|
8268
|
-
*/
|
|
8269
|
-
export declare type ShapeTypeShorthand = 'rect' | 'line' | 'ellipse' | 'polygon' | 'star' | 'vector_path';
|
|
8496
|
+
/** @public */
|
|
8497
|
+
export declare type ShapeTypeShorthand = (typeof SHAPE_TYPES)[number];
|
|
8270
8498
|
|
|
8271
8499
|
/** @public */
|
|
8272
8500
|
export declare interface Size2 {
|
|
@@ -8274,19 +8502,8 @@ export declare interface Size2 {
|
|
|
8274
8502
|
height: number;
|
|
8275
8503
|
}
|
|
8276
8504
|
|
|
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';
|
|
8505
|
+
/** @public */
|
|
8506
|
+
export declare type SizeMode = WidthMode | HeightMode;
|
|
8290
8507
|
|
|
8291
8508
|
/**
|
|
8292
8509
|
* The order to sort by if the asset source supports sorting.
|
|
@@ -8305,6 +8522,9 @@ export declare interface Source {
|
|
|
8305
8522
|
height: number;
|
|
8306
8523
|
}
|
|
8307
8524
|
|
|
8525
|
+
/** @public */
|
|
8526
|
+
export declare type SourceSetPropertyName = 'fill/image/sourceSet' | (string & {});
|
|
8527
|
+
|
|
8308
8528
|
/**
|
|
8309
8529
|
* Options for configuring block split operations.
|
|
8310
8530
|
* @public
|
|
@@ -8343,47 +8563,26 @@ export declare interface SpotColor {
|
|
|
8343
8563
|
externalReference: string;
|
|
8344
8564
|
}
|
|
8345
8565
|
|
|
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';
|
|
8566
|
+
/** @public */
|
|
8567
|
+
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
8568
|
|
|
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';
|
|
8569
|
+
/** @public */
|
|
8570
|
+
export declare type StrokeCornerGeometry = (typeof StrokeCornerGeometryValues)[number];
|
|
8371
8571
|
|
|
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';
|
|
8572
|
+
/** @public */
|
|
8573
|
+
export declare const StrokeCornerGeometryValues: readonly ["Bevel", "Miter", "Round"];
|
|
8574
|
+
|
|
8575
|
+
/** @public */
|
|
8576
|
+
export declare type StrokePosition = (typeof StrokePositionValues)[number];
|
|
8577
|
+
|
|
8578
|
+
/** @public */
|
|
8579
|
+
export declare const StrokePositionValues: readonly ["Center", "Inner", "Outer"];
|
|
8580
|
+
|
|
8581
|
+
/** @public */
|
|
8582
|
+
export declare type StrokeStyle = (typeof StrokeStyleValues)[number];
|
|
8583
|
+
|
|
8584
|
+
/** @public */
|
|
8585
|
+
export declare const StrokeStyleValues: readonly ["Dashed", "DashedRound", "Dotted", "LongDashed", "LongDashedRound", "Solid"];
|
|
8387
8586
|
|
|
8388
8587
|
/**
|
|
8389
8588
|
* Represents a subscription to an event.
|
|
@@ -8397,6 +8596,12 @@ export declare type StrokeStyle = 'Dashed' | 'DashedRound' | 'Dotted' | 'LongDas
|
|
|
8397
8596
|
*/
|
|
8398
8597
|
declare type Subscription = number;
|
|
8399
8598
|
|
|
8599
|
+
/** @public */
|
|
8600
|
+
export declare type TextAnimationWritingStyle = (typeof TextAnimationWritingStyleValues)[number];
|
|
8601
|
+
|
|
8602
|
+
/** @public */
|
|
8603
|
+
export declare const TextAnimationWritingStyleValues: readonly ["Block", "Line", "Character", "Word"];
|
|
8604
|
+
|
|
8400
8605
|
/**
|
|
8401
8606
|
* Represents the text case of a text block.
|
|
8402
8607
|
*
|
|
@@ -8424,6 +8629,34 @@ export declare interface TextFontSizeOptions {
|
|
|
8424
8629
|
to?: number;
|
|
8425
8630
|
}
|
|
8426
8631
|
|
|
8632
|
+
/** @public */
|
|
8633
|
+
declare type TextHorizontalAlignment = (typeof TextHorizontalAlignmentValues)[number];
|
|
8634
|
+
export { TextHorizontalAlignment as HorizontalTextAlignment }
|
|
8635
|
+
export { TextHorizontalAlignment }
|
|
8636
|
+
|
|
8637
|
+
/** @public */
|
|
8638
|
+
export declare const TextHorizontalAlignmentValues: readonly ["Left", "Right", "Center"];
|
|
8639
|
+
|
|
8640
|
+
/** @public */
|
|
8641
|
+
declare type TextVerticalAlignment = (typeof TextVerticalAlignmentValues)[number];
|
|
8642
|
+
export { TextVerticalAlignment }
|
|
8643
|
+
export { TextVerticalAlignment as VerticalTextAlignment }
|
|
8644
|
+
|
|
8645
|
+
/** @public */
|
|
8646
|
+
export declare const TextVerticalAlignmentValues: readonly ["Top", "Bottom", "Center"];
|
|
8647
|
+
|
|
8648
|
+
/** @public */
|
|
8649
|
+
export declare type TouchPinchAction = (typeof TouchPinchActionValues)[number];
|
|
8650
|
+
|
|
8651
|
+
/** @public */
|
|
8652
|
+
export declare const TouchPinchActionValues: readonly ["None", "Zoom", "Scale"];
|
|
8653
|
+
|
|
8654
|
+
/** @public */
|
|
8655
|
+
export declare type TouchRotateAction = (typeof TouchRotateActionValues)[number];
|
|
8656
|
+
|
|
8657
|
+
/** @public */
|
|
8658
|
+
export declare const TouchRotateActionValues: readonly ["None", "Rotate"];
|
|
8659
|
+
|
|
8427
8660
|
/**
|
|
8428
8661
|
* Represents a transient resource.
|
|
8429
8662
|
*
|
|
@@ -8638,25 +8871,8 @@ export declare interface Vec3 {
|
|
|
8638
8871
|
z: number;
|
|
8639
8872
|
}
|
|
8640
8873
|
|
|
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';
|
|
8874
|
+
/** @public */
|
|
8875
|
+
export declare type VerticalBlockAlignment = TextVerticalAlignment;
|
|
8660
8876
|
|
|
8661
8877
|
/**
|
|
8662
8878
|
* Represents the options for exporting a video.
|
|
@@ -8761,6 +8977,12 @@ export declare type VideoExportOptions = {
|
|
|
8761
8977
|
*/
|
|
8762
8978
|
export declare type VideoMimeType = Extract<MimeType_2, 'video/mp4' | 'video/quicktime'>;
|
|
8763
8979
|
|
|
8980
|
+
/** @public */
|
|
8981
|
+
export declare type WidthMode = (typeof WidthModeValues)[number];
|
|
8982
|
+
|
|
8983
|
+
/** @public */
|
|
8984
|
+
export declare const WidthModeValues: readonly ["Absolute", "Percent", "Auto"];
|
|
8985
|
+
|
|
8764
8986
|
/**
|
|
8765
8987
|
* Describes a rectangle on the screen.
|
|
8766
8988
|
*
|