AudioDefines.h File Reference

#include "HAL/Platform.h"

Go to the source code of this file.

Namespaces
namespace	Audio
	NO_LOGGING.

Macros
#define	MAX_AUDIOCHANNELS   64
#define	INDEFINITELY_LOOPING_DURATION   10000.0f
#define	SPEAKER_COUNT   6
#define	DEFAULT_LOW_FREQUENCY   600.0f
#define	DEFAULT_MID_FREQUENCY   1000.0f
#define	DEFAULT_HIGH_FREQUENCY   2000.0f
#define	MAX_VOLUME   4.0f
#define	MIN_PITCH   0.4f
#define	MAX_PITCH   2.0f
#define	MIN_VOLUME_LINEAR   SMALL_NUMBER
#define	MIN_VOLUME_DECIBELS   -160.f
#define	MIN_SOUND_PRIORITY   0.0f
#define	MAX_SOUND_PRIORITY   100.0f
#define	DEFAULT_SUBTITLE_PRIORITY   10000.0f
#define	MIN_FILTER_GAIN   0.126f
#define	MAX_FILTER_GAIN   7.94f
#define	MIN_FILTER_FREQUENCY   20.0f
#define	MAX_FILTER_FREQUENCY   20000.0f
#define	MIN_FILTER_BANDWIDTH   0.1f
#define	MAX_FILTER_BANDWIDTH   2.0f
#define	ENABLE_AUDIO_DEBUG   !UE_BUILD_SHIPPING

Typedefs
using	Audio::FDeviceId = uint32

Variables
constexpr float	Audio::MonoUpmixFullVolume = 1.0f
constexpr float	Audio::MonoUpmixEqualPower = 0.707f
constexpr float	Audio::MonoUpmixLinear = 0.5f

Macro Definition Documentation

DEFAULT_HIGH_FREQUENCY

#define DEFAULT_HIGH_FREQUENCY   2000.0f

DEFAULT_LOW_FREQUENCY

#define DEFAULT_LOW_FREQUENCY   600.0f

DEFAULT_MID_FREQUENCY

#define DEFAULT_MID_FREQUENCY   1000.0f

DEFAULT_SUBTITLE_PRIORITY

#define DEFAULT_SUBTITLE_PRIORITY   10000.0f

ENABLE_AUDIO_DEBUG

#define ENABLE_AUDIO_DEBUG   !UE_BUILD_SHIPPING

Debugger is Available on non-shipping builds

INDEFINITELY_LOOPING_DURATION

#define INDEFINITELY_LOOPING_DURATION   10000.0f

Length of sound in seconds to be considered as looping forever

MAX_AUDIOCHANNELS

#define MAX_AUDIOCHANNELS   64

Maximum number of channels that can be set using the ini setting

MAX_FILTER_BANDWIDTH

#define MAX_FILTER_BANDWIDTH   2.0f

MAX_FILTER_FREQUENCY

#define MAX_FILTER_FREQUENCY   20000.0f

MAX_FILTER_GAIN

#define MAX_FILTER_GAIN   7.94f

MAX_PITCH

#define MAX_PITCH   2.0f

MAX_SOUND_PRIORITY

#define MAX_SOUND_PRIORITY   100.0f

MAX_VOLUME

#define MAX_VOLUME   4.0f

MIN_FILTER_BANDWIDTH

#define MIN_FILTER_BANDWIDTH   0.1f

MIN_FILTER_FREQUENCY

#define MIN_FILTER_FREQUENCY   20.0f

MIN_FILTER_GAIN

#define MIN_FILTER_GAIN   0.126f

Some filters don't work properly with extreme values, so these are the limits

MIN_PITCH

#define MIN_PITCH   0.4f

MIN_SOUND_PRIORITY

#define MIN_SOUND_PRIORITY   0.0f

MIN_VOLUME_DECIBELS

#define MIN_VOLUME_DECIBELS   -160.f

MIN_VOLUME_LINEAR

#define MIN_VOLUME_LINEAR   SMALL_NUMBER

SPEAKER_COUNT

#define SPEAKER_COUNT   6

Some defaults to help cross platform consistency