Skip to content

Commit 7137a99

Browse files
jthomascolombojthomascolombo
authored
Merge pull request #63 from docsforadobe/colombo/26.5-updates
Scripting API updates for 26.5
2 parents 07a9f8e + e040e13 commit 7137a99

5 files changed

Lines changed: 162 additions & 29 deletions

File tree

‎docs/introduction/changelog.md‎

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,23 @@ What's new and changed for scripting?
88

99
---
1010

11-
## After Effects (Beta)
12-
13-
14-
### [After Effects (Beta) 26.5](https://helpx.adobe.com/after-effects/desktop/what-s-new/after-effects-beta.html) (July 2026)
11+
## After Effects 26
1512

16-
!!! note
17-
This functionality was added in After Effects (Beta) 26.5 and is subject to change while it remains in Beta.
13+
### [After Effects 26.5](https://helpx.adobe.com/after-effects/using/whats-new.html) (September 2026)
1814

1915
- Guide scripting extended with a `GuideOptions`-based API (percentage positioning, per-guide color, and pinning):
2016
- Added: [GuideOptions object](../other/guideoptions.md)
2117
- Added: [GuideOrientationType](../other/guideoptions.md#guideorientationtype) and [GuidePositionType](../other/guideoptions.md#guidepositiontype) enumerated values
2218
- Added: [Item.getGuideAsObject()](../item/item.md#itemgetguideasobject) and [Layer.getGuideAsObject()](../layer/layer.md#layergetguideasobject)
2319
- Added: `GuideOptions` overloads of [Item.addGuide()](../item/item.md#itemaddguide) / [Item.setGuide()](../item/item.md#itemsetguide) and [Layer.addGuide()](../layer/layer.md#layeraddguide) / [Layer.setGuide()](../layer/layer.md#layersetguide)
20+
- Scripting access added to the render-stage popup on layer parameters (the dropdown that picks Source, Only Masks, or All Effects):
21+
- Added: [Property.layerInputStage](../property/property.md#propertylayerinputstage) and [Property.setLayerInputStage()](../property/property.md#propertysetlayerinputstage)
22+
- Added: [Property.inputLayerAndStage](../property/property.md#propertyinputlayerandstage) and [Property.setInputLayerAndStage()](../property/property.md#propertysetinputlayerandstage)
23+
- Added: [Property.getInputStageCycleSafeLimit()](../property/property.md#propertygetinputstagecyclesafelimit)
24+
- Added: [Property.LayerInputStageType](../property/property.md#propertylayerinputstagetype) enumerated values
2425

2526
!!! warning "Differences between versions"
26-
**Breaking change:** The integer values behind `orientationType` and `positionType` on [Item.guides](../item/item.md#itemguides) / [Layer.guides](../layer/layer.md#layerguides) differ between versions of After Effects. In the beta, always compare against the enumerated constants rather than raw integer literals.
27-
28-
---
29-
30-
## After Effects 26
27+
**Breaking change:** The integer values behind `orientationType` and `positionType` on [Item.guides](../item/item.md#itemguides) / [Layer.guides](../layer/layer.md#layerguides) differ between versions of After Effects. Always compare against the enumerated constants rather than raw integer literals.
3128

3229
### [After Effects 26.3](https://helpx.adobe.com/after-effects/using/whats-new.html) (June 2026)
3330

‎docs/item/item.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ In After Effects 16.1 (CC 2019) and later, each entry has the following properti
8888
| `positionType` | Integer | Always `0` (a pixel position). |
8989
| `position` | Floating-point value | The guide's position, in pixels. |
9090

91-
In After Effects (Beta) 26.5 and later, each entry has the following properties:
91+
In After Effects 26.5 and later, each entry has the following properties:
9292

9393
| Property | Type | Description |
9494
| ----------------- | ---------------------- | ------------------------------------------------------------------------ |
@@ -245,20 +245,20 @@ if (/Composition|Komposition|Composición|Composizione|コンポジション|컴
245245
`app.project.item(index).addGuide(guideOptions)`
246246

247247
!!! note
248-
The `(orientationType, position)` form was added in After Effects 16.1 (CC 2019). The `GuideOptions` form was added in After Effects (Beta) 26.5 and is subject to change while it remains in Beta.
248+
The `(orientationType, position)` form was added in After Effects 16.1 (CC 2019). The `GuideOptions` form was added in After Effects 26.5.
249249

250250
#### Description
251251

252252
Adds a guide to the item's view and returns its index. There are two forms:
253253

254254
- **`addGuide(orientationType, position)`** - adds a pixel guide using an orientation and a pixel position.
255-
- **`addGuide(guideOptions)`** - adds a guide described by a [GuideOptions](../other/guideoptions.md) object, allowing percentage positioning, per-guide color, and pinning. *(After Effects (Beta) 26.5 and later; calling this form in an earlier version raises an error.)*
255+
- **`addGuide(guideOptions)`** - adds a guide described by a [GuideOptions](../other/guideoptions.md) object, allowing percentage positioning, per-guide color, and pinning. *(After Effects 26.5 and later; calling this form in an earlier version raises an error.)*
256256

257257
#### Parameters
258258

259259
| Parameter | Type | Description |
260260
| ----------------- | -------------------- | --------------------------------------------------------------------------------------------------------- |
261-
| `orientationType` | Integer | `0` for a horizontal guide, `1` for a vertical guide. Any other value defaults to horizontal. In After Effects (Beta) 26.5 and later you may also pass `GuideOrientationType.HORIZONTAL` / `GuideOrientationType.VERTICAL`. |
261+
| `orientationType` | Integer | `0` for a horizontal guide, `1` for a vertical guide. Any other value defaults to horizontal. In After Effects 26.5 and later you may also pass `GuideOrientationType.HORIZONTAL` / `GuideOrientationType.VERTICAL`. |
262262
| `position` | Floating-point value | The X or Y coordinate position of the guide in pixels. Clamped to ±100,000; non-finite values are rejected. |
263263
| `guideOptions` | GuideOptions object | A [GuideOptions](../other/guideoptions.md) describing the new guide. |
264264

@@ -291,7 +291,7 @@ item.addGuide(opts);
291291
`app.project.item(index).getGuideAsObject(guideIndex)`
292292

293293
!!! note
294-
This functionality was added in After Effects (Beta) 26.5 and is subject to change while it remains in Beta. Calling it in an earlier version raises the error "getGuideAsObject() is not available in this version of After Effects."
294+
This functionality was added in After Effects 26.5. Calling it in an earlier version raises the error "getGuideAsObject() is not available in this version of After Effects."
295295

296296
#### Description
297297

@@ -377,14 +377,14 @@ app.project.activeItem.removeGuide(0);
377377
`app.project.item(index).setGuide(guideIndex, guideOptions)`
378378

379379
!!! note
380-
The `(position, guideIndex)` form was added in After Effects 16.1 (CC 2019). The `(guideIndex, guideOptions)` form was added in After Effects (Beta) 26.5 and is subject to change while it remains in Beta.
380+
The `(position, guideIndex)` form was added in After Effects 16.1 (CC 2019). The `(guideIndex, guideOptions)` form was added in After Effects 26.5.
381381

382382
#### Description
383383

384384
Updates an existing guide. There are two forms, distinguished by the type of the second argument:
385385

386386
- **`setGuide(position, guideIndex)`** - moves the guide at `guideIndex` to a new pixel `position`. *Note the order: position first, index second.* A guide's `orientationType` may not be changed after it is created.
387-
- **`setGuide(guideIndex, guideOptions)`** - applies the properties set on a [GuideOptions](../other/guideoptions.md) object to the guide at `guideIndex`. Only the properties you set are changed (partial update). *(After Effects (Beta) 26.5 and later.)*
387+
- **`setGuide(guideIndex, guideOptions)`** - applies the properties set on a [GuideOptions](../other/guideoptions.md) object to the guide at `guideIndex`. Only the properties you set are changed (partial update). *(After Effects 26.5 and later.)*
388388

389389
!!! warning
390390
The two forms take their arguments in the **opposite order**: the `(position, guideIndex)` form takes the position first, while the `(guideIndex, guideOptions)` form takes the index first. After Effects decides which form you mean from the type of the second argument (a number selects the `(position, guideIndex)` form; a `GuideOptions` object selects the `(guideIndex, guideOptions)` form).

‎docs/layer/layer.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ In After Effects 16.1 (CC 2019) and later, each entry has the following properti
9292
| `positionType` | Integer | Always `0` (a pixel position). |
9393
| `position` | Floating-point value | The guide's position, in pixels. |
9494

95-
In After Effects (Beta) 26.5 and later, each entry has the following properties:
95+
In After Effects 26.5 and later, each entry has the following properties:
9696

9797
| Property | Type | Description |
9898
| ----------------- | ---------------------- | ------------------------------------------------------------------------ |
@@ -103,7 +103,7 @@ In After Effects (Beta) 26.5 and later, each entry has the following properties:
103103
| `pinned` | Boolean | `true` if pinned to the opposite (bottom/right) edge. |
104104

105105
!!! warning "Differences between versions"
106-
**Breaking change:** The integer values behind `orientationType` and `positionType` differ between versions of After Effects. In the beta, always compare against the enumerated constants (for example [GuideOrientationType.HORIZONTAL](../other/guideoptions.md#guideorientationtype)) rather than raw integer literals — a test such as `guide.orientationType === 0` is not portable and may stop matching in a future version.
106+
**Breaking change:** The integer values behind `orientationType` and `positionType` differ between versions of After Effects. Always compare against the enumerated constants (for example [GuideOrientationType.HORIZONTAL](../other/guideoptions.md#guideorientationtype)) rather than raw integer literals — a test such as `guide.orientationType === 0` is not portable and may stop matching in a future version.
107107

108108
#### Type
109109

@@ -419,20 +419,20 @@ Boolean.
419419
`app.project.item(index).layer(index).addGuide(guideOptions)`
420420

421421
!!! note
422-
The `(orientationType, position)` form was added in After Effects 16.1 (CC 2019). The `GuideOptions` form was added in After Effects (Beta) 26.5 and is subject to change while it remains in Beta.
422+
The `(orientationType, position)` form was added in After Effects 16.1 (CC 2019). The `GuideOptions` form was added in After Effects 26.5.
423423

424424
#### Description
425425

426426
Adds a guide to the layer's view and returns its index. There are two forms:
427427

428428
- **`addGuide(orientationType, position)`** - adds a pixel guide using an orientation and a pixel position.
429-
- **`addGuide(guideOptions)`** - adds a guide described by a [GuideOptions](../other/guideoptions.md) object, allowing percentage positioning, per-guide color, and pinning. *(After Effects (Beta) 26.5 and later; calling this form in an earlier version raises an error.)*
429+
- **`addGuide(guideOptions)`** - adds a guide described by a [GuideOptions](../other/guideoptions.md) object, allowing percentage positioning, per-guide color, and pinning. *(After Effects 26.5 and later; calling this form in an earlier version raises an error.)*
430430

431431
#### Parameters
432432

433433
| Parameter | Type | Description |
434434
| ----------------- | -------------------- | --------------------------------------------------------------------------------------------------------- |
435-
| `orientationType` | Integer | `0` for a horizontal guide, `1` for a vertical guide. Any other value defaults to horizontal. In After Effects (Beta) 26.5 and later you may also pass `GuideOrientationType.HORIZONTAL` / `GuideOrientationType.VERTICAL`. |
435+
| `orientationType` | Integer | `0` for a horizontal guide, `1` for a vertical guide. Any other value defaults to horizontal. In After Effects 26.5 and later you may also pass `GuideOrientationType.HORIZONTAL` / `GuideOrientationType.VERTICAL`. |
436436
| `position` | Floating-point value | The X or Y coordinate position of the guide in pixels. Clamped to ±100,000; non-finite values are rejected. |
437437
| `guideOptions` | GuideOptions object | A [GuideOptions](../other/guideoptions.md) describing the new guide. |
438438

@@ -572,7 +572,7 @@ Layer object.
572572
`app.project.item(index).layer(index).getGuideAsObject(guideIndex)`
573573

574574
!!! note
575-
This functionality was added in After Effects (Beta) 26.5 and is subject to change while it remains in Beta. Calling it in an earlier version raises the error "getGuideAsObject() is not available in this version of After Effects."
575+
This functionality was added in After Effects 26.5. Calling it in an earlier version raises the error "getGuideAsObject() is not available in this version of After Effects."
576576

577577
#### Description
578578

@@ -735,14 +735,14 @@ app.project.item(1).layer(1).removeGuide(0);
735735
`app.project.item(index).layer(index).setGuide(guideIndex, guideOptions)`
736736

737737
!!! note
738-
The `(position, guideIndex)` form was added in After Effects 16.1 (CC 2019). The `(guideIndex, guideOptions)` form was added in After Effects (Beta) 26.5 and is subject to change while it remains in Beta.
738+
The `(position, guideIndex)` form was added in After Effects 16.1 (CC 2019). The `(guideIndex, guideOptions)` form was added in After Effects 26.5.
739739

740740
#### Description
741741

742742
Updates an existing guide. There are two forms, distinguished by the type of the second argument:
743743

744744
- **`setGuide(position, guideIndex)`** - moves the guide at `guideIndex` to a new pixel `position`. *Note the order: position first, index second.* A guide's `orientationType` may not be changed after it is created.
745-
- **`setGuide(guideIndex, guideOptions)`** - applies the properties set on a [GuideOptions](../other/guideoptions.md) object to the guide at `guideIndex`. Only the properties you set are changed (partial update). *(After Effects (Beta) 26.5 and later.)*
745+
- **`setGuide(guideIndex, guideOptions)`** - applies the properties set on a [GuideOptions](../other/guideoptions.md) object to the guide at `guideIndex`. Only the properties you set are changed (partial update). *(After Effects 26.5 and later.)*
746746

747747
!!! warning
748748
The two forms take their arguments in the **opposite order**: the `(position, guideIndex)` form takes the position first, while the `(guideIndex, guideOptions)` form takes the index first. After Effects decides which form you mean from the type of the second argument (a number selects the `(position, guideIndex)` form; a `GuideOptions` object selects the `(guideIndex, guideOptions)` form).

‎docs/other/guideoptions.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
`new GuideOptions()`
44

55
!!! note
6-
This functionality was added in After Effects (Beta) 26.5 and is subject to change while it remains in Beta.
6+
This functionality was added in After Effects 26.5
77

88
#### Description
99

@@ -105,7 +105,7 @@ The orientation of a guide, used by [GuideOptions.orientation](#guideoptionsorie
105105
| `GuideOrientationType.VERTICAL` | A vertical guide. |
106106

107107
!!! note
108-
These enumerated constants were added in After Effects (Beta) 26.5 and are subject to change while they remain in Beta. Always compare `orientationType` against these constants rather than raw integers, because the underlying integer values differ between versions of After Effects. In the non-beta application the constants are unavailable and [Item.guides](../item/item.md#itemguides) / [Layer.guides](../layer/layer.md#layerguides) report `orientationType` as a plain integer (`0` for horizontal, `1` for vertical).
108+
These enumerated constants were added in After Effects 26.5. Always compare `orientationType` against these constants rather than raw integers, because the underlying integer values differ between versions of After Effects. In versions prior to 26.5, the constants are unavailable and [Item.guides](../item/item.md#itemguides) / [Layer.guides](../layer/layer.md#layerguides) report `orientationType` as a plain integer (`0` for horizontal, `1` for vertical).
109109

110110
---
111111

@@ -119,4 +119,4 @@ How a guide's `position` value is interpreted, used by [GuideOptions.positionTyp
119119
| `GuidePositionType.PERCENTAGE` | `position` is measured as a percentage of the frame. |
120120

121121
!!! note
122-
These enumerated constants were added in After Effects (Beta) 26.5 and are subject to change while they remain in Beta. Always compare `positionType` against these constants rather than raw integers, because the underlying integer values differ between versions of After Effects. In the non-beta application the constants are unavailable and [Item.guides](../item/item.md#itemguides) / [Layer.guides](../layer/layer.md#layerguides) report `positionType` as a plain integer (always `0`, pixels).
122+
These enumerated constants were added in After Effects 26.5. Always compare `positionType` against these constants rather than raw integers, because the underlying integer values differ between versions of After Effects. In versions prior to 26.5, the constants are unavailable and [Item.guides](../item/item.md#itemguides) / [Layer.guides](../layer/layer.md#layerguides) report `positionType` as a plain integer (always `0`, pixels).

0 commit comments

Comments
 (0)