Miles Sound System SDK 7.2a

AIL_enumerate_sample_stage_properties

The function AIL_enumerate_sample_stage_properties enumerates the possible sample-level filter properties for the filter currently assigned to a given HSAMPLE processing stage.

S32 AIL_enumerate_sample_stage_properties(
  HSAMPLE S,
  SAMPLESTAGE stage,
  HINTENUM *next,
  RIB_INTERFACE_ENTRY *dest
);

In Parameters

S: specifies the HSAMPLE whose filter sample properties should be enumerated.
stage: specifies the sample stage (SP_FILTER_0 through SP_FILTER_7, or SP_OUTPUT) whose filter sample properties should be enumerated.

Out Parameters

next: is a pointer that MSS uses to keep track of the next property to return. You initialize the next variable with the constant HPROENUM_FIRST before the first call to AIL_enumerate_filter_properties.
dest: points to an structure of type RIB_INTERFACE_ENTRY that receives the property information. The most important field in this RIB structure is "entry_name" which is a pointer to the property name (which can then be used in the AIL_sample_stage_property function.

Returns

0 if no further sample properties were found; non-zero if another property was found.

Discussion

Sample-level properties are properties that are set for a single sample. For properties that are global to the filter, use the AIL_enumerate_filter_properties function.

This function is similar to AIL_enumerate_filter_sample_properties, except it works directly with an HSAMPLE/SAMPLESTAGE pair instead of requiring you to look up the HPROVIDER with AIL_sample_processor.

Group: Digital Filter Services
Related Functions: AIL_enumerate_filter_properties, AIL_enumerate_filter_sample_properties, AIL_enumerate_output_filter_driver_properties, AIL_enumerate_output_filter_sample_properties, AIL_sample_processor, AIL_sample_stage_property
Related Basic Types: HINTENUM, HSAMPLE, S32, SAMPLESTAGE
Related Structures: RIB_INTERFACE_ENTRY