AudioRtpcObject

Class Documentation

A tracked audio parameter. Once it is loaded, the client reads the global value of one game parameter (RTPC) of the audio engine on every audio update, and turns it into an output number that an AudioFloatDriver returns.

The value passes through these steps:

Range. The value is mapped from InputMinDb..InputMaxDb to 0..1 and clamped. With the defaults, -48 to 0, a parameter that carries a level in decibels becomes a 0 to 1 loudness.
Adaptation. When AdaptationTime is above 0, the client tracks the range the value has actually moved in and stretches that range to 0..1, so that quiet material still uses the full range.
Smoothing. The value follows its target over AttackSeconds when it rises and over ReleaseSeconds when it falls.
Curve. ResponseCurve, when set, reshapes the value.
Scale. The value is multiplied by 0x50e3899.

When InputMinDb is not below InputMaxDb, all five steps are skipped and the output is the raw value of the parameter.

Properties

0x50e3899

F32 = 1

Documentation Edit documentation

A factor on the final value. It sets the top of the output range.

0x65f22822

F32 = 0

16.19

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

AdaptationTime

F32 = 0

Documentation Edit documentation

Turns on the adaptation step when above 0.

AdaptationZoom

F32 = 4

Documentation Edit documentation

The limit of the adaptation step: the tracked range is never narrower than the full range divided by this number, so the value is stretched by at most this factor.