IEffect

Initialize effect engine--all configurations return to default.

Apply new audio parameters configurations for input and output buffers.The provider callbacks may be empty, but in this case the buffer must be provided in the EffectConfig structure.

Reset the effect engine.Keep configuration but resets state and buffer content.

Enable processing.

Disable processing.

Set the rendering device the audio output path is connected to.The effect implementation must set EFFECT_FLAG_DEVICE_IND flag in its descriptor to receive this command when the device changes.

Note:this method is only supported for effects inserted into the output chain.

Set and get volume.Used by audio framework to delegate volume control to effect engine.The effect implementation must set EFFECT_FLAG_VOLUME_CTRL flag in its descriptor to receive this command.The effect engine must return the volume that should be applied before the effect is processed.The overall volume(the volume actually applied by the effect engine multiplied by the returned value)should match the value indicated in the command.

Notify the effect of the volume change.The effect implementation must set EFFECT_FLAG_VOLUME_IND flag in its descriptor to receive this command.

Set the audio mode.The effect implementation must set EFFECT_FLAG_AUDIO_MODE_IND flag in its descriptor to receive this command when the audio mode changes.

Apply new audio parameters configurations for input and output buffers of reverse stream.An example of reverse stream is the echo reference supplied to an Acoustic Echo Canceler.

Set the capture device the audio input path is connected to.The effect implementation must set EFFECT_FLAG_DEVICE_IND flag in its descriptor to receive this command when the device changes.

Note:this method is only supported for effects inserted into the input chain.

Read audio parameters configurations for input and output buffers.

Read audio parameters configurations for input and output buffers of reverse stream.

Queries for supported combinations of main and auxiliary channels(e.g.for a multi-microphone noise suppressor).

Retrieves the current configuration of main and auxiliary channels.

Sets the current configuration of main and auxiliary channels.

Set the audio source the capture path is configured for(Camcorder, voice recognition.. .).

Note:this method is only supported for effects inserted into the input chain.

This command indicates if the playback thread the effect is attached to is offloaded or not, and updates the I/O handle of the playback thread the effect is attached to.

Returns the effect descriptor.

Set up required transports for passing audio buffers to the effect.

The transport consists of shared memory and a message queue for reporting effect processing operation status.The shared memory is set up separately using 'setProcessBuffers' method.

Processing is requested by setting 'REQUEST_PROCESS' or 'REQUEST_PROCESS_REVERSE' EventFlags associated with the status message queue.The result of processing may be one of the following:OK if there were no errors during processing;INVALID_ARGUMENTS if audio buffers are invalid;INVALID_STATE if the engine has finished the disable phase;NOT_INITIALIZED if the audio buffers were not set;NOT_SUPPORTED if the requested processing type is not supported by the effect.

Set up input and output buffers for processing audio data.The effect may modify both the input and the output buffer during the operation.Buffers may be set multiple times during effect lifetime.

The input and the output buffer may be reused between different effects, and the input buffer may be used as an output buffer.Buffers are distinguished using 'AudioBuffer.id' field.

Execute a vendor specific command on the effect.The command code and data, as well as result data are not interpreted by Android Framework and are passed as-is between the application and the effect.

The effect must use standard POSIX.1-2001 error codes for the operation completion status.

Use this method only if the effect is provided by a third party, and there is no interface defined for it.This method only works for effects implemented in software.

Set a vendor-specific parameter and apply it immediately.The parameter code and data are not interpreted by Android Framework and are passed as-is between the application and the effect.

The effect must use INVALID_ARGUMENTS return code if the parameter ID is unknown or if provided parameter data is invalid.If the effect does not support setting vendor-specific parameters, it must return NOT_SUPPORTED.

Use this method only if the effect is provided by a third party, and there is no interface defined for it.This method only works for effects implemented in software.

Get a vendor-specific parameter value.The parameter code and returned data are not interpreted by Android Framework and are passed as-is between the application and the effect.

The effect must use INVALID_ARGUMENTS return code if the parameter ID is unknown.If the effect does not support setting vendor-specific parameters, it must return NOT_SUPPORTED.

Use this method only if the effect is provided by a third party, and there is no interface defined for it.This method only works for effects implemented in software.

Get supported configs for a vendor-specific feature.The configs returned are not interpreted by Android Framework and are passed as-is between the application and the effect.

The effect must use INVALID_ARGUMENTS return code if the feature ID is unknown.If the effect does not support getting vendor-specific feature configs, it must return NOT_SUPPORTED.If the feature is supported but the total number of supported configurations exceeds the maximum number indicated by the caller, the method must return RESULT_TOO_BIG.

Use this method only if the effect is provided by a third party, and there is no interface defined for it.This method only works for effects implemented in software.

Get the current config for a vendor-specific feature.The config returned is not interpreted by Android Framework and is passed as-is between the application and the effect.

The effect must use INVALID_ARGUMENTS return code if the feature ID is unknown.If the effect does not support getting vendor-specific feature configs, it must return NOT_SUPPORTED.

Use this method only if the effect is provided by a third party, and there is no interface defined for it.This method only works for effects implemented in software.

Set the current config for a vendor-specific feature.The config data is not interpreted by Android Framework and is passed as-is between the application and the effect.

The effect must use INVALID_ARGUMENTS return code if the feature ID is unknown.If the effect does not support getting vendor-specific feature configs, it must return NOT_SUPPORTED.

Use this method only if the effect is provided by a third party, and there is no interface defined for it.This method only works for effects implemented in software.

Called by the framework to deinitialize the effect and free up all the currently allocated resources.It is recommended to close the effect on the client side as soon as it is becomes unused.