Layer

aeq. Layer

new Layer(layer) → {aeq.Layer}

Source:

Converts a Layer into an aeq.Layer object

Parameters:
Name Type Description
layer Layer

Layer to turn into aeq.Layer object

Returns:

aeq.Layer object of Layer

Type
aeq.Layer

Methods

addEffect(effectName)

Source:

Adds effect to layer by name or matchname

Parameters:
Name Type Description
effectName string

Effect name or matchname to add to layer

allChildren() → {Array.<Layer>}

Source:

Gets all layers that has the given layer as its parent, and all layers that has those layers, and so on.

Returns:

Children and decendants of this layer

Type
Array.<Layer>

children() → {Array.<Layer>}

Source:

Gets all layers that has the given layer as its parent.

Returns:

Children of this layer

Type
Array.<Layer>

copyToComp(comp) → {aeq.Layer}

Source:

Copies current layer to comp

Parameters:
Name Type Description
comp CompItem | aeq.Comp

Comp to copy layer to

Returns:

Newly copied layer

Type
aeq.Layer

forEachEffect(callback) → {aeq.Layer}

Source:

Executes a callback function on each effect on this layer

Parameters:
Name Type Description
callback function

Function to run on each effect

Returns:

This layer

Type
aeq.Layer

get() → {Layer}

Source:

Get the original object

Returns:
Type
Layer

parent(selectoropt) → {Layer|null}

Source:

Gets or sets layer parent

Parameters:
Name Type Attributes Description
selector aeq.SelectorString | null <optional>

Selector for new parent, or null to remove parent

Returns:

Parent layer, or null if none

Type
Layer | null

parents() → {Array.<Layer>}

Source:

This layer's parent chain

Returns:

Parents of this layer

Type
Array.<Layer>

relatedLayers() → {Array.<Layer>}

Source:

All parents and all children of the this layer.

Returns:

The layer's parents and children.

Type
Array.<Layer>

removeParent() → {aeq.Layer}

Source:

Removes this layer's parent

Returns:

This layer

Type
aeq.Layer