AudioNodeEmitterDecayModel.CreateNatural Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Creates an AudioNodeEmitterDecayModel with a natural roll-off model using a distance-squared formula.
public:
static AudioNodeEmitterDecayModel ^ CreateNatural(double minGain, double maxGain, double unityGainDistance, double cutoffDistance); static AudioNodeEmitterDecayModel CreateNatural(double const& minGain, double const& maxGain, double const& unityGainDistance, double const& cutoffDistance);public static AudioNodeEmitterDecayModel CreateNatural(double minGain, double maxGain, double unityGainDistance, double cutoffDistance);function createNatural(minGain, maxGain, unityGainDistance, cutoffDistance)Public Shared Function CreateNatural (minGain As Double, maxGain As Double, unityGainDistance As Double, cutoffDistance As Double) As AudioNodeEmitterDecayModelParameters
- minGain
-
Double
double
The minimum gain applied to the signal.
- maxGain
-
Double
double
The maximum gain applied to the signal.
- unityGainDistance
-
Double
double
The distance at which the gain of the signal is unaffected by decay.
- cutoffDistance
-
Double
double
The distance at which the gain is minGain.
Returns
The created decay model.
Remarks
The distance values for unityGainDistance and cutoffDistance are expressed in meters, but can be scaled by setting the AudioNodeEmitter.DistanceScale property.
The minGain parameter value must be greater than or equal to 1.58439*10-5, and the maxGain parameter must be less than or equal to 3.98. In decibels, these limits map to a range of -96 dB to 12 dB. Convert from a decibel value to amplitude scale using the equation gain = 10(dB/20) where dB is the decibel value you wish to convert.