Static Public Member Functions
Static Functions
static UClass	StaticClass ()
Static Public Member Functions inherited from UObject
static UClass	StaticClass ()

Public Attributes
Advanced
FString	AmbientLPFParameter
	Name of the parameter used in Studio to control Ambient LPF effects.
FString	AmbientVolumeParameter
	Name of the parameter used in Studio to control Ambient volume.
FString	ForcePlatformName
	Force platform directory name, or leave empty for automatic (Desktop/Mobile/PS4/XBoxOne).
FString	StudioBankKey
	Specify the key for loading sounds from encrypted banks.
int	EditorLiveUpdatePort
	Live update port to use while in editor for auditioning. Requires Restart.
FString	SkipLoadBankName
	Skip bank files of the given name. Can be used to load all banks except for a certain set, such as localization banks.
bool	bFMODAudioLinkEnabled
	Enables/Disables the FMODAudioLink modules.
EFMODLogging	LoggingLevel
	Specify the logging level to use in a debug/development build.
FString	WavWriterPath
	Force wav writer output, for debugging only. Setting this will prevent normal sound output!
TSoftClassPtr< UObject >	CallbackHandler
	Callback handler implementing IFMODCallbackHandler for calling into system at specific points in the integration's lifecycle.
int	LiveUpdatePort
	Live update port to use, or 0 for default.
FString	MasterBankName
	Name of master bank. The default in Studio is "Master Bank".
int	ReloadBanksDelay
	Delay in seconds before automatically reloading modified banks from disk. This can be extended if building banks takes a long time and UE4 tries to reload banks before building is completed. Set to 0 to disable automatic bank reloading.
FString	ContentBrowserPrefix
	Directory for content to appear in content window. Be careful changing this!
TArray< FString >	PluginFiles
	Extra plugin files to load. The plugin files should sit alongside the FMOD dynamic libraries in the ThirdParty directory.
bool	bEnableMemoryTracking
	Enable memory tracking.
bool	bEnableAPIErrorLogging
	Will log internal API errors when enabled.
FString	OcclusionParameter
	Name of the parameter used in Studio to control Occlusion effects.
Basic
bool	bEnableLiveUpdate
	Enable live update in non-final builds.
bool	bLoadAllBanks
	Whether to load all banks at startup.
EFMODOutput	OutputType
	Built-in output types that can be used to run the mixer.
FDirectoryPath	BankOutputDirectory
	Path to find your studio bank output directory, relative to Content directory.
EFMODSpeakerMode	OutputFormat
	Project Output Format, should match the mode set up for the Studio project.
bool	bEnableEditorLiveUpdate
	Enable live update in Editor for Auditioning. Requires Restart.
bool	bLoadAllSampleData
	Whether to load all bank sample data into memory at startup.
InitSettings
int	TotalChannelCount
	Total number of voices available that can be either real or virtual.
int	StudioUpdatePeriod
	Studio update period in milliseconds, or 0 for default (which means 20ms).
int	FileBufferSize
	File buffer size in bytes (2048 by default).
int	DSPBufferCount
	DSP mixer buffer count (eg. 2, 4) or 0 for system default. When changing the Buffer Count, Buffer Length also needs to be set.
int	DSPBufferLength
	DSP mixer buffer length (eg. 512, 1024) or 0 for system default. When changing the Buffer Length, Buffer Count also needs to be set.
FString	InitialOutputDriverName
	Output device to choose at system start up, or empty for default.
int	RealChannelCount
	Number of actual software voices that can be used at once.
bool	bMatchHardwareSampleRate
	Whether to match hardware sample rate where reasonable (44.1kHz to 48kHz).
int	SampleRate
	Sample rate to use, or 0 to match system rate. eg. 0, 22050, 24000, 32000, 44100, 48000.
float32	Vol0VirtualLevel
	The signal level at which channels are virtualized. Virtual channels are processed, but do not produce any output.
int	MemoryPoolSize
	Use specified memory pool size for platform, units in bytes. Disabled by default. FMOD may become unstable if the limit is exceeded!
bool	bLockAllBuses
	Lock all mixer buses at startup, making sure they are created up front.
TMap< EFMODCodec, int >	Codecs
	Codecs.
Localization
TArray< FFMODProjectLocale >	Locales
	Locales for localized banks. These should match the project locales configured in the FMOD Studio project.
PlatformSettings
TMap< EFMODPlatforms, FFMODPlatformSettings >	Platforms
	Used to specify platform specific settings.
Public Attributes inherited from UObject
const UClass	Class
const UObject	Outer
const UPackage	Outermost
const UPackage	Package
const UWorld	World
const FName	Name
const bool	IsRooted

Additional Inherited Members
Public Member Functions inherited from UObject
bool	MarkPackageDirty () const
void	RemoveFromRoot ()
bool	GetIsRooted () const
bool	IsTransient () const
bool	Modify (bool bAlwaysMarkDirty=true)
void	SetTransactional (bool bTransactional)
bool	IsSupportedForNetworking () const
UClass	GetClass () const
UObject	GetOuter () const
UObject	GetTypedOuter (TSubclassOf< UObject > Target) const
	Traverses the outer chain searching for the next object of a certain type.
UPackage	GetOutermost () const
UPackage	GetPackage () const
void	AddToRoot ()
UWorld	GetWorld () const
FName	GetName () const
FString	GetFullName (const UObject StopOuter=nullptr) const
FString	GetPathName (const UObject StopOuter=nullptr) const
bool	IsA (const UClass Class) const
	Returns true if this object is of the specified type, or a child of that type.
void	SaveConfig ()
void	LoadConfig ()
void	ReloadConfig ()
void	CopyScriptPropertiesFrom (const UObject OtherObject)
void	opCast (?&Address) const
FString	ToString () const

Member Function Documentation

◆ StaticClass()

UClass StaticClass ( )

static

Member Data Documentation

◆ AmbientLPFParameter

FString AmbientLPFParameter

Name of the parameter used in Studio to control Ambient LPF effects.

◆ AmbientVolumeParameter

FString AmbientVolumeParameter

Name of the parameter used in Studio to control Ambient volume.

◆ BankOutputDirectory

FDirectoryPath BankOutputDirectory

Path to find your studio bank output directory, relative to Content directory.

◆ bEnableAPIErrorLogging

bool bEnableAPIErrorLogging

Will log internal API errors when enabled.

◆ bEnableEditorLiveUpdate

bool bEnableEditorLiveUpdate

Enable live update in Editor for Auditioning. Requires Restart.

◆ bEnableLiveUpdate

bool bEnableLiveUpdate

Enable live update in non-final builds.

◆ bEnableMemoryTracking

bool bEnableMemoryTracking

Enable memory tracking.

◆ bFMODAudioLinkEnabled

bool bFMODAudioLinkEnabled

Enables/Disables the FMODAudioLink modules.

◆ bLoadAllBanks

bool bLoadAllBanks

Whether to load all banks at startup.

◆ bLoadAllSampleData

bool bLoadAllSampleData

Whether to load all bank sample data into memory at startup.

◆ bLockAllBuses

bool bLockAllBuses

Lock all mixer buses at startup, making sure they are created up front.

◆ bMatchHardwareSampleRate

bool bMatchHardwareSampleRate

Whether to match hardware sample rate where reasonable (44.1kHz to 48kHz).

◆ CallbackHandler

TSoftClassPtr<UObject> CallbackHandler

Callback handler implementing IFMODCallbackHandler for calling into system at specific points in the integration's lifecycle.

◆ Codecs

TMap<EFMODCodec,int> Codecs

Codecs.

◆ ContentBrowserPrefix

FString ContentBrowserPrefix

Directory for content to appear in content window. Be careful changing this!

◆ DSPBufferCount

int DSPBufferCount

DSP mixer buffer count (eg. 2, 4) or 0 for system default. When changing the Buffer Count, Buffer Length also needs to be set.

◆ DSPBufferLength

int DSPBufferLength

DSP mixer buffer length (eg. 512, 1024) or 0 for system default. When changing the Buffer Length, Buffer Count also needs to be set.

◆ EditorLiveUpdatePort

int EditorLiveUpdatePort

Live update port to use while in editor for auditioning. Requires Restart.

◆ FileBufferSize

int FileBufferSize

File buffer size in bytes (2048 by default).

◆ ForcePlatformName

FString ForcePlatformName

Force platform directory name, or leave empty for automatic (Desktop/Mobile/PS4/XBoxOne).

◆ InitialOutputDriverName

FString InitialOutputDriverName

Output device to choose at system start up, or empty for default.

◆ LiveUpdatePort

int LiveUpdatePort

Live update port to use, or 0 for default.

◆ Locales

TArray<FFMODProjectLocale> Locales

Locales for localized banks. These should match the project locales configured in the FMOD Studio project.

◆ LoggingLevel

EFMODLogging LoggingLevel

Specify the logging level to use in a debug/development build.

◆ MasterBankName

FString MasterBankName

Name of master bank. The default in Studio is "Master Bank".

◆ MemoryPoolSize

int MemoryPoolSize

Use specified memory pool size for platform, units in bytes. Disabled by default. FMOD may become unstable if the limit is exceeded!

◆ OcclusionParameter

FString OcclusionParameter

Name of the parameter used in Studio to control Occlusion effects.

◆ OutputFormat

EFMODSpeakerMode OutputFormat

Project Output Format, should match the mode set up for the Studio project.

◆ OutputType

EFMODOutput OutputType

Built-in output types that can be used to run the mixer.

◆ Platforms

TMap<EFMODPlatforms,FFMODPlatformSettings> Platforms

Used to specify platform specific settings.

◆ PluginFiles

TArray<FString> PluginFiles

Extra plugin files to load. The plugin files should sit alongside the FMOD dynamic libraries in the ThirdParty directory.

◆ RealChannelCount

int RealChannelCount

Number of actual software voices that can be used at once.

◆ ReloadBanksDelay

int ReloadBanksDelay

Delay in seconds before automatically reloading modified banks from disk. This can be extended if building banks takes a long time and UE4 tries to reload banks before building is completed. Set to 0 to disable automatic bank reloading.

◆ SampleRate

int SampleRate

Sample rate to use, or 0 to match system rate. eg. 0, 22050, 24000, 32000, 44100, 48000.

◆ SkipLoadBankName

FString SkipLoadBankName

Skip bank files of the given name. Can be used to load all banks except for a certain set, such as localization banks.

◆ StudioBankKey

FString StudioBankKey

Specify the key for loading sounds from encrypted banks.

◆ StudioUpdatePeriod

int StudioUpdatePeriod

Studio update period in milliseconds, or 0 for default (which means 20ms).

◆ TotalChannelCount

int TotalChannelCount

Total number of voices available that can be either real or virtual.

◆ Vol0VirtualLevel

float32 Vol0VirtualLevel

The signal level at which channels are virtualized. Virtual channels are processed, but do not produce any output.

◆ WavWriterPath

FString WavWriterPath

Force wav writer output, for debugging only. Setting this will prevent normal sound output!

Static Public Member Functions

Public Attributes

Additional Inherited Members