AudioMixer.h File Reference

#include "Async/Future.h"
#include "AudioMixerLog.h"
#include "AudioMixerNullDevice.h"
#include "AudioMixerTypes.h"
#include "Containers/Array.h"
#include "Containers/ArrayView.h"
#include "Containers/Set.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "DSP/BufferVectorOperations.h"
#include "DSP/Dsp.h"
#include "DSP/ParamInterpolator.h"
#include "HAL/CriticalSection.h"
#include "HAL/PlatformMath.h"
#include "HAL/Runnable.h"
#include "HAL/ThreadSafeBool.h"
#include "Logging/LogCategory.h"
#include "Logging/LogMacros.h"
#include "Logging/LogVerbosity.h"
#include "Misc/AssertionMacros.h"
#include "Misc/Optional.h"
#include "Misc/ScopeLock.h"
#include "Misc/SingleThreadRunnable.h"
#include "Modules/ModuleInterface.h"
#include "Stats/Stats.h"
#include "Templates/Function.h"
#include "Templates/SharedPointer.h"
#include "Templates/UniquePtr.h"
#include "Trace/Detail/Channel.h"
#include "UObject/NameTypes.h"

Go to the source code of this file.

Classes
struct	Audio::FAudioPlatformDeviceInfo
class	Audio::IAudioMixer
class	Audio::IAudioPlatformDeviceInfoCache
struct	Audio::FAudioMixerOpenStreamParams
struct	Audio::FAudioOutputStreamInfo
struct	Audio::FAudioRenderTimeAnalysis
class	Audio::FOutputBuffer
class	Audio::IAudioMixerDeviceChangedListener
struct	Audio::IAudioMixerDeviceChangedListener::FFormatChangedData
struct	Audio::FDeviceSwapContext
struct	Audio::FDeviceSwapResult
class	Audio::IAudioMixerPlatformInterface
class	Audio::FAudioMixerPlatformSwappable
class	IAudioDeviceModule

Namespaces
namespace	Audio
	NO_LOGGING.
namespace	EAudioMixerChannel

Macros
#define	UE_API   AUDIOMIXERCORE_API
#define	AUDIO_PLATFORM_LOG_ONCE(INFO, VERBOSITY)   (AudioMixerPlatformLogOnce(INFO, FString(__FILE__), __LINE__, ELogVerbosity::VERBOSITY))
#define	AUDIO_PLATFORM_ERROR(INFO)   (AudioMixerPlatformLogOnce(INFO, FString(__FILE__), __LINE__, ELogVerbosity::Error))
#define	AUDIO_MIXER_ENABLE_DEBUG_MODE   1
#define	AUDIO_MIXER_CHECK(expr)   ensure(expr)
#define	AUDIO_MIXER_CHECK_GAME_THREAD(_MixerDevice)   (_MixerDevice->CheckAudioThread())
#define	AUDIO_MIXER_CHECK_AUDIO_PLAT_THREAD(_MixerDevice)   (_MixerDevice->CheckAudioRenderingThread())
#define	AUDIO_MIXER_MAX_OUTPUT_CHANNELS   8
#define	AUDIO_MIXER_DEFAULT_DEVICE_INDEX   INDEX_NONE

Typedefs
using	FSoundWaveProxyPtr = TSharedPtr< FSoundWaveProxy, ESPMode::ThreadSafe >
using	FSoundWavePtr = TSharedPtr< FSoundWaveData, ESPMode::ThreadSafe >

Enumerations
enum	EAudioMixerChannel::Type {   EAudioMixerChannel::FrontLeft , EAudioMixerChannel::FrontRight , EAudioMixerChannel::FrontCenter , EAudioMixerChannel::LowFrequency ,   EAudioMixerChannel::BackLeft , EAudioMixerChannel::BackRight , EAudioMixerChannel::FrontLeftOfCenter , EAudioMixerChannel::FrontRightOfCenter ,   EAudioMixerChannel::BackCenter , EAudioMixerChannel::SideLeft , EAudioMixerChannel::SideRight , EAudioMixerChannel::TopCenter ,   EAudioMixerChannel::TopFrontLeft , EAudioMixerChannel::TopFrontCenter , EAudioMixerChannel::TopFrontRight , EAudioMixerChannel::TopBackLeft ,   EAudioMixerChannel::TopBackCenter , EAudioMixerChannel::TopBackRight , EAudioMixerChannel::Unknown , EAudioMixerChannel::ChannelTypeCount ,   EAudioMixerChannel::DefaultChannel = FrontLeft }
enum class	Audio::EDeviceEndpointType { Audio::Unknown , Audio::Render , Audio::Capture }
enum class	Audio::EAudioDeviceRole { Audio::Console , Audio::Multimedia , Audio::Communications , Audio::COUNT }
enum class	Audio::EAudioDeviceState {   Audio::Active , Audio::Disabled , Audio::NotPresent , Audio::Unplugged ,   Audio::COUNT }

Functions
	DECLARE_STATS_GROUP (TEXT("AudioMixer"), STATGROUP_AudioMixer, STATCAT_Advanced)
	DECLARE_CYCLE_STAT_EXTERN (TEXT("Render Audio"), STAT_AudioMixerRenderAudio, STATGROUP_AudioMixer, AUDIOMIXERCORE_API)
const TCHAR *	EAudioMixerChannel::ToString (EAudioMixerChannel::Type InType)

Variables
constexpr int32	EAudioMixerChannel::MaxSupportedChannel = EAudioMixerChannel::TopCenter

Macro Definition Documentation

AUDIO_MIXER_CHECK

#define AUDIO_MIXER_CHECK

(

expr

)

ensure(expr)

AUDIO_MIXER_CHECK_AUDIO_PLAT_THREAD

#define AUDIO_MIXER_CHECK_AUDIO_PLAT_THREAD

(

_MixerDevice

)

(_MixerDevice->CheckAudioRenderingThread())

AUDIO_MIXER_CHECK_GAME_THREAD

#define AUDIO_MIXER_CHECK_GAME_THREAD

(

_MixerDevice

)

(_MixerDevice->CheckAudioThread())

AUDIO_MIXER_DEFAULT_DEVICE_INDEX

#define AUDIO_MIXER_DEFAULT_DEVICE_INDEX   INDEX_NONE

AUDIO_MIXER_ENABLE_DEBUG_MODE

#define AUDIO_MIXER_ENABLE_DEBUG_MODE   1

AUDIO_MIXER_MAX_OUTPUT_CHANNELS

#define AUDIO_MIXER_MAX_OUTPUT_CHANNELS   8

AUDIO_PLATFORM_ERROR

#define AUDIO_PLATFORM_ERROR

(

INFO

)

(AudioMixerPlatformLogOnce(INFO, FString(__FILE__), __LINE__, ELogVerbosity::Error))

AUDIO_PLATFORM_LOG_ONCE

#define AUDIO_PLATFORM_LOG_ONCE	(		INFO,
			VERBOSITY
	)		(AudioMixerPlatformLogOnce(INFO, FString(__FILE__), __LINE__, ELogVerbosity::VERBOSITY))

UE_API

#define UE_API   AUDIOMIXERCORE_API

Typedef Documentation

FSoundWaveProxyPtr

using FSoundWaveProxyPtr = TSharedPtr<FSoundWaveProxy, ESPMode::ThreadSafe>

FSoundWavePtr

using FSoundWavePtr = TSharedPtr<FSoundWaveData, ESPMode::ThreadSafe>

Function Documentation

DECLARE_CYCLE_STAT_EXTERN()

DECLARE_CYCLE_STAT_EXTERN	(	TEXT("Render Audio")	,
		STAT_AudioMixerRenderAudio	,
		STATGROUP_AudioMixer	,
		AUDIOMIXERCORE_API
	)

DECLARE_STATS_GROUP()

DECLARE_STATS_GROUP	(	TEXT("AudioMixer")	,
		STATGROUP_AudioMixer	,
		STATCAT_Advanced
	)