Inside Macintosh: Apple Game Sprockets Guide /

Chapter 1 - SoundSprocket / SoundSprocket Reference

SoundSprocket Functions / Creating and Managing Listeners

SSpListener_SetMedium

You can use the SSpListener_SetMedium function to set the sound medium and relative humidity of a listener.

OSStatus SSpListener_SetMedium (
SSpListenerReference inListenerReference,
UInt32 inMedium,
float inHumidity);

inListenerReference

A listener reference.

inMedium

The desired sound medium of the listener. See "Sound Media" (page 1-25) for a description of the available sound media.

inHumidity

The desired relative humidity of the listener. Humidity is a floating-point value between 0.0 (indicating dry air) and 100.0 (indicating dense fog).

function result

A result code.

DESCRIPTION

The SSpListener_SetMedium function sets the sound medium and relative humidity of the listener specified by the inListenerReference parameter to the values specified in the inMedium and inHumidity parameters. The inHumidity parameter is used only if the value in the inMedium parameter is kSSpMedium_Air; otherwise, you should set inHumidity to 0.0.