createEffect

Create a new audio effect of the given type.

The returned effect is initially enabled and configured with default parameters. Use AudioEffect.setParameter to adjust its settings, then add it to an AudioEffectChain and attach the chain to an AudioStream via AudioStream.effectChain.

val reverb = engine.createEffect(AudioEffectType.REVERB)
reverb.setParameter(ReverbParams.DECAY_TIME, 1.5f)

val chain = engine.createEffectChain()
chain.add(reverb)
stream.effectChain = chain

Return

A new AudioEffect instance. Call AudioEffect.release when the effect is no longer needed.

Parameters

type

The type of effect to create. See AudioEffectType for available effects.

Throws

if the effect could not be created on the current platform.

Create a new audio effect of the given type.

The returned effect is initially enabled and configured with default parameters. Use AudioEffect.setParameter to adjust its settings, then add it to an AudioEffectChain and attach the chain to an AudioStream via AudioStream.effectChain.

val reverb = engine.createEffect(AudioEffectType.REVERB)
reverb.setParameter(ReverbParams.DECAY_TIME, 1.5f)

val chain = engine.createEffectChain()
chain.add(reverb)
stream.effectChain = chain

Return

A new AudioEffect instance. Call AudioEffect.release when the effect is no longer needed.

Parameters

type

The type of effect to create. See AudioEffectType for available effects.

Throws

if the effect could not be created on the current platform.

Create a new audio effect of the given type.

The returned effect is initially enabled and configured with default parameters. Use AudioEffect.setParameter to adjust its settings, then add it to an AudioEffectChain and attach the chain to an AudioStream via AudioStream.effectChain.

val reverb = engine.createEffect(AudioEffectType.REVERB)
reverb.setParameter(ReverbParams.DECAY_TIME, 1.5f)

val chain = engine.createEffectChain()
chain.add(reverb)
stream.effectChain = chain

Return

A new AudioEffect instance. Call AudioEffect.release when the effect is no longer needed.

Parameters

type

The type of effect to create. See AudioEffectType for available effects.

Throws

if the effect could not be created on the current platform.

Create a new audio effect of the given type.

The returned effect is initially enabled and configured with default parameters. Use AudioEffect.setParameter to adjust its settings, then add it to an AudioEffectChain and attach the chain to an AudioStream via AudioStream.effectChain.

val reverb = engine.createEffect(AudioEffectType.REVERB)
reverb.setParameter(ReverbParams.DECAY_TIME, 1.5f)

val chain = engine.createEffectChain()
chain.add(reverb)
stream.effectChain = chain

Return

A new AudioEffect instance. Call AudioEffect.release when the effect is no longer needed.

Parameters

type

The type of effect to create. See AudioEffectType for available effects.

Throws

if the effect could not be created on the current platform.

Create a new audio effect of the given type.

The returned effect is initially enabled and configured with default parameters. Use AudioEffect.setParameter to adjust its settings, then add it to an AudioEffectChain and attach the chain to an AudioStream via AudioStream.effectChain.

val reverb = engine.createEffect(AudioEffectType.REVERB)
reverb.setParameter(ReverbParams.DECAY_TIME, 1.5f)

val chain = engine.createEffectChain()
chain.add(reverb)
stream.effectChain = chain

Return

A new AudioEffect instance. Call AudioEffect.release when the effect is no longer needed.

Parameters

type

The type of effect to create. See AudioEffectType for available effects.

Throws

if the effect could not be created on the current platform.

Create a new audio effect of the given type.

The returned effect is initially enabled and configured with default parameters. Use AudioEffect.setParameter to adjust its settings, then add it to an AudioEffectChain and attach the chain to an AudioStream via AudioStream.effectChain.

val reverb = engine.createEffect(AudioEffectType.REVERB)
reverb.setParameter(ReverbParams.DECAY_TIME, 1.5f)

val chain = engine.createEffectChain()
chain.add(reverb)
stream.effectChain = chain

Return

A new AudioEffect instance. Call AudioEffect.release when the effect is no longer needed.

Parameters

type

The type of effect to create. See AudioEffectType for available effects.

Throws

if the effect could not be created on the current platform.