Miles Sound System SDK 7.2a

AIL_set_sample_occlusion

The function AIL_set_sample_occlusion sets the occlusion for the specified 3D sample.

void AIL_set_sample_occlusion(
  HSAMPLE S,
  F32 occlusion
);

In Parameters

S: indicates the sample handle to control.
occlusion: is the amount that the sample is occluded. This is a linear floating point value from completely non-occluded (0.0) to completely occluded (1.0).

Discussion

Occlusion means the sound is completely blocked - a sound playing in another room separated by a wall, for example.

By default, samples are completely non-occluded.

On most providers, occlusions are emulated with volume control. On the Miles Fast 2D, Dolby Surround, DTS, and EAX 2/3/4 providers, however, occlusions are performed in with a low-pass filter and sound really cool (they aren't completely linear across the frequency scale - you can still faintly hear low-frequency sounds - just like the guy with the stereo upstairs).

Example files that use this function: examms.cpp

Group: Digital Audio Services
Related Sections: Creative's EAX 2 Properties
Related Functions: AIL_sample_occlusion, AIL_set_sample_exclusion, AIL_set_sample_obstruction
Related Basic Types: F32, HSAMPLE, void
Related FAQs: How do I apply a low-pass filter?, What's the best way to port my older Miles application to MSS 7?