Added in API level 28

Config

class Config
kotlin.Any
   ↳ android.media.audiofx.DynamicsProcessing.Config

Class for Config object, used by DynamicsProcessing to configure and update the audio effect. use Builder to instantiate objects of this type.

Summary

Nested classes

Public methods
DynamicsProcessing.Channel!

Gets the Channel configuration object by using the channel index
Float

Gets inputGain value in decibels (dB) for channel indicated by channelIndex
DynamicsProcessing.Limiter!

DynamicsProcessing.MbcBand!
getMbcBandByChannelIndex(channelIndex: Int, band: Int)
Int

Gets number of bands configured for the Mbc stage.
DynamicsProcessing.Mbc!
getMbcByChannelIndex(channelIndex: Int)
DynamicsProcessing.EqBand!
getPostEqBandByChannelIndex(channelIndex: Int, band: Int)
Int

Gets number of bands configured for the PostEq stage.
DynamicsProcessing.Eq!

DynamicsProcessing.EqBand!
getPreEqBandByChannelIndex(channelIndex: Int, band: Int)
Int

Gets number of bands configured for the PreEq stage.
DynamicsProcessing.Eq!
getPreEqByChannelIndex(channelIndex: Int)

Gets PreEq stage from channel indicated by channelIndex
Float

Gets preferred frame duration in milliseconds (ms).
Int

Gets variant for effect engine See VARIANT_FAVOR_FREQUENCY_RESOLUTION and VARIANT_FAVOR_TIME_RESOLUTION.
Boolean

Gets if Limiter stage is in use
Boolean

Gets if Mbc stage is in use
Boolean

Gets if PostEq stage is in use
Boolean

Gets if preEq stage is in use
Unit

Sets ALL channels to the chosen Channel object.
Unit
setChannelTo(channelIndex: Int, channel: DynamicsProcessing.Channel!)

Sets the chosen Channel object in the selected channelIndex Note that all the stages should have the same number of bands than the existing Channel object.
Unit

Sets the inputGain value in decibels (dB) for ALL channels
Unit
setInputGainByChannelIndex(channelIndex: Int, inputGain: Float)

Sets the inputGain value in decibels (dB) for the channel indicated by channelIndex.
Unit

Unit

Unit

Unit

Unit
setMbcBandByChannelIndex(channelIndex: Int, band: Int, mbcBand: DynamicsProcessing.MbcBand!)
Unit

Unit

Unit

Unit
setPostEqBandByChannelIndex(channelIndex: Int, band: Int, postEqBand: DynamicsProcessing.EqBand!)
Unit

Unit

Sets the PreEq stage configuration for ALL channels.
Unit

Unit
setPreEqBandByChannelIndex(channelIndex: Int, band: Int, preEqBand: DynamicsProcessing.EqBand!)
Unit

Sets the PreEq stage configuration for the channel indicated by channelIndex.
String

Public methods

getChannelByChannelIndex

Added in API level 28
fun getChannelByChannelIndex(channelIndex: Int): DynamicsProcessing.Channel!

Gets the Channel configuration object by using the channel index

Parameters
channelIndex Int: of desired Channel object
Return
DynamicsProcessing.Channel! Channel configuration object

getInputGainByChannelIndex

Added in API level 28
fun getInputGainByChannelIndex(channelIndex: Int): Float

Gets inputGain value in decibels (dB) for channel indicated by channelIndex

Parameters
channelIndex Int: index of channel of interest
Return
Float inputGain value in decibels (dB). 0 dB means no change.

getLimiterByChannelIndex

Added in API level 28
fun getLimiterByChannelIndex(channelIndex: Int): DynamicsProcessing.Limiter!

getMbcBandByChannelIndex

Added in API level 28
fun getMbcBandByChannelIndex(
    channelIndex: Int, 
    band: Int
): DynamicsProcessing.MbcBand!

getMbcBandCount

Added in API level 28
fun getMbcBandCount(): Int

Gets number of bands configured for the Mbc stage.

Return
Int number of bands configured for the Mbc stage.

getMbcByChannelIndex

Added in API level 28
fun getMbcByChannelIndex(channelIndex: Int): DynamicsProcessing.Mbc!

getPostEqBandByChannelIndex

Added in API level 28
fun getPostEqBandByChannelIndex(
    channelIndex: Int, 
    band: Int
): DynamicsProcessing.EqBand!

getPostEqBandCount

Added in API level 28
fun getPostEqBandCount(): Int

Gets number of bands configured for the PostEq stage.

Return
Int number of bands configured for the PostEq stage.

getPostEqByChannelIndex

Added in API level 28
fun getPostEqByChannelIndex(channelIndex: Int): DynamicsProcessing.Eq!

getPreEqBandByChannelIndex

Added in API level 28
fun getPreEqBandByChannelIndex(
    channelIndex: Int, 
    band: Int
): DynamicsProcessing.EqBand!

getPreEqBandCount

Added in API level 28
fun getPreEqBandCount(): Int

Gets number of bands configured for the PreEq stage.

Return
Int number of bands configured for the PreEq stage.

getPreEqByChannelIndex

Added in API level 28
fun getPreEqByChannelIndex(channelIndex: Int): DynamicsProcessing.Eq!

Gets PreEq stage from channel indicated by channelIndex

Parameters
channelIndex Int: index of channel of interest
Return
DynamicsProcessing.Eq! PreEq stage configuration object

getPreferredFrameDuration

Added in API level 28
fun getPreferredFrameDuration(): Float

Gets preferred frame duration in milliseconds (ms).

Return
Float preferred frame duration in milliseconds (ms)

getVariant

Added in API level 28
fun getVariant(): Int

Gets variant for effect engine See VARIANT_FAVOR_FREQUENCY_RESOLUTION and VARIANT_FAVOR_TIME_RESOLUTION.

Return
Int variant of effect engine

isLimiterInUse

Added in API level 28
fun isLimiterInUse(): Boolean

Gets if Limiter stage is in use

Return
Boolean true if Limiter stage is in use;

isMbcInUse

Added in API level 28
fun isMbcInUse(): Boolean

Gets if Mbc stage is in use

Return
Boolean true if Mbc stage is in use;

isPostEqInUse

Added in API level 28
fun isPostEqInUse(): Boolean

Gets if PostEq stage is in use

Return
Boolean true if PostEq stage is in use;

isPreEqInUse

Added in API level 28
fun isPreEqInUse(): Boolean

Gets if preEq stage is in use

Return
Boolean true if preEq stage is in use;

setAllChannelsTo

Added in API level 28
fun setAllChannelsTo(channel: DynamicsProcessing.Channel!): Unit

Sets ALL channels to the chosen Channel object. Note that all the stages should have the same number of bands than the existing ones.

Parameters
channel DynamicsProcessing.Channel!: Channel configuration object to be set.

setChannelTo

Added in API level 28
fun setChannelTo(
    channelIndex: Int, 
    channel: DynamicsProcessing.Channel!
): Unit

Sets the chosen Channel object in the selected channelIndex Note that all the stages should have the same number of bands than the existing Channel object.

Parameters
channelIndex Int: index of channel to be replaced
channel DynamicsProcessing.Channel!: Channel configuration object to be set

setInputGainAllChannelsTo

Added in API level 28
fun setInputGainAllChannelsTo(inputGain: Float): Unit

Sets the inputGain value in decibels (dB) for ALL channels

Parameters
inputGain Float: desired value in decibels (dB)

setInputGainByChannelIndex

Added in API level 28
fun setInputGainByChannelIndex(
    channelIndex: Int, 
    inputGain: Float
): Unit

Sets the inputGain value in decibels (dB) for the channel indicated by channelIndex.

Parameters
channelIndex Int: index of channel of interest
inputGain Float: desired value in decibels (dB).

setLimiterAllChannelsTo

Added in API level 28
fun setLimiterAllChannelsTo(limiter: DynamicsProcessing.Limiter!): Unit

setLimiterByChannelIndex

Added in API level 28
fun setLimiterByChannelIndex(
    channelIndex: Int, 
    limiter: DynamicsProcessing.Limiter!
): Unit

setMbcAllChannelsTo

Added in API level 28
fun setMbcAllChannelsTo(mbc: DynamicsProcessing.Mbc!): Unit

setMbcBandAllChannelsTo

Added in API level 28
fun setMbcBandAllChannelsTo(
    band: Int, 
    mbcBand: DynamicsProcessing.MbcBand!
): Unit

setMbcBandByChannelIndex

Added in API level 28
fun setMbcBandByChannelIndex(
    channelIndex: Int, 
    band: Int, 
    mbcBand: DynamicsProcessing.MbcBand!
): Unit

setMbcByChannelIndex

Added in API level 28
fun setMbcByChannelIndex(
    channelIndex: Int, 
    mbc: DynamicsProcessing.Mbc!
): Unit

setPostEqAllChannelsTo

Added in API level 28
fun setPostEqAllChannelsTo(postEq: DynamicsProcessing.Eq!): Unit

setPostEqBandAllChannelsTo

Added in API level 28
fun setPostEqBandAllChannelsTo(
    band: Int, 
    postEqBand: DynamicsProcessing.EqBand!
): Unit

setPostEqBandByChannelIndex

Added in API level 28
fun setPostEqBandByChannelIndex(
    channelIndex: Int, 
    band: Int, 
    postEqBand: DynamicsProcessing.EqBand!
): Unit

setPostEqByChannelIndex

Added in API level 28
fun setPostEqByChannelIndex(
    channelIndex: Int, 
    postEq: DynamicsProcessing.Eq!
): Unit

setPreEqAllChannelsTo

Added in API level 28
fun setPreEqAllChannelsTo(preEq: DynamicsProcessing.Eq!): Unit

Sets the PreEq stage configuration for ALL channels. Note that new preEq stage must have the same number of bands than original preEq stages.

Parameters
preEq DynamicsProcessing.Eq!: desired PreEq configuration to be set

setPreEqBandAllChannelsTo

Added in API level 28
fun setPreEqBandAllChannelsTo(
    band: Int, 
    preEqBand: DynamicsProcessing.EqBand!
): Unit

setPreEqBandByChannelIndex

Added in API level 28
fun setPreEqBandByChannelIndex(
    channelIndex: Int, 
    band: Int, 
    preEqBand: DynamicsProcessing.EqBand!
): Unit

setPreEqByChannelIndex

Added in API level 28
fun setPreEqByChannelIndex(
    channelIndex: Int, 
    preEq: DynamicsProcessing.Eq!
): Unit

Sets the PreEq stage configuration for the channel indicated by channelIndex. Note that new preEq stage must have the same number of bands than original preEq stage

Parameters
channelIndex Int: index of channel to be set
preEq DynamicsProcessing.Eq!: desired PreEq configuration to be set

toString

Added in API level 28
fun toString(): String
Return
String a string representation of the object.