[ view source ]

class AudioFilter

package ceramic

extends Entity

extended by HighPassFilter, LowPassFilter

@:build(ceramic.macros.EntityMacro.buildForCompletion())@:autoBuild(ceramic.macros.EntityMacro.buildForCompletion())@:build(tracker.macros.EventsMacro.build())@:autoBuild(tracker.macros.EventsMacro.build())@:autoBuild(ceramic.macros.AudioFiltersMacro.buildFilter())

Available on all targets

Base class for audio filters that can process audio buffers in real-time. Subclass this to create custom audio filters.

Events

@:dox(show)ready(bus:Int):Void

Fired when the audio filter is successfuly attached to a given bus. When this is called, the audio filter is expected to be ready in the sense that all the underlying layers have been properly plugged and the audio output bus should be affected by this audio filter's worklet.

Parameters:

null

bus

Constructor

new()

Variables

finalfilterId:Int

The unique id of this filter

@:value(-1)bus:Int = -1

The bus this filter is attached to (-1 if not attached)

@:value(true)active:Bool = true

Whether this filter is currently active

Methods

acquireParams():Void

releaseParams():Void

@:allow(ceramic.Audio)workletClass():Class<AudioFilterWorklet>

Return the class that should be used to instanciate audio filter worklets

numParams():Int

Return the number of parameters this filter has. (automatically generated from fields marked with @param, no need to override it)

Inherited Events

Defined by Entity

@:dox(show)dispose(entity:Entity):Void

@:dox(show)destroy(entity:Entity):Void

Inherited Variables

Defined by Entity

@:value(null)id:String = null

read onlydestroyed:Bool

read onlydisposed:Bool

@:value(null)read onlyautoruns:Array<Autorun> = null

components:ReadOnlyMap<String, Component>

Public components mapping. Contain components created separately with component() or macro-based components as well.

scriptContent:ScriptContent

Available with script plugin

script:Script

Available with script plugin

Inherited Methods

Defined by Entity

dispose():Void

Schedules destroy, at the end of the current frame.

unbindEvents():Void

Remove all events handlers from this entity.

autorun(run:() ‑> Void, ?afterRun:() ‑> Void):Autorun

Creates a new Autorun instance with the given callback associated with the current entity.

Parameters:

run

The run callback

Returns:

The autorun instance

tween(?easing:Easing, duration:Float, fromValue:Float, toValue:Float, update:(Float, Float) ‑> Void):Tween

Start a tween associated with this entity.

Parameters:

easing

The easing to use

duration

The duration of the tween

fromValue

The start value of the tween

toValue

The end value of the tween

update

An update function called at each iteration of the tween

Returns:

The instance of the created Tween object

eagerTween(?easing:Easing, duration:Float, fromValue:Float, toValue:Float, update:(Float, Float) ‑> Void):Tween

Start an eager tween associated with this entity. This is the same as a regular tween, except that it will start updating itself using current frame's delta time instead of next frame like in a regular tween.

Parameters:

easing

The easing to use

duration

The duration of the tween

fromValue

The start value of the tween

toValue

The end value of the tween

update

An update function called at each iteration of the tween

Returns:

The instance of the created Tween object

className():String

inlineclearComponents():Void

@:value({ hasField : false })component<C>(?name:String, ?component:Null<C>, hasField:Bool = false):C

hasComponent(name:String):Bool

removeComponent(name:String):Void