/

• English
• Deutsch
• Español – América Latina
• Français
• Indonesia
• Polski
• Português – Brasil
• Tiếng Việt
• 中文 – 简体
• 日本語
• 한국어

Android Studio Sign in

• API reference

DynamicsProcessing

public final class DynamicsProcessing
extends AudioEffect

DynamicsProcessing is an audio effect for equalizing and changing dynamic range properties of the sound. It is composed of multiple stages including equalization, multi-band compression and limiter.

The number of bands and active stages is configurable, and most parameters can be controlled in realtime, such as gains, attack/release times, thresholds, etc.

The effect is instantiated and controlled by channels. Each channel has the same basic architecture, but all of their parameters are independent from other channels.

The basic channel configuration is:

    Channel 0          Channel 1       ....       Channel N-1
      Input              Input                       Input
        |                  |                           |
   +----v----+        +----v----+                 +----v----+
   |inputGain|        |inputGain|                 |inputGain|
   +---------+        +---------+                 +---------+
        |                  |                           |
  +-----v-----+      +-----v-----+               +-----v-----+
  |   PreEQ   |      |   PreEQ   |               |   PreEQ   |
  +-----------+      +-----------+               +-----------+
        |                  |                           |
  +-----v-----+      +-----v-----+               +-----v-----+
  |    MBC    |      |    MBC    |               |    MBC    |
  +-----------+      +-----------+               +-----------+
        |                  |                           |
  +-----v-----+      +-----v-----+               +-----v-----+
  |  PostEQ   |      |  PostEQ   |               |  PostEQ   |
  +-----------+      +-----------+               +-----------+
        |                  |                           |
  +-----v-----+      +-----v-----+               +-----v-----+
  |  Limiter  |      |  Limiter  |               |  Limiter  |
  +-----------+      +-----------+               +-----------+
        |                  |                           |
     Output             Output                      Output
 

Where the stages are: inputGain: input gain factor in decibels (dB). 0 dB means no change in level. PreEQ: Multi-band Equalizer. MBC: Multi-band Compressor PostEQ: Multi-band Equalizer Limiter: Single band compressor/limiter.

An application creates a DynamicsProcessing object to instantiate and control this audio effect in the audio framework. A DynamicsProcessor.Config and DynamicsProcessor.Config.Builder are available to help configure the multiple stages and each band parameters if desired.

See each stage documentation for further details.

If no Config is specified during creation, a default configuration is chosen.

To attach the DynamicsProcessing to a particular AudioTrack or MediaPlayer, specify the audio session ID of this AudioTrack or MediaPlayer when constructing the effect (see AudioTrack.getAudioSessionId() and MediaPlayer.getAudioSessionId()).

To attach the DynamicsProcessing to a particular AudioTrack or MediaPlayer, specify the audio session ID of this AudioTrack or MediaPlayer when constructing the DynamicsProcessing.

See MediaPlayer.getAudioSessionId() for details on audio sessions.

See AudioEffect class for more details on controlling audio effects.

Summary

Nested classes

Base class for bands 

Base class for stages that hold bands 

Class for Channel configuration parameters. 

Class for Config object, used by DynamicsProcessing to configure and update the audio effect. 

Class for Equalizer stage 

Class for Equalizer Bands Equalizer bands have three controllable parameters: enabled/disabled, cutoffFrequency and gain 

Class for Limiter Stage Limiter is a single band compressor at the end of the processing chain, commonly used to protect the signal from overloading and distortion. 

Class for Multi-Band Compressor (MBC) stage 

Class for Multi-Band compressor bands MBC bands have multiple controllable parameters: enabled/disabled, cutoffFrequency, attackTime, releaseTime, ratio, threshold, kneeWidth, noiseGateThreshold, expanderRatio, preGain and postGain. 

base class for the different stages. 

Constants

public static final int VARIANT_FAVOR_FREQUENCY_RESOLUTION

public static final int VARIANT_FAVOR_TIME_RESOLUTION

Public constructors

public DynamicsProcessing (int audioSession)

public DynamicsProcessing (int priority, 
                int audioSession, 
                DynamicsProcessing.Config cfg)

Public methods

public DynamicsProcessing.Channel getChannelByChannelIndex (int channelIndex)

public int getChannelCount ()

public DynamicsProcessing.Config getConfig ()

public float getInputGainByChannelIndex (int channelIndex)

public DynamicsProcessing.Limiter getLimiterByChannelIndex (int channelIndex)

public DynamicsProcessing.MbcBand getMbcBandByChannelIndex (int channelIndex, 
                int band)

public DynamicsProcessing.Mbc getMbcByChannelIndex (int channelIndex)

public DynamicsProcessing.EqBand getPostEqBandByChannelIndex (int channelIndex, 
                int band)

public DynamicsProcessing.Eq getPostEqByChannelIndex (int channelIndex)

public DynamicsProcessing.EqBand getPreEqBandByChannelIndex (int channelIndex, 
                int band)

public DynamicsProcessing.Eq getPreEqByChannelIndex (int channelIndex)

public void setAllChannelsTo (DynamicsProcessing.Channel channel)

public void setChannelTo (int channelIndex, 
                DynamicsProcessing.Channel channel)

public void setInputGainAllChannelsTo (float inputGain)

public void setInputGainbyChannel (int channelIndex, 
                float inputGain)

public void setLimiterAllChannelsTo (DynamicsProcessing.Limiter limiter)

public void setLimiterByChannelIndex (int channelIndex, 
                DynamicsProcessing.Limiter limiter)

public void setMbcAllChannelsTo (DynamicsProcessing.Mbc mbc)

public void setMbcBandAllChannelsTo (int band, 
                DynamicsProcessing.MbcBand mbcBand)

public void setMbcBandByChannelIndex (int channelIndex, 
                int band, 
                DynamicsProcessing.MbcBand mbcBand)

public void setMbcByChannelIndex (int channelIndex, 
                DynamicsProcessing.Mbc mbc)

public void setPostEqAllChannelsTo (DynamicsProcessing.Eq postEq)

public void setPostEqBandAllChannelsTo (int band, 
                DynamicsProcessing.EqBand postEqBand)

public void setPostEqBandByChannelIndex (int channelIndex, 
                int band, 
                DynamicsProcessing.EqBand postEqBand)

public void setPostEqByChannelIndex (int channelIndex, 
                DynamicsProcessing.Eq postEq)

public void setPreEqAllChannelsTo (DynamicsProcessing.Eq preEq)

public void setPreEqBandAllChannelsTo (int band, 
                DynamicsProcessing.EqBand preEqBand)

public void setPreEqBandByChannelIndex (int channelIndex, 
                int band, 
                DynamicsProcessing.EqBand preEqBand)

public void setPreEqByChannelIndex (int channelIndex, 
                DynamicsProcessing.Eq preEq)