Functions
Audio\|FMOD
float32	GetGlobalParameterByName (FName Name)
	Will be deprecated in FMOD 2.01, use GetGlobalParameterValueByName(FName, float, float) instead. Get a global parameter from the System.
FFMODEventInstance	PlayEvent2D (UObject WorldContextObject, UFMODEvent Event, bool bAutoPlay)
	Plays an event. This returns an FMOD Event Instance. The sound does not travel with any actor.
void	LoadBankSampleData (UFMODBank Bank)
	Load bank sample data.
void	MixerSuspend ()
	Suspend the FMOD mixer. Used when suspending the application.
void	UnloadEventSampleData (UObject WorldContextObject, UFMODEvent Event)
	Unload event sample data.
void	UnloadBankSampleData (UFMODBank Bank)
	Unload bank sample data.
void	UnloadBank (UFMODBank Bank)
	Unloads a bank.
void	SetOutputDriverByName (FString NewDriverName)
	Set current output device by name or part of the name.
void	SetOutputDriverByIndex (int NewDriverIndex)
	Set current output device by its index from GetOutputDrivers.
void	SetLocale (FString Locale)
	Set the active locale for subsequent bank loads.
void	SetGlobalParameterByName (FName Name, float32 Value)
	Set a global parameter from the System.
UFMODAudioComponent	PlayEventAttached (UFMODEvent Event, USceneComponent AttachToComponent, FName AttachPointName, FVector Location, EAttachLocation LocationType, bool bStopWhenAttachedToDestroyed, bool bAutoPlay, bool bAutoDestroy)
	Plays an event attached to and following the specified component.
FFMODEventInstance	PlayEventAtLocation (UObject WorldContextObject, UFMODEvent Event, FTransform Location, bool bAutoPlay)
	Plays an event at the given location. This returns an FMOD Event Instance. The sound does not travel with any actor.
TArray< FFMODEventInstance >	FindEventInstances (UObject WorldContextObject, UFMODEvent Event)
	Return a list of all event instances that are playing for this event. Be careful using this function because it is possible to find and alter any playing sound, even ones owned by other audio components.
void	MixerResume ()
	Resume the FMOD mixer. Used when resuming the application.
bool	IsBankLoaded (UFMODBank Bank)
	Returns true if a bank is loaded.
UFMODAsset	FindAssetByName (FString Name)
	Find an asset by name.
UFMODEvent	FindEventByName (FString Name)
	Find an event by name.
void	LoadBank (UFMODBank Bank, bool bBlocking, bool bLoadSampleData)
	Loads a bank.
void	LoadEventSampleData (UObject WorldContextObject, UFMODEvent Event)
	Load event sample data. This can be done ahead of time to avoid loading stalls.
void	GetGlobalParameterValueByName (FName Name, float32 &UserValue, float32 &FinalValue)
	Get a global parameter from the System.
TArray< FString >	GetOutputDrivers ()
	List all output device names.
Audio\|FMOD\|Bus
void	BusStopAllEvents (UFMODBus Bus, EFMOD_STUDIO_STOP_MODE stopMode)
	Stops all EventInstances routed into the bus.
void	BusSetPaused (UFMODBus Bus, bool bPaused)
	Pause/Unpause all events going through this bus.
void	BusSetVolume (UFMODBus Bus, float32 Volume)
	Set volume on a bus.
void	BusSetMute (UFMODBus Bus, bool bMute)
	Mute/Unmute this bus.
Audio\|FMOD\|EventInstance
void	EventInstanceRelease (FFMODEventInstance EventInstance)
	Release an FMOD Event Instance.
void	EventInstanceSetVolume (FFMODEventInstance EventInstance, float32 Volume)
	Set volume on an FMOD Event Instance.
void	EventInstanceSetTransform (FFMODEventInstance EventInstance, FTransform Location)
	Set 3D attributes on a FMOD Event Instance.
void	EventInstanceSetProperty (FFMODEventInstance EventInstance, EFMODEventProperty Property, float32 Value)
	Set an FMOD event property on an FMOD Event Instance.
void	EventInstanceSetPitch (FFMODEventInstance EventInstance, float32 Pitch)
	Set pitch on an FMOD Event Instance.
void	EventInstanceSetPaused (FFMODEventInstance EventInstance, bool Paused)
	Pause/Unpause an FMOD Event Instance.
void	EventInstanceSetParameter (FFMODEventInstance EventInstance, FName Name, float32 Value)
	Set a parameter on an FMOD Event Instance.
void	EventInstanceStop (FFMODEventInstance EventInstance, bool Release=false)
	Stop an FMOD Event Instance.
void	EventInstancePlay (FFMODEventInstance EventInstance)
	Plays an FMOD Event Instance.
void	EventInstanceKeyOff (FFMODEventInstance EventInstance)
	Allow an FMOD Event Instance to continue past a sustain point.
bool	EventInstanceIsValid (FFMODEventInstance EventInstance)
	Returns whether this FMOD Event Instance is valid. The instance will be invalidated when the sound stops.
void	EventInstanceGetParameterValue (FFMODEventInstance EventInstance, FName Name, float32 &UserValue, float32 &FinalValue)
	Get a parameter on an FMOD Event Instance.
float32	EventInstanceGetParameter (FFMODEventInstance EventInstance, FName Name)
	Will be deprecated in FMOD 2.01, use EventInstanceGetParameterValue(FFMODEventInstance, FName, float, float) instead. Get a parameter on an FMOD Event Instance.
Audio\|FMOD\|VCA
void	VCASetVolume (UFMODVCA Vca, float32 Volume)
	Set volume on a VCA.

Variables
Variables
const TArray< FString >	OutputDrivers

Function Documentation

◆ BusSetMute()

void BusSetMute	(	UFMODBus	Bus,
		bool	bMute )

Mute/Unmute this bus.

Parameters

Bus	bus to use
bMute	mute

◆ BusSetPaused()

void BusSetPaused	(	UFMODBus	Bus,
		bool	bPaused )

Pause/Unpause all events going through this bus.

Parameters

Bus	bus to use
bPaused	paused

◆ BusSetVolume()

void BusSetVolume	(	UFMODBus	Bus,
		float32	Volume )

Set volume on a bus.

Parameters

Bus	bus to use
Volume	volume

◆ BusStopAllEvents()

void BusStopAllEvents	(	UFMODBus	Bus,
		EFMOD_STUDIO_STOP_MODE	stopMode )

Stops all EventInstances routed into the bus.

Parameters

Bus	bus to use
stopMode	desired stop mode

◆ EventInstanceGetParameter()

float32 EventInstanceGetParameter	(	FFMODEventInstance	EventInstance,
		FName	Name )

Will be deprecated in FMOD 2.01, use EventInstanceGetParameterValue(FFMODEventInstance, FName, float, float) instead. Get a parameter on an FMOD Event Instance.

Parameters

EventInstance	Event instance
Name	Name of parameter

◆ EventInstanceGetParameterValue()

void EventInstanceGetParameterValue	(	FFMODEventInstance	EventInstance,
		FName	Name,
		float32 &	UserValue,
		float32 &	FinalValue )

Get a parameter on an FMOD Event Instance.

Parameters

EventInstance	Event instance
Name	Name of parameter
UserValue	Parameter value as set from the public API.
FinalValue	Final combined parameter value.

◆ EventInstanceIsValid()

bool EventInstanceIsValid ( FFMODEventInstance EventInstance )

Returns whether this FMOD Event Instance is valid. The instance will be invalidated when the sound stops.

Parameters

EventInstance Event instance

◆ EventInstanceKeyOff()

void EventInstanceKeyOff ( FFMODEventInstance EventInstance )

Allow an FMOD Event Instance to continue past a sustain point.

Parameters

EventInstance Event instance

◆ EventInstancePlay()

void EventInstancePlay ( FFMODEventInstance EventInstance )

Plays an FMOD Event Instance.

Parameters

EventInstance Event instance

◆ EventInstanceRelease()

void EventInstanceRelease ( FFMODEventInstance EventInstance )

Release an FMOD Event Instance.

Parameters

EventInstance Event instance

◆ EventInstanceSetParameter()

void EventInstanceSetParameter	(	FFMODEventInstance	EventInstance,
		FName	Name,
		float32	Value )

Set a parameter on an FMOD Event Instance.

Parameters

EventInstance	Event instance
Name	Name of parameter
Value	Value of parameter

◆ EventInstanceSetPaused()

void EventInstanceSetPaused	(	FFMODEventInstance	EventInstance,
		bool	Paused )

Pause/Unpause an FMOD Event Instance.

Parameters

EventInstance	Event instance
Paused	Whether to pause or unpause

◆ EventInstanceSetPitch()

void EventInstanceSetPitch	(	FFMODEventInstance	EventInstance,
		float32	Pitch )

Set pitch on an FMOD Event Instance.

Parameters

EventInstance Event instance

◆ EventInstanceSetProperty()

void EventInstanceSetProperty	(	FFMODEventInstance	EventInstance,
		EFMODEventProperty	Property,
		float32	Value )

Set an FMOD event property on an FMOD Event Instance.

Parameters

EventInstance	Event instance
Property	Property to set
Value	Value to set

◆ EventInstanceSetTransform()

void EventInstanceSetTransform	(	FFMODEventInstance	EventInstance,
		FTransform	Location )

Set 3D attributes on a FMOD Event Instance.

Parameters

EventInstance	Event instance
Location	Location to place event

◆ EventInstanceSetVolume()

void EventInstanceSetVolume	(	FFMODEventInstance	EventInstance,
		float32	Volume )

Set volume on an FMOD Event Instance.

Parameters

EventInstance Event instance

◆ EventInstanceStop()

void EventInstanceStop	(	FFMODEventInstance	EventInstance,
		bool	Release = false )

Stop an FMOD Event Instance.

Parameters

EventInstance	Event instance
Release	Whether to release the Event Instance

◆ FindAssetByName()

UFMODAsset FindAssetByName ( FString Name )

Find an asset by name.

◆ FindEventByName()

UFMODEvent FindEventByName ( FString Name )

Find an event by name.

◆ FindEventInstances()

TArray< FFMODEventInstance > FindEventInstances	(	UObject	WorldContextObject,
		UFMODEvent	Event )

Return a list of all event instances that are playing for this event. Be careful using this function because it is possible to find and alter any playing sound, even ones owned by other audio components.

Parameters

Event event to find instances from.

◆ GetGlobalParameterByName()

float32 GetGlobalParameterByName ( FName Name )

Will be deprecated in FMOD 2.01, use GetGlobalParameterValueByName(FName, float, float) instead. Get a global parameter from the System.

Parameters

Name	Name of parameter

◆ GetGlobalParameterValueByName()

void GetGlobalParameterValueByName	(	FName	Name,
		float32 &	UserValue,
		float32 &	FinalValue )

Get a global parameter from the System.

Parameters

Name	Name of parameter
UserValue	Parameter value as set from the public API.
FinalValue	Final combined parameter value.

◆ GetOutputDrivers()

TArray< FString > GetOutputDrivers ( )

List all output device names.

◆ IsBankLoaded()

bool IsBankLoaded ( UFMODBank Bank )

Returns true if a bank is loaded.

Parameters

Bank	bank to query

◆ LoadBank()

void LoadBank	(	UFMODBank	Bank,
		bool	bBlocking,
		bool	bLoadSampleData )

Loads a bank.

Parameters

Bank	bank to load
bBlocking	determines whether the bank will load synchronously
bLoadSampleData	determines whether sample data will be preloaded immediately

◆ LoadBankSampleData()

void LoadBankSampleData ( UFMODBank Bank )

Load bank sample data.

Parameters

Bank	bank to load sample data from

◆ LoadEventSampleData()

void LoadEventSampleData	(	UObject	WorldContextObject,
		UFMODEvent	Event )

Load event sample data. This can be done ahead of time to avoid loading stalls.

Parameters

Event event to load sample data from.

◆ MixerResume()

void MixerResume ( )

Resume the FMOD mixer. Used when resuming the application.

◆ MixerSuspend()

void MixerSuspend ( )

Suspend the FMOD mixer. Used when suspending the application.

◆ PlayEvent2D()

FFMODEventInstance PlayEvent2D	(	UObject	WorldContextObject,
		UFMODEvent	Event,
		bool	bAutoPlay )

Plays an event. This returns an FMOD Event Instance. The sound does not travel with any actor.

Parameters

Event	event to play
bAutoPlay	Start the event automatically.

◆ PlayEventAtLocation()

FFMODEventInstance PlayEventAtLocation	(	UObject	WorldContextObject,
		UFMODEvent	Event,
		FTransform	Location,
		bool	bAutoPlay )

Plays an event at the given location. This returns an FMOD Event Instance. The sound does not travel with any actor.

Parameters

Event	event to play
Location	World position to play event at
bAutoPlay	Start the event automatically.

◆ PlayEventAttached()

UFMODAudioComponent PlayEventAttached	(	UFMODEvent	Event,
		USceneComponent	AttachToComponent,
		FName	AttachPointName,
		FVector	Location,
		EAttachLocation	LocationType,
		bool	bStopWhenAttachedToDestroyed,
		bool	bAutoPlay,
		bool	bAutoDestroy )

Plays an event attached to and following the specified component.

Parameters

Event	event to play
AttachPointName	Optional named point within the AttachComponent to play the sound at
Location	Depending on the value of Location Type this is either a relative offset from the attach component/point or an absolute world position that will be translated to a relative offset
LocationType	Specifies whether Location is a relative offset or an absolute world position
bStopWhenAttachedToDestroyed	Specifies whether the sound should stop playing when the owner of the attach to component is destroyed.
bAutoPlay	Start the event automatically.
bAutoDestroy	Automatically destroy the audio component when the sound is stopped.

◆ SetGlobalParameterByName()

void SetGlobalParameterByName	(	FName	Name,
		float32	Value )

Set a global parameter from the System.

Parameters

Name	Name of parameter
Value	Value of parameter

◆ SetLocale()

void SetLocale ( FString Locale )

Set the active locale for subsequent bank loads.

◆ SetOutputDriverByIndex()

void SetOutputDriverByIndex ( int NewDriverIndex )

Set current output device by its index from GetOutputDrivers.

◆ SetOutputDriverByName()

void SetOutputDriverByName ( FString NewDriverName )

Set current output device by name or part of the name.

◆ UnloadBank()

void UnloadBank ( UFMODBank Bank )

Unloads a bank.

Parameters

Bank	bank to unload

◆ UnloadBankSampleData()

void UnloadBankSampleData ( UFMODBank Bank )

Unload bank sample data.

Parameters

Bank	bank to unload sample data from

◆ UnloadEventSampleData()

void UnloadEventSampleData	(	UObject	WorldContextObject,
		UFMODEvent	Event )

Unload event sample data.

Parameters

Event event to load sample data from.

◆ VCASetVolume()

void VCASetVolume	(	UFMODVCA	Vca,
		float32	Volume )

Set volume on a VCA.

Parameters

Vca	VCA to use
Volume	volume

Variable Documentation

◆ OutputDrivers

const TArray<FString> OutputDrivers

Functions

Variables

Function Documentation

◆ BusSetMute()

◆ BusSetPaused()

◆ BusSetVolume()

◆ BusStopAllEvents()

◆ EventInstanceGetParameter()

◆ EventInstanceGetParameterValue()

◆ EventInstanceIsValid()

◆ EventInstanceKeyOff()

◆ EventInstancePlay()

◆ EventInstanceRelease()

◆ EventInstanceSetParameter()

◆ EventInstanceSetPaused()

◆ EventInstanceSetPitch()

◆ EventInstanceSetProperty()

◆ EventInstanceSetTransform()

◆ EventInstanceSetVolume()

◆ EventInstanceStop()

◆ FindAssetByName()

◆ FindEventByName()

◆ FindEventInstances()

◆ GetGlobalParameterByName()

◆ GetGlobalParameterValueByName()

◆ GetOutputDrivers()

◆ IsBankLoaded()

◆ LoadBank()

◆ LoadBankSampleData()

◆ LoadEventSampleData()

◆ MixerResume()

◆ MixerSuspend()

◆ PlayEvent2D()

◆ PlayEventAtLocation()

◆ PlayEventAttached()

◆ SetGlobalParameterByName()

◆ SetLocale()

◆ SetOutputDriverByIndex()

◆ SetOutputDriverByName()

◆ UnloadBank()

◆ UnloadBankSampleData()

◆ UnloadEventSampleData()

◆ VCASetVolume()

Variable Documentation

◆ OutputDrivers