virtual AkReal32 AK::IAkSourcePlugin::GetEnvelope ( ) const [inline, virtual]

This method is called to determine the estimated envelope of the source.

Returns:: The estimated envelope of the data that will be generated in the next call to Execute(). The envelope value should be normalized to the highest peak of the entire duration of the source. Expected range is [0,1]. If envelope and peak value cannot be predicted, the source should return 1 (no envelope).

See also:

Definition at line 1013 of file IAkPlugin.h.

Wwise SDK 2015.1.9