Miles Sound System SDK 7.2a

AIL_set_sample_processor

The function AIL_set_sample_processor assigns the filter or mixer stages for a specific sample.

HPROVIDER AIL_set_sample_processor(
  HSAMPLE S,
  SAMPLESTAGE pipeline_stage,
  HPROVIDER provider
);

In Parameters

S: specifies the HSAMPLE handle to use.
pipeline_stage: specifies the stage to assign the filter to. Use one of the SAMPLESTAGE constants.
provider: specifies the provider to set. Use zero to remove the current filter.

Returns

The previously installed provider value.

Discussion

This function is usually used to install a new filter processor. Once a sample-specific filter has been installed, you can read and change sample-specific properties with the AIL_sample_stage_property function.

You remove an installed filter by calling this function with zero for the provider parameter.

In most cases, you should install any DSP filters after declaring an HSAMPLE's format and before starting playback of an HSAMPLE. Installing or removing a DSP pipeline filter on a playing HSAMPLE may cause audible artifacts. To disable an existing filter's influence on a given HSAMPLE without uninstalling the filter, set the filter's "Mix' property (if available) to 0.0.

On the original Xbox, software DSP filters cannot be applied to Xbox ADPCM samples or 8-bit PCM samples.

Example files that use this function: filter.cpp, multiflt.cpp

Group: Digital Filter Services
Related Functions: AIL_enumerate_filters, AIL_find_filter, AIL_open_filter, AIL_sample_processor, AIL_sample_stage_property, AIL_set_digital_driver_processor
Related Basic Types: HPROVIDER, HSAMPLE, SAMPLESTAGE
Related FAQs: How do I set a DSP filter on a sample?