LightLayer object¶

app.project.item(index).layer(index)

Description¶

The LightLayer object represents a light layer within a composition. Create it using the LayerCollection.addLight() method. It can be accessed in an item's layer collection either by index number or by a name string.

Info

LightLayer is a subclass of Layer object. All methods and attributes of Layer are available when working with Light-Layer.

AE Properties¶

LightLayer defines no additional attributes, but has different AE properties than other layer types. It has thefollowing properties and property groups:

Marker
Transform:
- PointofInterest
- Position
- Scale
- Orientation
- XRotation
- YRotation
- Rotation
- Opacity
LightOptions:
- Intensity
- Color
- ConeAngle
- ConeFeather
- CastsShadows
- ShadowDarkness
- ShadowDiffusion

Attributes¶

LightLayer.lightSource:¶

app.project.item(index).layer(index).lightSource

Note

LightLayer.lightSource was added in After Effects 24.3, but allowed only HDR and EXR layers as sources.

In After Effects 25.2, it was updated to allow any 2D layer type as a source.

Description¶

For a light layer, the layer to use as a light source when LightLayer.lightType is LightType.ENVIRONMENT.

LightLayer.lightSource can be any 2D video, still, or pre-composition layer in the same composition. Attempting to assign a 3D layer as the .lightSource will result in an "Invalid light source specified" error.

LightLayer.lightType¶

app.project.item(index).layer(index).lightType

Note

LightType.ENVIRONMENT was added in After Effects 24.3

Description¶

For a light layer, its light type. Trying to set this attribute for a non-light layer produces an error.

Type¶

A LightType enumerated value; read/write. One of:

LightType.PARALLEL
LightType.SPOT
LightType.POINT
LightType.AMBIENT
LightType.ENVIRONMENT