API Reference / Audio / audSet3DSourceMinMaxDistance

audSet3DSourceMinMaxDistance

Sets the minimum and maximum distance for 3D audio attenuation. Takes channel (channel handle), maxDistance (maximum audible distance), minDistance (full volume distance). Returns nothing.

Audio

Parameters & Returns

Parameters

channel Int
maxDistance Double
minDistance Double

Returns

Void

Quick Summary

Sets the minimum and maximum distance for 3D audio attenuation. Takes channel (channel handle), maxDistance (maximum audible distance), minDistance (full volume distance). Returns nothing.

Technical Exegesis...

Configures the distance range for volume attenuation of a 3D audio source. Within minDistance, the sound plays at full volume. Beyond maxDistance, the sound plays at minimum volume. Between these distances, volume attenuates based on the attenuation model.

Does nothing if the channel handle is invalid or <= 0. Use this to control how far a sound can be heard. Smaller values make sounds more localized, larger values make them audible from farther away.

Example

Example.bam 
; Configure 3D audio parameters for more noticeable distance effect
; minDistance = 50 (full volume up to 50 pixels)
; maxDistance = 400 (silent beyond 400 pixels)

audSet3DSourceMinMaxDistance(channel, 50.0, 400.0)
Since: 1.0 Status: Stable
← Back to Audio