Navigation
| Name | AudioMixer |
| Type | Runtime |
| Location | /Engine/Source/Runtime/AudioMixer/ |
| Module Build Rules | AudioMixer.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FAudioFileReader | |
| FDecodingSoundSource | |
| FKeySource | |
| FMixerAudioBus | Bus instance data. Holds source id bus instances and bus sends data. |
| FMixerDevice | |
| FMixerSubmix | |
| FOnAudioDefaultDeviceChanged | |
| FOnAudioDeviceChange | |
| FOnAudioDeviceStateChanged | |
| FOnAudioOutputDevicesObtained | Called when a list of all available audio devices is retrieved |
| FOnCompletedDeviceSwap | Called when the system has swapped to another audio output device |
| FOnMainAudioOutputDeviceObtained | Called when a list of all available audio devices is retrieved |
| FOnSoundLoadComplete | Called when a load request for a sound has completed. |
| FOnSynthEnvelopeValue | Called by a synth component and returns the sound's envelope value (using an envelope follower in the audio renderer). |
| FQuantizedNotify | QuartzQuantizedCommand that basically no-ops, so the game thread can get notified on a musical boundary. |
| FQuantizedOtherClockStart | QuartzQuantizedCommand that starts a second clock on a sample-accurate boundary. |
| FQuantizedPlayCommand | QuartzQuantizedCommand that plays a sound on a sample-accurate boundary. |
| FQuantizedQueueCommand | |
| FQuantizedTickRateChange | QuartzQuantizedCommand that changes the TickRate of a clock on a sample-accurate boundary (i.e. BPM changes) |
| FQuantizedTransportReset | QuartzQuantizedCommand that resets the transport of a clock's metronome on a sample-accurate boundary. |
| FQuartzClock | FQuartzClock: This class receives, schedules, and fires quantized commands. |
| FQuartzClockManager | Class that owns, updates, and provides access to all active clocks All methods are thread-safe. |
| FQuartzClockProxy | FQuartzClockProxy: This class is a C++ handle to the underlying clock. |
| FQuartzMetronome | Class to track the passage of musical time, and allow subscribers to be notified when these musical events take place. |
| FSoundSourceDecoder | |
| FSoundWaveScrubber | Class manages the runtime generation of scrubbed audio from a reference sound wave It does this using a simple granulation technique of overlapping grains using a Hanning window. |
| FSoundWaveScrubberGenerator | |
| FSubmixEffectDynamicsProcessor | |
| FSubmixEffectReverb | |
| FSubmixEffectSubmixEQ | |
| UAudioBusSubsystem | UAudioBusSubsystem |
| UAudioDeviceNotificationSubsystem | UAudioDeviceNotificationSubsystem |
| UAudioGenerator | |
| UAudioMixerBlueprintLibrary | |
| UQuartzClockHandle | This class is a BP / Game thread wrapper around FQuartzClockProxy (to talk to the underlying clock) |
| UQuartzSubsystem | |
| UScrubbedSound | |
| USubmixEffectDynamicsProcessorPreset | |
| USubmixEffectReverbPreset | |
| USubmixEffectSubmixEQPreset | |
| USynthComponent | |
| USynthSound |
Structs
| Name | Remarks |
|---|---|
| FAudioBusKey | |
| FAudioBusSend | Struct holding mappings of runtime source ids (bus instances) to bus send level. |
| FAudioClockTimingData | Data used to interpolate the audio clock in between buffer callbacks |
| FAudioGeneratorHandle | |
| FAudioOutputDeviceInfo | Platform audio output device info, in a Blueprint-readable format |
| FAudioThreadTimingData | Data used to schedule events automatically in the audio renderer in audio mixer. |
| FChildSubmixInfo | |
| FDecodingSoundSourceHandle | |
| FPersistentQuartzSubsystemData | Data that the UQuartzSubsystem needs to persist on the AudioDevice across UWorld shutdown/startup |
| FQuartzTickableObjectsManager | |
| FSourceDecodeInit | |
| FSubmixEffectDynamicProcessorFilterSettings | |
| FSubmixEffectDynamicsProcessorSettings | Submix dynamics processor settings. |
| FSubmixEffectEQBand | The time it takes to process the master EQ effect. |
| FSubmixEffectReverbSettings | The time it takes to process the master reverb. |
| FSubmixEffectSubmixEQSettings | EQ submix effect. |
| FSubmixMap | |
| FSubmixVoiceData | |
| FSwapAudioOutputResult | Out structure for use with AudioMixerBlueprintLibrary::SwapAudioOutputDevice |
Interfaces
| Name | Remarks |
|---|---|
| IAudioBufferListener | Simple interface class to allow objects to route audio between them. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FDecodingSoundSourcePtr | TSharedPtr< FDecodingSoundSource > | SoundWaveDecoder.h | |
| FMixerSubmixPtr | TSharedPtr< FMixerSubmix, ESPMode::ThreadSafe > | AudioMixerDevice.h | |
| FMixerSubmixWeakPtr | TWeakPtr< FMixerSubmix, ESPMode::ThreadSafe > | AudioMixerDevice.h | |
| FOnAudioDefaultDeviceChangedNative | TMulticastDelegate_TwoParams< void, EAudioDeviceChangedRole, FString > | AudioDeviceNotificationSubsystem.h | |
| FOnAudioDeviceChangeNative | TMulticastDelegate_OneParam< void, FString > | AudioDeviceNotificationSubsystem.h | |
| FOnAudioDeviceStateChangedNative | TMulticastDelegate_TwoParams< void, FString, EAudioDeviceChangedState > | AudioDeviceNotificationSubsystem.h | |
| FOnAudioGenerate | TFunction< void(const float *InAudio, int32 NumSamples)> | Generators/AudioGenerator.h | |
| FOnSynthEnvelopeValueNative | TMulticastDelegate_TwoParams< void, const class UAudioComponent *, const float > | Shadow delegate declaration for above | Components/SynthComponent.h |
| FQuartzClockCommandQueuePtr | TSharedPtr< FQuartzClockCommandQueueType, ESPMode::ThreadSafe > | Quartz/AudioMixerClock.h | |
| FQuartzClockCommandQueueType | Audio::Quartz::PrivateDefs::TQuartzCommandQueue< IQuartzClock > | Quartz/AudioMixerClock.h | |
| FQuartzClockCommandQueueWeakPtr | TWeakPtr< FQuartzClockCommandQueueType, ESPMode::ThreadSafe > | Quartz/AudioMixerClock.h | |
| MetronomeCommandQueuePtr | TSharedPtr< Audio::FQuartzShareableCommandQueue, ESPMode::ThreadSafe > | Quartz/QuartzSubsystem.h | |
| MetronomeCommandQueuePtr | Quartz::FQuartzGameThreadCommandQueuePtr | Quartz/QuartzMetronome.h |
Enums
Public
| Name | Remarks |
|---|---|
| Audio::EMasterSubmixType::Type | Deprecated, use ERequiredSubmixes above. |
| Audio::EMixerSourceSubmixSendStage | Copyright Epic Games, Inc. All Rights Reserved. |
| EAudioDeviceChangedRole | EAudioDeviceChangedRole |
| EAudioDeviceChangedState | EAudioDeviceChangedState |
| EAudioMixerChannelType | A copy of Audio::EAudioMixerChannel::Type to get around UHT's refusal of namespaces. |
| EAudioMixerStreamDataFormatType | Duplicate of Audio::EAudioMixerStreamDataFormat::Type, to get around UHT's lack of namespace support. |
| EMusicalNoteName | |
| ERequiredSubmixes | |
| ESubmixEffectDynamicsChannelLinkMode | |
| ESubmixEffectDynamicsKeySource | |
| ESubmixEffectDynamicsPeakMode | |
| ESubmixEffectDynamicsProcessorType | |
| ESwapAudioOutputDeviceResultState | Resulting State of SwapAudioOutputDevice call. |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FString DataFormatAsString
(
EAudioMixerStreamDataFormatType type |
AudioMixerBlueprintLibrary.h | ||
const TCHAR * ToString
(
EAudioMixerChannelType InType |
AudioMixerBlueprintLibrary.h |