lucastucious/Jam-Teacher
1
1
Fork 0
Code Issues Pull requests Releases Wiki Activity

Add Base project + FMOD

Browse source
This commit is contained in:
Lucas 2020-08-01 13:48:17 +02:00
parent b6cc0068ef
commit 9a433409f7
201 changed files with 20505 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

0
Config/DefaultEditor.ini Normal file
View file

16
Config/DefaultEngine.ini Normal file
View file

@ -0,0 +1,16 @@
[/Script/HardwareTargeting.HardwareTargetingSettings]
TargetedHardwareClass=Desktop
AppliedTargetedHardwareClass=Desktop
DefaultGraphicsPerformance=Maximum
AppliedDefaultGraphicsPerformance=Maximum
[/Script/EngineSettings.GameMapsSettings]
EditorStartupMap=/Game/StarterContent/Maps/Minimal_Default
GameDefaultMap=/Game/StarterContent/Maps/Minimal_Default
[/Script/Engine.Engine]
+ActiveGameNameRedirects=(OldGameName="TP_BlankBP",NewGameName="/Script/JamTeacher")
+ActiveGameNameRedirects=(OldGameName="/Script/TP_BlankBP",NewGameName="/Script/JamTeacher")

73
Config/DefaultGame.ini Normal file
View file

@ -0,0 +1,73 @@
[/Script/EngineSettings.GeneralProjectSettings]
ProjectID=2E83EBB84D5FB79959796494171847D7
[StartupActions]
bAddPacks=True
InsertPack=(PackSource="StarterContent.upack",PackName="StarterContent")
[/Script/UnrealEd.ProjectPackagingSettings]
Build=IfProjectHasCode
BuildConfiguration=PPBC_Development
BuildTarget=
StagingDirectory=(Path="")
FullRebuild=False
ForDistribution=False
IncludeDebugFiles=False
BlueprintNativizationMethod=Disabled
bIncludeNativizedAssetsInProjectGeneration=False
bExcludeMonolithicEngineHeadersInNativizedCode=False
UsePakFile=True
bUseIoStore=False
bGenerateChunks=False
bGenerateNoChunks=False
bChunkHardReferencesOnly=False
bForceOneChunkPerFile=False
MaxChunkSize=0
bBuildHttpChunkInstallData=False
HttpChunkInstallDataDirectory=(Path="")
PakFileCompressionFormats=
PakFileAdditionalCompressionOptions=
HttpChunkInstallDataVersion=
IncludePrerequisites=True
IncludeAppLocalPrerequisites=False
bShareMaterialShaderCode=True
bSharedMaterialNativeLibraries=True
ApplocalPrerequisitesDirectory=(Path="")
IncludeCrashReporter=False
InternationalizationPreset=English
-CulturesToStage=en
+CulturesToStage=en
LocalizationTargetCatchAllChunkId=0
bCookAll=False
bCookMapsOnly=False
bCompressed=False
bSkipEditorContent=False
bSkipMovies=False
-IniKeyBlacklist=KeyStorePassword
-IniKeyBlacklist=KeyPassword
-IniKeyBlacklist=rsa.privateexp
-IniKeyBlacklist=rsa.modulus
-IniKeyBlacklist=rsa.publicexp
-IniKeyBlacklist=aes.key
-IniKeyBlacklist=SigningPublicExponent
-IniKeyBlacklist=SigningModulus
-IniKeyBlacklist=SigningPrivateExponent
-IniKeyBlacklist=EncryptionKey
-IniKeyBlacklist=IniKeyBlacklist
-IniKeyBlacklist=IniSectionBlacklist
+IniKeyBlacklist=KeyStorePassword
+IniKeyBlacklist=KeyPassword
+IniKeyBlacklist=rsa.privateexp
+IniKeyBlacklist=rsa.modulus
+IniKeyBlacklist=rsa.publicexp
+IniKeyBlacklist=aes.key
+IniKeyBlacklist=SigningPublicExponent
+IniKeyBlacklist=SigningModulus
+IniKeyBlacklist=SigningPrivateExponent
+IniKeyBlacklist=EncryptionKey
+IniKeyBlacklist=IniKeyBlacklist
+IniKeyBlacklist=IniSectionBlacklist
+DirectoriesToAlwaysStageAsNonUFS=(Path="FMOD")

22
JamTeacher.uproject Normal file
View file

@ -0,0 +1,22 @@
{
"FileVersion": 3,
"EngineAssociation": "4.25",
"Category": "",
"Description": "",
"Modules": [
{
"Name": "JamTeacher",
"Type": "Runtime",
"LoadingPhase": "Default",
"AdditionalDependencies": [
"Engine"
]
}
],
"Plugins": [
{
"Name": "FMODStudio",
"Enabled": true
}
]
}

BIN
Plugins/FMODStudio/Content/AnimNotify_FMODPlayEvent.uasset Normal file
View file

Binary file not shown.

50
Plugins/FMODStudio/Docs/api-reference-afmodambientsound.html Normal file
View file

@ -0,0 +1,50 @@
<html>
<head>
<title>API Reference | AFMODAmbientSound</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-fmodutils.html">FMODUtils</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ffmodlistener.html">FFMODListener</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li><li><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li><li><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li><li><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li><li><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li><li><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li><li><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li><li><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li><li><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li><li><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li></ul></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>5. API Reference | AFMODAmbientSound</h1>
<div class="admonition warning">
<p class="admonition-title">This documentation is preliminary and is subject to change.</p>
</div>
<p>This class inherits from <a href="https://api.unrealengine.com/INT/API/Runtime/Engine/GameFramework/AActor/index.html">AActor</a></p>
<p><strong>Properties:</strong></p>
<ul>
<li><a class="apilink" href="api-reference-afmodambientsound.html#afmodambientsound_audiocomponent" title="FMODAudioComponent used to play the ambient Event.">AFMODAmbientSound::AudioComponent</a> FMODAudioComponent used to play the ambient Event.</li>
</ul>
<h2 api="struct" id="afmodambientsound_audiocomponent"><a href="#afmodambientsound_audiocomponent">AFMODAmbientSound::AudioComponent</a></h2>
<p>FMODAudioComponent used to play the ambient Event.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="n">UFMODAudioComponent</span> <span class="o">*</span><span class="n">AudioComponent</span><span class="p">;</span>
</pre></div>
<p><strong>See Also:</strong> <a class="apilink" href="api-reference-ufmodaudiocomponent.html" title="">UFMODAudioComponent</a></p></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

55
Plugins/FMODStudio/Docs/api-reference-ffmodassettable.html Normal file
View file

@ -0,0 +1,55 @@
<html>
<head>
<title>API Reference | FFmodAssetTable</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-fmodutils.html">FMODUtils</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ffmodlistener.html">FFMODListener</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li><li><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li><li><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li><li><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li><li><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li><li><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li><li><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li><li><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li><li><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li></ul></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>5. API Reference | FFmodAssetTable</h1>
<div class="admonition warning">
<p class="admonition-title">This documentation is preliminary and is subject to change.</p>
</div>
<p><strong>Properties:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ffmodassettable_studiosystem" title="">FFMODAssetTable::StudioSystem</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodassettable_guidmap" title="">FFMODAssetTable::GuidMap</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodassettable_namemap" title="">FFMODAssetTable::NameMap</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodassettable_fullnamelookup" title="">FFMODAssetTable::FullNameLookup</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodassettable_masterbankpath" title="">FFMODAssetTable::MasterBankPath</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodassettable_masterstringsbankpath" title="">FFMODAssetTable::MasterStringsBankPath</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodassettable_masterassetsbankpath" title="">FFMODAssetTable::MasterAssetsBankPath</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodassettable_bankpathlookup" title="">FFMODAssetTable::BankPathLookup</span class="dead-link"> </li>
</ul>
<p><strong>Methods:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ffmodassettable_create" title="">FFMODAssetTable::Create</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodassettable_destroy" title="">FFMODAssetTable::Destroy</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodassettable_refresh" title="">FFMODAssetTable::Refresh</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodassettable_findbyname" title="">FFMODAssetTable::FindByName</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodassettable_getbankpath" title="">FFMODAssetTable::GetBankPath</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodassettable_getmasterbankpath" title="">FFMODAssetTable::GetMasterBankPath</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodassettable_getmasterstringsbankpath" title="">FFMODAssetTable::GetMasterStringsBankPath</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodassettable_getmasterassetsbankpath" title="">FFMODAssetTable::GetMasterAssetsBankPath</span class="dead-link"> </li>
</ul></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

56
Plugins/FMODStudio/Docs/api-reference-ffmodbankupdatenotifier.html Normal file
View file

@ -0,0 +1,56 @@
<html>
<head>
<title>API Reference | FFMODBankUpdateNotifier</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-fmodutils.html">FMODUtils</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ffmodlistener.html">FFMODListener</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li><li><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li><li><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li><li><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li><li><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li><li><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li><li><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li><li><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li><li><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li></ul></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>5. API Reference | FFMODBankUpdateNotifier</h1>
<div class="admonition warning">
<p class="admonition-title">This documentation is preliminary and is subject to change.</p>
</div>
<p><strong>Properties:</strong></p>
<p><strong><em>Public:</em></strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ffmodbankupdatenotifier_banksupdateevent" title="">FFMODBankUpdateNotifier::BanksUpdateEvent</span class="dead-link"> </li>
</ul>
<p><strong><em>Private:</em></strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ffmodbankupdatenotifier_bupdateenabled" title="">FFMODBankUpdateNotifier::bUpdateEnabled</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodbankupdatenotifier_filepath" title="">FFMODBankUpdateNotifier::FilePath</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodbankupdatenotifier_nextrefreshtime" title="">FFMODBankUpdateNotifier::NextRefreshTime</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodbankupdatenotifier_filetime" title="">FFMODBankUpdateNotifier::FileTime</span class="dead-link"> </li>
</ul>
<p><strong>Methods:</strong></p>
<p><strong><em>Public:</em></strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ffmodbankupdatenotifier_setfilepath" title="">FFMODBankUpdateNotifier::SetFilePath</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodbankupdatenotifier_update" title="">FFMODBankUpdateNotifier::Update</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodbankupdatenotifier_enableupdate" title="">FFMODBankUpdateNotifier::EnableUpdate</span class="dead-link"> </li>
</ul>
<p><strong><em>Private:</em></strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ffmodbankupdatenotifier_refresh" title="">FFMODBankUpdateNotifier::Refresh</span class="dead-link"> </li>
</ul></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

45
Plugins/FMODStudio/Docs/api-reference-ffmodeventcontrolsectiontemplate.html Normal file
View file

@ -0,0 +1,45 @@
<html>
<head>
<title>API Reference | FFMODEventControlSectionTemplate</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-fmodutils.html">FMODUtils</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ffmodlistener.html">FFMODListener</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li><li><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li><li><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li><li><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li><li><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li><li><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li><li><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li><li><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li><li><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li></ul></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>5. API Reference | FFMODEventControlSectionTemplate</h1>
<div class="admonition warning">
<p class="admonition-title">This documentation is preliminary and is subject to change.</p>
</div>
<p>This class inherits from <a href="">FMovieSceneEvalTemplate</a>.</p>
<p><strong>Properties:</strong></p>
<p><strong><em>Public:</em></strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ffmodeventcontrolsectiontemplate_controlkeys" title="">FFMODEventControlSectionTemplate::ControlKeys</span class="dead-link"> </li>
</ul>
<p><strong>Methods:</strong></p>
<p><strong><em>Private:</em></strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ffmodeventcontrolsectiontemplate_getscriptstructimpl" title="">FFMODEventControlSectionTemplate::GetScriptStructImpl</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodeventcontrolsectiontemplate_evaluate" title="">FFMODEventControlSectionTemplate::Evaluate</span class="dead-link"> </li>
</ul></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

40
Plugins/FMODStudio/Docs/api-reference-ffmodeventparametersectiontemplate.html Normal file
View file

@ -0,0 +1,40 @@
<html>
<head>
<title>API Reference | FFMODEventParameterSectionTemplate</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-fmodutils.html">FMODUtils</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ffmodlistener.html">FFMODListener</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li><li><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li><li><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li><li><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li><li><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li><li><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li><li><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li><li><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li><li><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li></ul></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>5. API Reference | FFMODEventParameterSectionTemplate</h1>
<div class="admonition warning">
<p class="admonition-title">This documentation is preliminary and is subject to change.</p>
</div>
<p>This class inherits from <a href="">FMovieSceneParameterSectionTemplate</a>.</p>
<p><strong>Methods:</strong></p>
<p><strong><em>Private:</em></strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ffmodeventparametersectiontemplate_getscriptstructimpl" title="">FFMODEventParameterSectionTemplate::GetScriptStructImpl</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodeventparametersectiontemplate_evaluate" title="">FFMODEventParameterSectionTemplate::Evaluate</span class="dead-link"> </li>
</ul></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

43
Plugins/FMODStudio/Docs/api-reference-ffmodfilecallbacks.html Normal file
View file

@ -0,0 +1,43 @@
<html>
<head>
<title>API Reference | FFMODFileCallbacks</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-fmodutils.html">FMODUtils</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ffmodlistener.html">FFMODListener</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li><li><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li><li><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li><li><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li><li><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li><li><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li><li><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li><li><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li><li><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li></ul></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>5. API Reference | FFMODFileCallbacks</h1>
<div class="admonition warning">
<p class="admonition-title">This documentation is preliminary and is subject to change.</p>
</div>
<p><strong>Defines:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ffmodfilesystem" title="">FFMODFileSystem</span class="dead-link"> </li>
</ul>
<p><strong>Methods:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ffmodfilecallbacks_acquirefmodfilesystem" title="">FFMODFileCallbacks::AcquireFMODFileSystem</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodfilecallbacks_releasefmodfilesystem" title="">FFMODFileCallbacks::ReleaseFMODFileSystem</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodfilecallbacks_attachfmodfilesystem" title="">FFMODFileCallbacks::AttachFMODFileSystem</span class="dead-link"> </li>
</ul></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

62
Plugins/FMODStudio/Docs/api-reference-ffmodlistener.html Normal file
View file

@ -0,0 +1,62 @@
<html>
<head>
<title>API Reference | FFMODListener</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-fmodutils.html">FMODUtils</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ffmodlistener.html">FFMODListener</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li><li><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li><li><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li><li><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li><li><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li><li><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li><li><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li><li><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li><li><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li><li><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li></ul></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>5. API Reference | FFMODListener</h1>
<div class="admonition warning">
<p class="admonition-title">This documentation is preliminary and is subject to change.</p>
</div>
<p><strong>Defines:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ffmodinteriorsettings" title="">FFMODInteriorSettings</span class="dead-link"> </li>
</ul>
<p><strong>Properties:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ffmodlistener_transform" title="">FFMODListener::Transform</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodlistener_velocity" title="">FFMODListener::Velocity</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodlistener_interiorsettings" title="">FFMODListener::InteriorSettings</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodlistener_volume" title="">FFMODListener::Volume</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodlistener_interiorstarttime" title="">FFMODListener::InteriorStartTime</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodlistener_interiorendtime" title="">FFMODListener::InteriorEndTime</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodlistener_exteriorendtime" title="">FFMODListener::ExteriorEndTime</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodlistener_interiorlpfendtime" title="">FFMODListener::InteriorLPFEndTime</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodlistener_exteriorlpfendtime" title="">FFMODListener::ExteriorLPFEndTime</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodlistener_interiorvolumeinterp" title="">FFMODListener::InteriorVolumeInterp</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodlistener_interiorlpfinterp" title="">FFMODListener::InteriorLPFInterp</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodlistener_exteriorvolumeinterp" title="">FFMODListener::ExteriorVolumeInterp</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodlistener_exteriorlpfinterp" title="">FFMODListener::ExteriorLPFInterp</span class="dead-link"> </li>
</ul>
<p><strong>Methods:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ffmodlistener_getup" title="">FFMODListener::GetUp</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodlistener_getfront" title="">FFMODListener::GetFront</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodlistener_getright" title="">FFMODListener::GetRight</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodlistener_interpolate" title="">FFMODListener::Interpolate</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodlistener_updatecurrentinteriorsettings" title="">FFMODListener::UpdateCurrentInteriorSettings</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodlistener_applyinteriorsettings" title="">FFMODListener::ApplyInteriorSettings</span class="dead-link"> </li>
</ul></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

130
Plugins/FMODStudio/Docs/api-reference-ffmodstudiomodule.html Normal file
View file

@ -0,0 +1,130 @@
<html>
<head>
<title>API Reference | FFMODStudioModule</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-fmodutils.html">FMODUtils</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ffmodlistener.html">FFMODListener</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li><li><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li><li><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li><li><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li><li><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li><li><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li><li><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li><li><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li><li><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li><li><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li></ul></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>5. API Reference | FFMODStudioModule</h1>
<div class="admonition warning">
<p class="admonition-title">This documentation is preliminary and is subject to change.</p>
</div>
<p>This class inherits from <a class="apilink" href="api-reference-ifmodstudiomodule.html" title="">IFMODStudioModule</a>.</p>
<p><strong>Defines:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#fmodmemoryalloc" title="">FMODMemoryAlloc</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#fmodmemoryrealloc" title="">FMODMemoryRealloc</span class="dead-link"> </li>
<li>
<p><span class="dead-link" class="apilink" href="#fmodmemoryfree" title="">FMODMemoryFree</span class="dead-link"> </p>
</li>
<li>
<p><span class="dead-link" class="apilink" href="#ffmodsnapshotentry" title="">FFMODSnapshotEntry</span class="dead-link"> </p>
</li>
<li>
<p><span class="dead-link" class="apilink" href="#ffmodstudiosystemclocksink" title="">FFMODStudioSystemClockSink</span class="dead-link"> </p>
</li>
<li>
<p><span class="dead-link" class="apilink" href="#namedbankentry" title="">NamedBankEntry</span class="dead-link"></p>
</li>
</ul>
<p><strong>Properties:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_studiosystem" title="">FFMODStudioModule::StudioSystem</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_auditioninginstance" title="">FFMODStudioModule::AuditioningInstance</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_ontick" title="">FFMODStudioModule::OnTick</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_clocksinks" title="">FFMODStudioModule::ClockSinks</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_tickdelegatehandle" title="">FFMODStudioModule::TickDelegateHandle</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_assettable" title="">FFMODStudioModule::AssetTable</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_bankupdatenotifier" title="">FFMODStudioModule::BankUpdateNotifier</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_failedbankloads" title="">FFMODStudioModule::FailedBankLoads</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_requiredplugins" title="">FFMODStudioModule::RequiredPlugins</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_max_listeners" title="">FFMODStudioModule::MAX_LISTENERS</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_listeners" title="">FFMODStudioModule::Listeners</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_listenercount" title="">FFMODStudioModule::ListenerCount</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_reverbsnapshots" title="">FFMODStudioModule::ReverbSnapshots</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_bsimulating" title="">FFMODStudioModule::bSimulating</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_bisinpie" title="">FFMODStudioModule::bIsInPIE</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_busesound" title="">FFMODStudioModule::bUseSound</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_blistenermoved" title="">FFMODStudioModule::bListenerMoved</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_ballowliveupdate" title="">FFMODStudioModule::bAllowLiveUpdate</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_bbanksloaded" title="">FFMODStudioModule::bBanksLoaded</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_baselibpath" title="">FFMODStudioModule::BaseLibPath</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_corelibhandle" title="">FFMODStudioModule::CoreLibHandle</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_studiolibhandle" title="">FFMODStudioModule::StudioLibHandle</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_bmixerpaused" title="">FFMODStudioModule::bMixerPaused</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_mempool" title="">FFMODStudioModule::MemPool</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_bloadallsampledata" title="">FFMODStudioModule::bLoadAllSampleData</span class="dead-link"> </li>
</ul>
<p><strong>Methods:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_handleapplicationwilldeactivate" title="">FFMODStudioModule::HandleApplicationWillDeactivate</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_handleapplicationhasreactivated" title="">FFMODStudioModule::HandleApplicationHasReactivated</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_startupmodule" title="">FFMODStudioModule::StartupModule</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_postloadcallback" title="">FFMODStudioModule::PostLoadCallback</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_shutdownmodule" title="">FFMODStudioModule::ShutdownModule</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_getdllpath" title="">FFMODStudioModule::GetDllPath</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_loaddll" title="">FFMODStudioModule::LoadDll</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_loadlibraries" title="">FFMODStudioModule::LoadLibraries</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_loadbanks" title="">FFMODStudioModule::LoadBanks</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_handlebanksupdated" title="">FFMODStudioModule::HandleBanksUpdated</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_createstudiosystem" title="">FFMODStudioModule::CreateStudioSystem</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_destroystudiosystem" title="">FFMODStudioModule::DestroyStudioSystem</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_tick" title="">FFMODStudioModule::Tick</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_updateviewportposition" title="">FFMODStudioModule::UpdateViewportPosition</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_getstudiosystem" title="">FFMODStudioModule::GetStudioSystem</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_geteventdescription" title="">FFMODStudioModule::GetEventDescription</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_createauditioninginstance" title="">FFMODStudioModule::CreateAuditioningInstance</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_stopauditioninginstance" title="">FFMODStudioModule::StopAuditioningInstance</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_setlistenerposition" title="">FFMODStudioModule::SetListenerPosition</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_finishsetlistenerposition" title="">FFMODStudioModule::FinishSetListenerPosition</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_getnearestlistener" title="">FFMODStudioModule::GetNearestListener</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_haslistenermoved" title="">FFMODStudioModule::HasListenerMoved</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_refreshsettings" title="">FFMODStudioModule::RefreshSettings</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_setsystempaused" title="">FFMODStudioModule::SetSystemPaused</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_setinpie" title="">FFMODStudioModule::SetInPIE</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_findassetbyname" title="">FFMODStudioModule::FindAssetByName</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_findeventbyname" title="">FFMODStudioModule::FindEventByName</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_getbankpath" title="">FFMODStudioModule::GetBankPath</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_banksreloadeddelegate" title="">FFMODStudioModule::BanksReloadedDelegate</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_banksreloadedevent" title="">FFMODStudioModule::BanksReloadedEvent</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_getfailedbankloads" title="">FFMODStudioModule::GetFailedBankLoads</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_getrequiredplugins" title="">FFMODStudioModule::GetRequiredPlugins</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_addrequiredplugin" title="">FFMODStudioModule::AddRequiredPlugin</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_usesound" title="">FFMODStudioModule::UseSound</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_loadplugin" title="">FFMODStudioModule::LoadPlugin</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_logerror" title="">FFMODStudioModule::LogError</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_arebanksloaded" title="">FFMODStudioModule::AreBanksLoaded</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_resetinterpolation" title="">FFMODStudioModule::ResetInterpolation</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_" title="">FFMODStudioModule::</span class="dead-link"></li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_" title="">FFMODStudioModule::</span class="dead-link"></li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_" title="">FFMODStudioModule::</span class="dead-link"></li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_" title="">FFMODStudioModule::</span class="dead-link"></li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_" title="">FFMODStudioModule::</span class="dead-link"></li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_" title="">FFMODStudioModule::</span class="dead-link"></li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_" title="">FFMODStudioModule::</span class="dead-link"></li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_" title="">FFMODStudioModule::</span class="dead-link"></li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_" title="">FFMODStudioModule::</span class="dead-link"></li>
<li><span class="dead-link" class="apilink" href="#ffmodstudiomodule_" title="">FFMODStudioModule::</span class="dead-link"></li>
</ul></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

38
Plugins/FMODStudio/Docs/api-reference-fmodplatformloaddll_generic.html Normal file
View file

@ -0,0 +1,38 @@
<html>
<head>
<title>API Reference | FMODPlatformLoadDll_Generic</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-fmodutils.html">FMODUtils</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ffmodlistener.html">FFMODListener</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li><li><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li><li><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li><li><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li><li><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li><li><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li><li><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li><li><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li><li><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li></ul></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>5. API Reference | FMODPlatformLoadDll_Generic</h1>
<div class="admonition warning">
<p class="admonition-title">This documentation is preliminary and is subject to change.</p>
</div>
<p><strong>Methods:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#fmodplatformloaddll_generic_fmodplatformloaddll" title="">FMODPlatformLoadDll_Generic::FMODPlatformLoadDll</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#fmodplatformloaddll_generic_fmodplatformsystemstartup" title="">FMODPlatformLoadDll_Generic::FMODPlatformSystemStartup</span class="dead-link"> </li>
</ul></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

52
Plugins/FMODStudio/Docs/api-reference-fmodutils.html Normal file
View file

@ -0,0 +1,52 @@
<html>
<head>
<title>API Reference | FMODUtils</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-fmodutils.html">FMODUtils</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ffmodlistener.html">FFMODListener</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li><li><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li><li><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li><li><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li><li><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li><li><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li><li><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li><li><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li><li><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li><li><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li></ul></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>5. API Reference | FMODUtils</h1>
<div class="admonition warning">
<p class="admonition-title">This documentation is preliminary and is subject to change.</p>
</div>
<p><strong>Defines:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#verifyfmod" title="">verifyfmod</span class="dead-link"></li>
<li><span class="dead-link" class="apilink" href="#fmod_vector_scale_default" title="">FMOD_VECTOR_SCALE_DEFAULT</span class="dead-link"></li>
</ul>
<p><strong>Methods:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#fmodutils_logerror" title="">FMODUtils::LogError</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#fmodutils_assign" title="">FMODUtils::Assign</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#fmodutils_convertworldvector" title="">FMODUtils::ConvertWorldVector</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#fmodutils_convertunitvector" title="">FMODUtils::ConvertUnitVector</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#fmodutils_distancetouescale" title="">FMODUtils::DistanceToUEScale</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#fmodutils_isworldaudible" title="">FMODUtils::IsWorldAudible</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#fmodutils_convertguid" title="">FMODUtils::ConvertGuid</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#fmodutils_getid" title="">FMODUtils::GetID</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#fmodutils_getpath" title="">FMODUtils::GetPath</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#fmodutils_lookupnamefromguid" title="">FMODUtils::LookupNameFromGuid</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#fmodutils_parametertypetostring" title="">FMODUtils::ParameterTypeToString</span class="dead-link"> </li>
</ul></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

65
Plugins/FMODStudio/Docs/api-reference-ifmodstudiomodule.html Normal file
View file

@ -0,0 +1,65 @@
<html>
<head>
<title>API Reference | IFMODStudioModule</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-fmodutils.html">FMODUtils</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ffmodlistener.html">FFMODListener</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li><li><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li><li><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li><li><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li><li><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li><li><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li><li><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li><li><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li><li><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li><li><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li></ul></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>5. API Reference | IFMODStudioModule</h1>
<div class="admonition warning">
<p class="admonition-title">This documentation is preliminary and is subject to change.</p>
</div>
<p>This class inherits from <a href="">IModuleInterface</a>.</p>
<p><strong>Defines:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#efmodsystemcontext" title="">EFMODSystemContext</span class="dead-link"> </li>
</ul>
<p><strong>Methods:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ifmodstudiomodule_get" title="">IFMODStudioModule::Get</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ifmodstudiomodule_isavailable" title="">IFMODStudioModule::IsAvailable</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ifmodstudiomodule_getstudiosystem" title="">IFMODStudioModule::GetStudioSystem</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ifmodstudiomodule_setsystempaused" title="">IFMODStudioModule::SetSystemPaused</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ifmodstudiomodule_refreshsettings" title="">IFMODStudioModule::RefreshSettings</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ifmodstudiomodule_setinpie" title="">IFMODStudioModule::SetInPIE</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ifmodstudiomodule_findassetbyname" title="">IFMODStudioModule::FindAssetByName</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ifmodstudiomodule_findeventbyname" title="">IFMODStudioModule::FindEventByName</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ifmodstudiomodule_getbankpath" title="">IFMODStudioModule::GetBankPath</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ifmodstudiomodule_geteventdescription" title="">IFMODStudioModule::GetEventDescription</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ifmodstudiomodule_createauditioninginstance" title="">IFMODStudioModule::CreateAuditioningInstance</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ifmodstudiomodule_stopauditioninginstance" title="">IFMODStudioModule::StopAuditioningInstance</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ifmodstudiomodule_haslistenermoved" title="">IFMODStudioModule::HasListenerMoved</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ifmodstudiomodule_setlistenerposition" title="">IFMODStudioModule::SetListenerPosition</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ifmodstudiomodule_finishsetlistenerposition" title="">IFMODStudioModule::FinishSetListenerPosition</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ifmodstudiomodule_getnearestlistener" title="">IFMODStudioModule::GetNearestListener</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ifmodstudiomodule_banksreloadedevent" title="">IFMODStudioModule::BanksReloadedEvent</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ifmodstudiomodule_getfailedbankloads" title="">IFMODStudioModule::GetFailedBankLoads</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ifmodstudiomodule_getrequiredplugins" title="">IFMODStudioModule::GetRequiredPlugins</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ifmodstudiomodule_addrequiredplugin" title="">IFMODStudioModule::AddRequiredPlugin</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ifmodstudiomodule_usesound" title="">IFMODStudioModule::UseSound</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ifmodstudiomodule_loadplugin" title="">IFMODStudioModule::LoadPlugin</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ifmodstudiomodule_logerror" title="">IFMODStudioModule::LogError</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ifmodstudiomodule_arebanksloaded" title="">IFMODStudioModule::AreBanksLoaded</span class="dead-link"> </li>
</ul></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

98
Plugins/FMODStudio/Docs/api-reference-ufmodanimnotifyplay.html Normal file
View file

@ -0,0 +1,98 @@
<html>
<head>
<title>API Reference | UFMODAnimNotifyPlay</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-fmodutils.html">FMODUtils</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ffmodlistener.html">FFMODListener</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li><li><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li><li><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li><li><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li><li><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li><li><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li><li><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li><li><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li><li><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li><li><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li></ul></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>5. API Reference | UFMODAnimNotifyPlay</h1>
<div class="admonition warning">
<p class="admonition-title">This documentation is preliminary and is subject to change.</p>
</div>
<p>Used for triggering Events in Animation timelines.</p>
<p>This class inherits from <a href="https://api.unrealengine.com/INT/API/Runtime/Engine/Animation/AnimNotifies/UAnimNotify/index.html">UAnimNotify</a></p>
<p><strong>Properties:</strong></p>
<ul>
<li><a class="apilink" href="api-reference-ufmodanimnotifyplay.html#ufmodanimnotifyplay_bfollow" title="Should this sound follow its owner.">UFMODAnimNotifyPlay::bFollow</a> Should this sound follow its owner.</li>
<li><a class="apilink" href="api-reference-ufmodanimnotifyplay.html#ufmodanimnotifyplay_attachname" title="Socket or bone name to attach sound to.">UFMODAnimNotifyPlay::AttachName</a> Socket or bone name to attach sound to.</li>
<li><a class="apilink" href="api-reference-ufmodanimnotifyplay.html#ufmodanimnotifyplay_event" title="FMODEvent reference to play.">UFMODAnimNotifyPlay::Event</a> FMODEvent reference to play.</li>
</ul>
<p><strong>Methods:</strong></p>
<ul>
<li><a class="apilink" href="api-reference-ufmodanimnotifyplay.html#ufmodanimnotifyplay_notify" title="Event triggered when the timeline crosses the notify marker.">UFMODAnimNotifyPlay::Notify</a> Event triggered when the timeline crosses the notify marker.</li>
</ul>
<h2 api="struct" id="ufmodanimnotifyplay_attachname"><a href="#ufmodanimnotifyplay_attachname">UFMODAnimNotifyPlay::AttachName</a></h2>
<p>Socket or bone name to attach sound to.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="n">FString</span> <span class="n">AttachName</span><span class="p">;</span>
</pre></div>
<h2 api="struct" id="ufmodanimnotifyplay_bfollow"><a href="#ufmodanimnotifyplay_bfollow">UFMODAnimNotifyPlay::bFollow</a></h2>
<p>Should this sound follow its owner.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="n">unit32</span> <span class="nl">bFollow</span> <span class="p">:</span> <span class="mi">1</span><span class="p">;</span>
</pre></div>
<h2 api="struct" id="ufmodanimnotifyplay_event"><a href="#ufmodanimnotifyplay_event">UFMODAnimNotifyPlay::Event</a></h2>
<p>FMODEvent reference to play.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="n">TAssetPtr</span><span class="o">&lt;</span><span class="k">class</span> <span class="nc">UFMODEvent</span><span class="o">&gt;</span> <span class="n">Event</span><span class="p">;</span>
</pre></div>
<p><strong>See Also:</strong> <a class="apilink" href="api-reference-ufmodevent.html" title="">UFMODEvent</a></p>
<h2 api="function" id="ufmodanimnotifyplay_notify"><a href="#ufmodanimnotifyplay_notify">UFMODAnimNotifyPlay::Notify</a></h2>
<p>Event triggered when the timeline crosses the notify marker.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">virtual</span> <span class="kt">void</span> <span class="n">Notify</span><span class="p">(</span><span class="n">USkeletalMeshComponent</span> <span class="o">*</span><span class="n">MeshComp</span><span class="p">,</span> <span class="n">UAnimSequenceBase</span> <span class="o">*</span><span class="n">AnimSeq</span><span class="p">)</span> <span class="k">override</span>
</pre></div>
<dl>
<dt>MeshComp</dt>
<dd>USceneComponent used for the position of the Event.</dd>
<dt>AnimSeq</dt>
<dd>Reference to the current animation.</dd>
</dl>
<p>If <a class="apilink" href="api-reference-ufmodanimnotifyplay.html#ufmodanimnotifyplay_bfollow" title="Should this sound follow its owner.">UFMODAnimNotifyPlay::bFollow</a> is true <a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_playeventattached" title="Play an event attached to and following the specified component.">UFMODBlueprintStatics::PlayEventAttached</a> is called using the current <a class="apilink" href="api-reference-ufmodanimnotifyplay.html#ufmodanimnotifyplay_attachname" title="Socket or bone name to attach sound to.">UFMODAnimNotifyPlay::AttachName</a>.<br />
Otherwise <a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_playeventatlocation" title="Plays an event at the given location.">UFMODBlueprintStatics::PlayEventAtLocation</a> is called using the <code>MeshComp</code> for the positional information.</p></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

106
Plugins/FMODStudio/Docs/api-reference-ufmodasset.html Normal file
View file

@ -0,0 +1,106 @@
<html>
<head>
<title>API Reference | UFMODAsset</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-fmodutils.html">FMODUtils</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ffmodlistener.html">FFMODListener</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li><li><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li><li><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li><li><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li><li><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li><li><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li><li><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li><li><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li><li><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li><li><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li></ul></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>5. API Reference | UFMODAsset</h1>
<div class="admonition warning">
<p class="admonition-title">This documentation is preliminary and is subject to change.</p>
</div>
<p>Base asset used for creating FMOD object assets in UE4.</p>
<p>This class inherits from <a href="https://api.unrealengine.com/INT/API/Runtime/CoreUObject/UObject/UObject/index.html">UObject</a></p>
<p><strong>Properties:</strong></p>
<ul>
<li><a class="apilink" href="api-reference-ufmodasset.html#ufmodasset_assetguid" title="The unique Guid, which matches the one exported from FMOD Studio.">UFMODAsset::AssetGuid</a> The unique Guid, which matches the one exported from FMOD Studio.</li>
<li><a class="apilink" href="api-reference-ufmodasset.html#ufmodasset_bshowasasset" title="Whether to show in the content window.">UFMODAsset::bShowAsAsset</a> Whether to show in the content window.</li>
<li><a class="apilink" href="api-reference-ufmodasset.html#ufmodasset_filename" title="In memory asset name, created at load time.">UFMODAsset::FileName</a> In memory asset name, created at load time.</li>
</ul>
<p><strong>Methods:</strong></p>
<ul>
<li><a class="apilink" href="api-reference-ufmodasset.html#ufmodasset_isasset" title="Event triggered when the timeline crosses the notify marker.">UFMODAsset::IsAsset</a> Event triggered when the timeline crosses the notify marker.</li>
<li><a class="apilink" href="api-reference-ufmodasset.html#ufmodasset_getassetregistrytags" title="Get tags to show in content view.">UFMODAsset::GetAssetRegistryTags</a> Get tags to show in content view.</li>
</ul>
<h2 api="struct" id="ufmodasset_assetguid"><a href="#ufmodasset_assetguid">UFMODAsset::AssetGuid</a></h2>
<p>The unique Guid, which matches the one exported from FMOD Studio.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="n">FGuid</span> <span class="n">AssetGuid</span><span class="p">;</span>
</pre></div>
<h2 api="function" id="ufmodasset_bshowasasset"><a href="#ufmodasset_bshowasasset">UFMODAsset::bShowAsAsset</a></h2>
<p>Whether to show in the content window.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="kt">bool</span> <span class="n">bShowAsAsset</span><span class="p">;</span>
</pre></div>
<h2 api="struct" id="ufmodasset_filename"><a href="#ufmodasset_filename">UFMODAsset::FileName</a></h2>
<p>In memory asset name, created at load time.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="n">FString</span> <span class="n">FileName</span><span class="p">;</span>
</pre></div>
<h2 api="function" id="ufmodasset_getassetregistrytags"><a href="#ufmodasset_getassetregistrytags">UFMODAsset::GetAssetRegistryTags</a></h2>
<p>Get tags to show in content view.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">virtual</span> <span class="kt">void</span> <span class="n">GetAssetRegistryTags</span><span class="p">(</span><span class="n">TArray</span><span class="o">&lt;</span><span class="n">FAssetRegistryTag</span><span class="o">&gt;</span> <span class="o">&amp;</span><span class="n">OutTags</span><span class="p">)</span> <span class="k">const</span> <span class="k">override</span>
</pre></div>
<dl>
<dt>OutTags</dt>
<dd></dd>
</dl>
<h2 api="function" id="ufmodasset_isasset"><a href="#ufmodasset_isasset">UFMODAsset::IsAsset</a></h2>
<p>Event triggered when the timeline crosses the notify marker.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">virtual</span> <span class="kt">bool</span> <span class="n">IsAsset</span><span class="p">()</span> <span class="k">const</span> <span class="k">override</span>
</pre></div>
<p>Returns <a class="apilink" href="api-reference-ufmodasset.html#ufmodasset_bshowasasset" title="Whether to show in the content window.">UFMODAsset::bShowAsAsset</a>.</p></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

1126
Plugins/FMODStudio/Docs/api-reference-ufmodaudiocomponent.html Normal file
View file

File diff suppressed because it is too large Load diff

39
Plugins/FMODStudio/Docs/api-reference-ufmodbank.html Normal file
View file

@ -0,0 +1,39 @@
<html>
<head>
<title>API Reference | UFMODBank</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-fmodutils.html">FMODUtils</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ffmodlistener.html">FFMODListener</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li><li><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li><li><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li><li><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li><li><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li><li><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li><li><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li><li><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li><li><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li><li><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li></ul></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>5. API Reference | UFMODBank</h1>
<div class="admonition warning">
<p class="admonition-title">This documentation is preliminary and is subject to change.</p>
</div>
<p>This class inherits from <a class="apilink" href="api-reference-ufmodasset.html" title="">UFMODAsset</a></p>
<p><strong>Methods:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ufmodbank_getassetregistrytags" title="">UFMODBank::GetAssetRegistryTags</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodbank_getdesc" title="">UFMODBank::GetDesc</span class="dead-link"> </li>
</ul></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

844
Plugins/FMODStudio/Docs/api-reference-ufmodblueprintstatics.html Normal file
View file

@ -0,0 +1,844 @@
<html>
<head>
<title>API Reference | UFMODBlueprintStatics</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-fmodutils.html">FMODUtils</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ffmodlistener.html">FFMODListener</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li><li><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li><li><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li><li><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li><li><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li><li><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li><li><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li><li><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li><li><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li><li><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li></ul></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>5. API Reference | UFMODBlueprintStatics</h1>
<div class="admonition warning">
<p class="admonition-title">This documentation is preliminary and is subject to change.</p>
</div>
<p>This class inherits from <a href="https://api.unrealengine.com/INT/API/Runtime/Engine/Kismet/UBlueprintFunctionLibrary/index.html">UBlueprintFunctionLibrary</a></p>
<p><strong>Defines:</strong></p>
<ul>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ffmodeventinstance" title="Wrapped FMOD::Studio::EventInstance for use in blueprints.">FFMODEventInstance</a> Wrapped FMOD::Studio::EventInstance for use in blueprints.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#efmod_studio_stop_mode" title="Studio stop mode enum for use in blueprints.">EFMOD_STUDIO_STOP_MODE</a> Studio stop mode enum for use in blueprints.</li>
</ul>
<p><strong>Methods:</strong></p>
<ul>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_findassetbyname" title="Find an asset by name.">UFMODBlueprintStatics::FindAssetByName</a> Find an asset by name.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_findeventbyname" title="Find an Event by name.">UFMODBlueprintStatics::FindEventByName</a> Find an Event by name.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_findeventinstances" title="Return a list of all event instances that are playing for this event.">UFMODBlueprintStatics::FindEventInstances</a> Return a list of all event instances that are playing for this event.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_getglobalparameterbyname" title="Get a global parameter value from the System.">UFMODBlueprintStatics::GetGlobalParameterByName</a> Get a global parameter value from the System.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_setglobalparameterbyname" title="Set a global parameter from the System.">UFMODBlueprintStatics::SetGlobalParameterByName</a> Set a global parameter from the System.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_getoutputdrivers" title="List all output device names.">UFMODBlueprintStatics::GetOutputDrivers</a> List all output device names.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_setoutputdriverbyname" title="Set current output device by name or part of the name.">UFMODBlueprintStatics::SetOutputDriverByName</a> Set current output device by name or part of the name.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_setoutputdriverbyindex" title="Set current output device by its index from GetOutputDrivers.">UFMODBlueprintStatics::SetOutputDriverByIndex</a> Set current output device by its index from GetOutputDrivers.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_mixersuspend" title="Suspend the FMOD mixer.">UFMODBlueprintStatics::MixerSuspend</a> Suspend the FMOD mixer.</li>
<li>
<p><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_mixerresume" title="Resume the FMOD mixer.">UFMODBlueprintStatics::MixerResume</a> Resume the FMOD mixer.</p>
</li>
<li>
<p><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_loadbank" title="Load a bank.">UFMODBlueprintStatics::LoadBank</a> Load a bank.</p>
</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_unloadbank" title="Unload a bank.">UFMODBlueprintStatics::UnloadBank</a> Unload a bank.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_isbankloaded" title="Return true if a bank is loaded.">UFMODBlueprintStatics::IsBankLoaded</a> Return true if a bank is loaded.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_loadbanksampledata" title="Load bank sample data.">UFMODBlueprintStatics::LoadBankSampleData</a> Load bank sample data.</li>
<li>
<p><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_unloadbanksampledata" title="Unload bank sample data.">UFMODBlueprintStatics::UnloadBankSampleData</a> Unload bank sample data.</p>
</li>
<li>
<p><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_bussetvolume" title="Set volume on a bus.">UFMODBlueprintStatics::BusSetVolume</a> Set volume on a bus.</p>
</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_bussetpaused" title="Pause/Unpause all events going through the bus.">UFMODBlueprintStatics::BusSetPaused</a> Pause/Unpause all events going through the bus.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_bussetmute" title="Mute/Unmute the bus.">UFMODBlueprintStatics::BusSetMute</a> Mute/Unmute the bus.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_busstopallevents" title="Stop all EventInstances routed into the bus.">UFMODBlueprintStatics::BusStopAllEvents</a> Stop all EventInstances routed into the bus.</li>
<li>
<p><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_vcasetvolume" title="Set volume on a VCA.">UFMODBlueprintStatics::VCASetVolume</a> Set volume on a VCA.</p>
</li>
<li>
<p><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_playevent2d" title="Play an event without a specified location.">UFMODBlueprintStatics::PlayEvent2D</a> Play an event without a specified location.</p>
</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_playeventatlocation" title="Plays an event at the given location.">UFMODBlueprintStatics::PlayEventAtLocation</a> Plays an event at the given location.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_playeventattached" title="Play an event attached to and following the specified component.">UFMODBlueprintStatics::PlayEventAttached</a> Play an event attached to and following the specified component.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_eventinstanceisvalid" title="Return whether this FMOD Event Instance is valid.">UFMODBlueprintStatics::EventInstanceIsValid</a> Return whether this FMOD Event Instance is valid.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_eventinstancesetvolume" title="Set volume on an FMOD Event Instance.">UFMODBlueprintStatics::EventInstanceSetVolume</a> Set volume on an FMOD Event Instance.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_eventinstancesetpitch" title="Set pitch on an FMOD Event Instance.">UFMODBlueprintStatics::EventInstanceSetPitch</a> Set pitch on an FMOD Event Instance.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_eventinstancesetpaused" title="Pause/Unpause an FMOD Event Instance.">UFMODBlueprintStatics::EventInstanceSetPaused</a> Pause/Unpause an FMOD Event Instance.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_eventinstancegetparameter" title="Get a parameter on an FMOD Event Instance.">UFMODBlueprintStatics::EventInstanceGetParameter</a> Get a parameter on an FMOD Event Instance.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_eventinstancesetparameter" title="Set a parameter on an FMOD Event Instance.">UFMODBlueprintStatics::EventInstanceSetParameter</a> Set a parameter on an FMOD Event Instance.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_eventinstancesetproperty" title="Set an FMOD event property on an FMOD Event Instance.">UFMODBlueprintStatics::EventInstanceSetProperty</a> Set an FMOD event property on an FMOD Event Instance.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_eventinstanceplay" title="Play an FMOD Event Instance.">UFMODBlueprintStatics::EventInstancePlay</a> Play an FMOD Event Instance.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_eventinstancestop" title="Mute/Unmute the bus.">UFMODBlueprintStatics::EventInstanceStop</a> Mute/Unmute the bus.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_eventinstancetriggercue" title="Trigger a cue on an FMOD Event Instance.">UFMODBlueprintStatics::EventInstanceTriggerCue</a> Trigger a cue on an FMOD Event Instance.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_eventinstancesettransform" title="Set 3D attributes on an FMOD Event Instance.">UFMODBlueprintStatics::EventInstanceSetTransform</a> Set 3D attributes on an FMOD Event Instance.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_loadeventsampledata" title="Load event sample data.">UFMODBlueprintStatics::LoadEventSampleData</a> Load event sample data.</li>
<li><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_unloadeventsampledata" title="Unload event sample data.">UFMODBlueprintStatics::UnloadEventSampleData</a> Unload event sample data.</li>
</ul>
<h2 api="function" id="ufmodblueprintstatics_bussetmute"><a href="#ufmodblueprintstatics_bussetmute">UFMODBlueprintStatics::BusSetMute</a></h2>
<p>Mute/Unmute the bus.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">void</span> <span class="nf">BusSetMute</span><span class="p">(</span>
<span class="k">class</span> <span class="nc">UFMODBus</span> <span class="o">*</span><span class="n">Bus</span><span class="p">,</span>
<span class="kt">bool</span> <span class="n">bMute</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>Bus</dt>
<dd><a class="apilink" href="api-reference-ufmodbus.html" title="">UFMODBus</a> to use.</dd>
<dt>bMute</dt>
<dd>Mute value.</dd>
</dl>
<h2 api="function" id="ufmodblueprintstatics_bussetpaused"><a href="#ufmodblueprintstatics_bussetpaused">UFMODBlueprintStatics::BusSetPaused</a></h2>
<p>Pause/Unpause all events going through the bus.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">void</span> <span class="nf">BusSetPaused</span><span class="p">(</span>
<span class="k">class</span> <span class="nc">UFMODBus</span> <span class="o">*</span><span class="n">Bus</span><span class="p">,</span>
<span class="kt">bool</span> <span class="n">bPaused</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>Bus</dt>
<dd><a class="apilink" href="api-reference-ufmodbus.html" title="">UFMODBus</a> to use.</dd>
<dt>bPaused</dt>
<dd>Pause value.</dd>
</dl>
<h2 api="function" id="ufmodblueprintstatics_bussetvolume"><a href="#ufmodblueprintstatics_bussetvolume">UFMODBlueprintStatics::BusSetVolume</a></h2>
<p>Set volume on a bus.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">void</span> <span class="nf">BusSetVolume</span><span class="p">(</span>
<span class="k">class</span> <span class="nc">UFMODBus</span> <span class="o">*</span><span class="n">Bus</span><span class="p">,</span>
<span class="kt">float</span> <span class="n">Volume</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>Bus</dt>
<dd><a class="apilink" href="api-reference-ufmodbus.html" title="">UFMODBus</a> to use.</dd>
<dt>Volume</dt>
<dd>
<p>Volume value.</p>
<ul>
<li><span class="label">Units:</span> Linear</li>
<li><span class="label">Range:</span> [0, 1]</li>
</ul>
</dd>
</dl>
<h2 api="function" id="ufmodblueprintstatics_busstopallevents"><a href="#ufmodblueprintstatics_busstopallevents">UFMODBlueprintStatics::BusStopAllEvents</a></h2>
<p>Stop all EventInstances routed into the bus.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">void</span> <span class="nf">BusStopAllEvents</span><span class="p">(</span>
<span class="k">class</span> <span class="nc">UFMODBus</span> <span class="o">*</span><span class="n">Bus</span><span class="p">,</span>
<span class="n">EFMOD_STUDIO_STOP_MODE</span> <span class="n">stopMode</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>Bus</dt>
<dd><a class="apilink" href="api-reference-ufmodbus.html" title="">UFMODBus</a> to use.</dd>
<dt>stopMode</dt>
<dd>Desired stop mode.</dd>
</dl>
<p><strong>See Also:</strong> <a href="https://fmod.com/resources/documentation-api?version=2.0&amp;page=studio-api-eventinstance.html#fmod_studio_stop_mode">FMOD_STUDIO_STOP_MODE</a></p>
<h2 api="struct" id="efmod_studio_stop_mode"><a href="#efmod_studio_stop_mode">EFMOD_STUDIO_STOP_MODE</a></h2>
<p>Studio stop mode enum for use in blueprints.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">enum</span> <span class="n">EFMOD_STUDIO_STOP_MODE</span><span class="p">{</span>
<span class="n">ALLOWFADEOUT</span><span class="p">,</span>
<span class="n">IMMEDIATE</span>
<span class="p">}</span> <span class="n">EFMOD_STUDIO_STOP_MODE</span><span class="p">;</span>
</pre></div>
<dl>
<dt id="efmod_studio_stop_mode_allowfadeout">ALLOWFADEOUT</dt>
<dd>Allow AHDSR modulators to complete their release, and DSP effect tails to play out.</dd>
<dt id="efmod_studio_stop_mode_immediate">IMMEDIATE</dt>
<dd>Stop the event instance immediately.</dd>
</dl>
<p><strong>See Also:</strong> <a href="https://fmod.com/resources/documentation-api?version=2.0&amp;page=studio-api-eventinstance.html#fmod_studio_stop_mode">FMOD_STUDIO_STOP_MODE</a></p>
<h2 api="function" id="ufmodblueprintstatics_eventinstancegetparameter"><a href="#ufmodblueprintstatics_eventinstancegetparameter">UFMODBlueprintStatics::EventInstanceGetParameter</a></h2>
<p>Get a parameter on an FMOD Event Instance.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">float</span> <span class="nf">EventInstanceGetParameter</span><span class="p">(</span>
<span class="n">FFMODEventInstance</span> <span class="n">EventInstance</span><span class="p">,</span>
<span class="n">FName</span> <span class="n">Name</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>EventInstance</dt>
<dd><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ffmodeventinstance" title="Wrapped FMOD::Studio::EventInstance for use in blueprints.">FFMODEventInstance</a> to use.</dd>
<dt>Name</dt>
<dd>Name of parameter.</dd>
</dl>
<h2 api="function" id="ufmodblueprintstatics_eventinstanceisvalid"><a href="#ufmodblueprintstatics_eventinstanceisvalid">UFMODBlueprintStatics::EventInstanceIsValid</a></h2>
<p>Return whether this FMOD Event Instance is valid.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">bool</span> <span class="nf">EventInstanceIsValid</span><span class="p">(</span>
<span class="n">FFMODEventInstance</span> <span class="n">EventInstance</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>EventInstance</dt>
<dd><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ffmodeventinstance" title="Wrapped FMOD::Studio::EventInstance for use in blueprints.">FFMODEventInstance</a> to use.</dd>
</dl>
<p>The instance will be invalidated when the sound stops.</p>
<h2 api="function" id="ufmodblueprintstatics_eventinstanceplay"><a href="#ufmodblueprintstatics_eventinstanceplay">UFMODBlueprintStatics::EventInstancePlay</a></h2>
<p>Play an FMOD Event Instance.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">void</span> <span class="nf">EventInstancePlay</span><span class="p">(</span>
<span class="n">FFMODEventInstance</span> <span class="n">EventInstance</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>EventInstance</dt>
<dd><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ffmodeventinstance" title="Wrapped FMOD::Studio::EventInstance for use in blueprints.">FFMODEventInstance</a> to use.</dd>
</dl>
<h2 api="function" id="ufmodblueprintstatics_eventinstancesetparameter"><a href="#ufmodblueprintstatics_eventinstancesetparameter">UFMODBlueprintStatics::EventInstanceSetParameter</a></h2>
<p>Set a parameter on an FMOD Event Instance.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">void</span> <span class="nf">EventInstanceSetParameter</span><span class="p">(</span>
<span class="n">FFMODEventInstance</span> <span class="n">EventInstance</span><span class="p">,</span>
<span class="n">FName</span> <span class="n">Name</span><span class="p">,</span>
<span class="kt">float</span> <span class="n">Value</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>EventInstance</dt>
<dd><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ffmodeventinstance" title="Wrapped FMOD::Studio::EventInstance for use in blueprints.">FFMODEventInstance</a> to use.</dd>
<dt>Name</dt>
<dd>Name of the parameter.</dd>
<dt>Value</dt>
<dd>Value to set the parameter to.</dd>
</dl>
<h2 api="function" id="ufmodblueprintstatics_eventinstancesetpaused"><a href="#ufmodblueprintstatics_eventinstancesetpaused">UFMODBlueprintStatics::EventInstanceSetPaused</a></h2>
<p>Pause/Unpause an FMOD Event Instance.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">void</span> <span class="nf">EventInstanceSetPaused</span><span class="p">(</span>
<span class="n">FFMODEventInstance</span> <span class="n">EventInstance</span><span class="p">,</span>
<span class="kt">bool</span> <span class="n">Paused</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>EventInstance</dt>
<dd><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ffmodeventinstance" title="Wrapped FMOD::Studio::EventInstance for use in blueprints.">FFMODEventInstance</a> to use.</dd>
<dt>Paused</dt>
<dd>Paused value.</dd>
</dl>
<h2 api="function" id="ufmodblueprintstatics_eventinstancesetpitch"><a href="#ufmodblueprintstatics_eventinstancesetpitch">UFMODBlueprintStatics::EventInstanceSetPitch</a></h2>
<p>Set pitch on an FMOD Event Instance.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">void</span> <span class="nf">EventInstanceSetPitch</span><span class="p">(</span>
<span class="n">FFMODEventInstance</span> <span class="n">EventInstance</span><span class="p">,</span>
<span class="kt">float</span> <span class="n">Pitch</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>EventInstance</dt>
<dd><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ffmodeventinstance" title="Wrapped FMOD::Studio::EventInstance for use in blueprints.">FFMODEventInstance</a> to use.</dd>
<dt>Pitch</dt>
<dd>Pitch value.</dd>
</dl>
<h2 api="function" id="ufmodblueprintstatics_eventinstancesetproperty"><a href="#ufmodblueprintstatics_eventinstancesetproperty">UFMODBlueprintStatics::EventInstanceSetProperty</a></h2>
<p>Set an FMOD event property on an FMOD Event Instance.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">void</span> <span class="nf">EventInstanceSetProperty</span><span class="p">(</span>
<span class="n">FFMODEventInstance</span> <span class="n">EventInstance</span><span class="p">,</span>
<span class="n">EFMODEventProperty</span><span class="o">::</span><span class="n">Type</span> <span class="n">Property</span><span class="p">,</span>
<span class="kt">float</span> <span class="n">Value</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>EventInstance</dt>
<dd><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ffmodeventinstance" title="Wrapped FMOD::Studio::EventInstance for use in blueprints.">FFMODEventInstance</a> to use.</dd>
<dt>Property</dt>
<dd><a href="https://fmod.com/resources/documentation-api?version=2.0&amp;page=studio-api-eventinstance.html#fmod_studio_event_property">FMOD_STUDIO_EVENT_PROPERTY</a> to set.</dd>
<dt>Value</dt>
<dd>Value of property.</dd>
</dl>
<h2 api="function" id="ufmodblueprintstatics_eventinstancesettransform"><a href="#ufmodblueprintstatics_eventinstancesettransform">UFMODBlueprintStatics::EventInstanceSetTransform</a></h2>
<p>Set 3D attributes on an FMOD Event Instance.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">void</span> <span class="nf">EventInstanceSetTransform</span><span class="p">(</span>
<span class="n">FFMODEventInstance</span> <span class="n">EventInstance</span><span class="p">,</span>
<span class="k">const</span> <span class="n">FTransform</span> <span class="o">&amp;</span><span class="n">Location</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>EventInstance</dt>
<dd><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ffmodeventinstance" title="Wrapped FMOD::Studio::EventInstance for use in blueprints.">FFMODEventInstance</a> to use.</dd>
<dt>Location</dt>
<dd>Location to place event.</dd>
</dl>
<h2 api="function" id="ufmodblueprintstatics_eventinstancesetvolume"><a href="#ufmodblueprintstatics_eventinstancesetvolume">UFMODBlueprintStatics::EventInstanceSetVolume</a></h2>
<p>Set volume on an FMOD Event Instance.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">void</span> <span class="nf">EventInstanceSetVolume</span><span class="p">(</span>
<span class="n">FFMODEventInstance</span> <span class="n">EventInstance</span><span class="p">,</span>
<span class="kt">float</span> <span class="n">Volume</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>EventInstance</dt>
<dd>Event Instance to use.</dd>
<dt>Volume</dt>
<dd>Volume value to set.</dd>
</dl>
<p><strong>See Also:</strong> <a href="">FMOD::Studio::EventInstance</a></p>
<h2 api="function" id="ufmodblueprintstatics_eventinstancestop"><a href="#ufmodblueprintstatics_eventinstancestop">UFMODBlueprintStatics::EventInstanceStop</a></h2>
<p>Mute/Unmute the bus.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">void</span> <span class="nf">EventInstanceStop</span><span class="p">(</span>
<span class="n">FFMODEventInstance</span> <span class="n">EventInstance</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>EventInstance</dt>
<dd></dd>
</dl>
<h2 api="function" id="ufmodblueprintstatics_eventinstancetriggercue"><a href="#ufmodblueprintstatics_eventinstancetriggercue">UFMODBlueprintStatics::EventInstanceTriggerCue</a></h2>
<p>Trigger a cue on an FMOD Event Instance.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">void</span> <span class="nf">EventInstanceTriggerCue</span><span class="p">(</span>
<span class="n">FFMODEventInstance</span> <span class="n">EventInstance</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>EventInstance</dt>
<dd><a class="apilink" href="api-reference-ufmodblueprintstatics.html#ffmodeventinstance" title="Wrapped FMOD::Studio::EventInstance for use in blueprints.">FFMODEventInstance</a> to use.</dd>
</dl>
<p><strong>See Also:</strong> <a href="https://fmod.com/resources/documentation-api?version=2.0&amp;page=white-papers-transitioning-from-fmodex.html#sustain-points-and-key-off">Sustain Points and Key Off</a></p>
<h2 api="struct" id="ffmodeventinstance"><a href="#ffmodeventinstance">FFMODEventInstance</a></h2>
<p>Wrapped FMOD::Studio::EventInstance for use in blueprints.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">struct</span> <span class="n">FFMODEventInstance</span><span class="p">{</span>
<span class="n">FMOD</span><span class="o">::</span><span class="n">Studio</span><span class="o">::</span><span class="n">EventInstance</span> <span class="o">*</span><span class="n">Instance</span><span class="p">;</span>
<span class="p">}</span> <span class="n">FFMODEventInstance</span><span class="p">;</span>
</pre></div>
<dl>
<dt id="ffmodeventinstance_instance">Instance</dt>
<dd><a href="https://fmod.com/resources/documentation-api?version=2.0&amp;page=studio-api-eventinstance.html">FMOD::Studio::EventInstance</a> to use.</dd>
</dl>
<h2 api="function" id="ufmodblueprintstatics_findassetbyname"><a href="#ufmodblueprintstatics_findassetbyname">UFMODBlueprintStatics::FindAssetByName</a></h2>
<p>Find an asset by name.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="n">UFMODAsset</span> <span class="o">*</span><span class="nf">FindAssetByName</span><span class="p">(</span>
<span class="k">const</span> <span class="n">FString</span> <span class="o">&amp;</span><span class="n">Name</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>Name</dt>
<dd>The asset name.</dd>
</dl>
<p><strong>See Also:</strong> <a class="apilink" href="api-reference-ufmodasset.html" title="">UFMODAsset</a></p>
<h2 api="function" id="ufmodblueprintstatics_findeventbyname"><a href="#ufmodblueprintstatics_findeventbyname">UFMODBlueprintStatics::FindEventByName</a></h2>
<p>Find an Event by name.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="n">UFMODEvent</span> <span class="o">*</span><span class="nf">FindEventByName</span><span class="p">(</span>
<span class="k">const</span> <span class="n">FString</span> <span class="o">&amp;</span><span class="n">Name</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>Name</dt>
<dd>The event name.</dd>
</dl>
<p><strong>See Also:</strong> <a class="apilink" href="api-reference-ufmodevent.html" title="">UFMODEvent</a></p>
<h2 api="function" id="ufmodblueprintstatics_findeventinstances"><a href="#ufmodblueprintstatics_findeventinstances">UFMODBlueprintStatics::FindEventInstances</a></h2>
<p>Return a list of all event instances that are playing for this event.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="n">TArray</span><span class="o">&lt;</span><span class="n">FFMODEventInstance</span><span class="o">&gt;</span> <span class="n">FindEventInstances</span><span class="p">(</span>
<span class="n">UObject</span> <span class="o">*</span><span class="n">WorldContextObject</span><span class="p">,</span>
<span class="n">UFMODEvent</span> <span class="o">*</span><span class="n">Event</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>WorldContextObject</dt>
<dd>Object from current world context.</dd>
<dt>Event</dt>
<dd><a class="apilink" href="api-reference-ufmodevent.html" title="">UFMODEvent</a> to find instances of.</dd>
</dl>
<p>Be careful using this function because it is possible to find and alter any playing sound, even ones owned by other audio components.</p>
<p><strong>See Also:</strong> <a class="apilink" href="api-reference-ufmodblueprintstatics.html#ffmodeventinstance" title="Wrapped FMOD::Studio::EventInstance for use in blueprints.">FFMODEventInstance</a></p>
<h2 api="function" id="ufmodblueprintstatics_getglobalparameterbyname"><a href="#ufmodblueprintstatics_getglobalparameterbyname">UFMODBlueprintStatics::GetGlobalParameterByName</a></h2>
<p>Get a global parameter value from the System.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">float</span> <span class="nf">GetGlobalParameterByName</span><span class="p">(</span>
<span class="n">FName</span> <span class="n">Name</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>Name</dt>
<dd>Name of the parameter.</dd>
</dl>
<p><strong>See Also:</strong> <a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_setglobalparameterbyname" title="Set a global parameter from the System.">UFMODBlueprintStatics::SetGlobalParameterByName</a></p>
<h2 api="function" id="ufmodblueprintstatics_getoutputdrivers"><a href="#ufmodblueprintstatics_getoutputdrivers">UFMODBlueprintStatics::GetOutputDrivers</a></h2>
<p>List all output device names.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="n">TArray</span><span class="o">&lt;</span><span class="n">FString</span><span class="o">&gt;</span> <span class="n">GetOutputDrivers</span><span class="p">();</span>
</pre></div>
<p><strong>See Also:</strong> <a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_setoutputdriverbyindex" title="Set current output device by its index from GetOutputDrivers.">UFMODBlueprintStatics::SetOutputDriverByIndex</a>, <a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_setoutputdriverbyname" title="Set current output device by name or part of the name.">UFMODBlueprintStatics::SetOutputDriverByName</a></p>
<h2 api="function" id="ufmodblueprintstatics_isbankloaded"><a href="#ufmodblueprintstatics_isbankloaded">UFMODBlueprintStatics::IsBankLoaded</a></h2>
<p>Return true if a bank is loaded.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">bool</span> <span class="nf">IsBankLoaded</span><span class="p">(</span>
<span class="n">UFMODBank</span> <span class="o">*</span><span class="n">Bank</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>Bank</dt>
<dd><a class="apilink" href="api-reference-ufmodbank.html" title="">UFMODBank</a> to query.</dd>
</dl>
<p><strong>See Also:</strong> <a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_loadbank" title="Load a bank.">UFMODBlueprintStatics::LoadBank</a></p>
<h2 api="function" id="ufmodblueprintstatics_loadbank"><a href="#ufmodblueprintstatics_loadbank">UFMODBlueprintStatics::LoadBank</a></h2>
<p>Load a bank.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">void</span> <span class="nf">LoadBank</span><span class="p">(</span>
<span class="n">UFMODBank</span> <span class="o">*</span><span class="n">Bank</span><span class="p">,</span>
<span class="kt">bool</span> <span class="n">bBlocking</span><span class="p">,</span>
<span class="kt">bool</span> <span class="n">bLoadSampleData</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>Bank</dt>
<dd><a class="apilink" href="api-reference-ufmodbank.html" title="">UFMODBank</a> to use.</dd>
<dt>bBlocking</dt>
<dd>Whether the bank will load synchronously.</dd>
<dt>bLoadSampleData</dt>
<dd>Whether sample data will be preloaded immediately.</dd>
</dl>
<h2 api="function" id="ufmodblueprintstatics_loadbanksampledata"><a href="#ufmodblueprintstatics_loadbanksampledata">UFMODBlueprintStatics::LoadBankSampleData</a></h2>
<p>Load bank sample data.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">void</span> <span class="nf">LoadBankSampleData</span><span class="p">(</span>
<span class="n">UFMODBank</span> <span class="o">*</span><span class="n">Bank</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>Bank</dt>
<dd><a class="apilink" href="api-reference-ufmodbank.html" title="">UFMODBank</a> to use.</dd>
</dl>
<h2 api="function" id="ufmodblueprintstatics_loadeventsampledata"><a href="#ufmodblueprintstatics_loadeventsampledata">UFMODBlueprintStatics::LoadEventSampleData</a></h2>
<p>Load event sample data.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">void</span> <span class="nf">LoadEventSampleData</span><span class="p">(</span>
<span class="n">UObject</span> <span class="o">*</span><span class="n">WorldContextObject</span><span class="p">,</span>
<span class="n">UFMODEvent</span> <span class="o">*</span><span class="n">Event</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>WorldContextObject</dt>
<dd>Object from current world context.</dd>
<dt>Event</dt>
<dd><a class="apilink" href="api-reference-ufmodevent.html" title="">UFMODEvent</a> to use.</dd>
</dl>
<p>This can be done ahead of time to avoid loading stalls.</p>
<h2 api="function" id="ufmodblueprintstatics_mixerresume"><a href="#ufmodblueprintstatics_mixerresume">UFMODBlueprintStatics::MixerResume</a></h2>
<p>Resume the FMOD mixer.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">void</span> <span class="nf">MixerResume</span><span class="p">();</span>
</pre></div>
<p>Used when resuming the application.</p>
<h2 api="function" id="ufmodblueprintstatics_mixersuspend"><a href="#ufmodblueprintstatics_mixersuspend">UFMODBlueprintStatics::MixerSuspend</a></h2>
<p>Suspend the FMOD mixer.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">void</span> <span class="nf">MixerSuspend</span><span class="p">();</span>
</pre></div>
<p>Used when suspending the application.</p>
<h2 api="function" id="ufmodblueprintstatics_playevent2d"><a href="#ufmodblueprintstatics_playevent2d">UFMODBlueprintStatics::PlayEvent2D</a></h2>
<p>Play an event without a specified location.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="n">FFMODEventInstance</span> <span class="nf">PlayEvent2D</span><span class="p">(</span>
<span class="n">UObject</span> <span class="o">*</span><span class="n">WorldContextObject</span><span class="p">,</span>
<span class="n">UFMODEvent</span> <span class="o">*</span><span class="n">Event</span><span class="p">,</span>
<span class="kt">bool</span> <span class="n">bAutoPlay</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>WorldContextObject</dt>
<dd>Object from current world context.</dd>
<dt>Event</dt>
<dd><a class="apilink" href="api-reference-ufmodevent.html" title="">UFMODEvent</a> to use.</dd>
<dt>bAutoPlay</dt>
<dd>Start the event automatically.</dd>
</dl>
<p>This returns an <a class="apilink" href="api-reference-ufmodblueprintstatics.html#ffmodeventinstance" title="Wrapped FMOD::Studio::EventInstance for use in blueprints.">FFMODEventInstance</a>.<br />
The sound does not travel with any actor.</p>
<h2 api="function" id="ufmodblueprintstatics_playeventatlocation"><a href="#ufmodblueprintstatics_playeventatlocation">UFMODBlueprintStatics::PlayEventAtLocation</a></h2>
<p>Plays an event at the given location.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="n">FFMODEventInstance</span> <span class="nf">PlayEventAtLocation</span><span class="p">(</span>
<span class="n">UObject</span> <span class="o">*</span><span class="n">WorldContextObject</span><span class="p">,</span>
<span class="n">UFMODEvent</span> <span class="o">*</span><span class="n">Event</span><span class="p">,</span>
<span class="k">const</span> <span class="n">FTransform</span> <span class="o">&amp;</span><span class="n">Location</span><span class="p">,</span>
<span class="kt">bool</span> <span class="n">bAutoPlay</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>WorldContextObject</dt>
<dd>Object from current world context.</dd>
<dt>Event</dt>
<dd><a class="apilink" href="api-reference-ufmodevent.html" title="">UFMODEvent</a> to use.</dd>
<dt>Location</dt>
<dd>World position to play event at.</dd>
<dt>bAutoPlay</dt>
<dd>Start the event automatically.</dd>
</dl>
<p>This returns an FMOD Event Instance.<br />
The sound does not travel with any actor.</p>
<h2 api="function" id="ufmodblueprintstatics_playeventattached"><a href="#ufmodblueprintstatics_playeventattached">UFMODBlueprintStatics::PlayEventAttached</a></h2>
<p>Play an event attached to and following the specified component.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="k">class</span> <span class="nc">UFMODAudioComponent</span> <span class="o">*</span><span class="nf">PlayEventAttached</span><span class="p">(</span>
<span class="n">UFMODEvent</span> <span class="o">*</span><span class="n">Event</span><span class="p">,</span>
<span class="n">USceneComponent</span> <span class="o">*</span><span class="n">AttachToComponent</span><span class="p">,</span>
<span class="n">FName</span> <span class="n">AttachPointName</span><span class="p">,</span>
<span class="n">FVector</span> <span class="n">Location</span><span class="p">,</span>
<span class="n">EAttachLocation</span><span class="o">::</span><span class="n">Type</span> <span class="n">LocationType</span><span class="p">,</span>
<span class="kt">bool</span> <span class="n">bStopWhenAttachedToDestroyed</span><span class="p">,</span>
<span class="kt">bool</span> <span class="n">bAutoPlay</span><span class="p">,</span>
<span class="kt">bool</span> <span class="n">bAutoDestroy</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>Event</dt>
<dd><a class="apilink" href="api-reference-ufmodevent.html" title="">UFMODEvent</a> to use.</dd>
<dt>AttachToComponent</dt>
<dd>Component to attach to.</dd>
<dt>AttachPointName <span><a class="token" href="glossary.html#documentation-conventions" title="Optional">Opt</a></span></dt>
<dd>Named point within the AttachComponent to play the sound at.</dd>
<dt>Location</dt>
<dd>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.</dd>
<dt>LocationType</dt>
<dd>Location is a relative offset or an absolute world position.</dd>
<dt>bStopWhenAttachedToDestroyed</dt>
<dd>The sound should stop playing when the owner of the attach to component is destroyed.</dd>
<dt>bAutoPlay</dt>
<dd>Start the event automatically.</dd>
<dt>bAutoDestroy</dt>
<dd>Automatically destroy the audio component when the sound is stopped.</dd>
</dl>
<h2 api="function" id="ufmodblueprintstatics_setglobalparameterbyname"><a href="#ufmodblueprintstatics_setglobalparameterbyname">UFMODBlueprintStatics::SetGlobalParameterByName</a></h2>
<p>Set a global parameter from the System.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">void</span> <span class="nf">SetGlobalParameterByName</span><span class="p">(</span>
<span class="n">FName</span> <span class="n">Name</span><span class="p">,</span>
<span class="kt">float</span> <span class="n">Value</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>Name</dt>
<dd>Name of parameter.</dd>
<dt>Value</dt>
<dd>Value to apply to the parameter.</dd>
</dl>
<h2 api="function" id="ufmodblueprintstatics_setoutputdriverbyindex"><a href="#ufmodblueprintstatics_setoutputdriverbyindex">UFMODBlueprintStatics::SetOutputDriverByIndex</a></h2>
<p>Set current output device by its index from GetOutputDrivers.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">void</span> <span class="nf">SetOutputDriverByIndex</span><span class="p">(</span>
<span class="kt">int</span> <span class="n">NewDriverIndex</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>NewDriverIndex</dt>
<dd>Index of driver to use.</dd>
</dl>
<p><strong>See Also:</strong> <a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_getoutputdrivers" title="List all output device names.">UFMODBlueprintStatics::GetOutputDrivers</a></p>
<h2 api="function" id="ufmodblueprintstatics_setoutputdriverbyname"><a href="#ufmodblueprintstatics_setoutputdriverbyname">UFMODBlueprintStatics::SetOutputDriverByName</a></h2>
<p>Set current output device by name or part of the name.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">void</span> <span class="nf">SetOutputDriverByName</span><span class="p">(</span>
<span class="n">FString</span> <span class="n">NewDriverName</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>NewDriverName</dt>
<dd>Name of new driver to use.</dd>
</dl>
<p><strong>See Also:</strong> <a class="apilink" href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_getoutputdrivers" title="List all output device names.">UFMODBlueprintStatics::GetOutputDrivers</a></p>
<h2 api="function" id="ufmodblueprintstatics_unloadbank"><a href="#ufmodblueprintstatics_unloadbank">UFMODBlueprintStatics::UnloadBank</a></h2>
<p>Unload a bank.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">void</span> <span class="nf">UnloadBank</span><span class="p">(</span>
<span class="n">UFMODBank</span> <span class="o">*</span><span class="n">Bank</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>Bank</dt>
<dd><a class="apilink" href="api-reference-ufmodbank.html" title="">UFMODBank</a> to use.</dd>
</dl>
<h2 api="function" id="ufmodblueprintstatics_unloadbanksampledata"><a href="#ufmodblueprintstatics_unloadbanksampledata">UFMODBlueprintStatics::UnloadBankSampleData</a></h2>
<p>Unload bank sample data.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">void</span> <span class="nf">UnloadBankSampleData</span><span class="p">(</span>
<span class="n">UFMODBank</span> <span class="o">*</span><span class="n">Bank</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>Bank</dt>
<dd><a class="apilink" href="api-reference-ufmodbank.html" title="">UFMODBank</a> to use.</dd>
</dl>
<h2 api="function" id="ufmodblueprintstatics_unloadeventsampledata"><a href="#ufmodblueprintstatics_unloadeventsampledata">UFMODBlueprintStatics::UnloadEventSampleData</a></h2>
<p>Unload event sample data.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">void</span> <span class="nf">UnloadEventSampleData</span><span class="p">(</span>
<span class="n">UObject</span> <span class="o">*</span><span class="n">WorldContextObject</span><span class="p">,</span>
<span class="n">UFMODEvent</span> <span class="o">*</span><span class="n">Event</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>WorldContextObject</dt>
<dd>Object from current world context.</dd>
<dt>Event</dt>
<dd><a class="apilink" href="api-reference-ufmodevent.html" title="">UFMODEvent</a> to use.</dd>
</dl>
<h2 api="function" id="ufmodblueprintstatics_vcasetvolume"><a href="#ufmodblueprintstatics_vcasetvolume">UFMODBlueprintStatics::VCASetVolume</a></h2>
<p>Set volume on a VCA.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-cpp">C++</div>
</div>
</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="kt">void</span> <span class="nf">VCASetVolume</span><span class="p">(</span>
<span class="n">UFMODVCA</span> <span class="o">*</span><span class="n">Vca</span><span class="p">,</span>
<span class="kt">float</span> <span class="n">Volume</span>
<span class="p">);</span>
</pre></div>
<dl>
<dt>Vca</dt>
<dd><a class="apilink" href="api-reference-ufmodvca.html" title="">UFMODVCA</a> to use.</dd>
<dt>Volume</dt>
<dd>Volume value.</dd>
</dl></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

39
Plugins/FMODStudio/Docs/api-reference-ufmodbus.html Normal file
View file

@ -0,0 +1,39 @@
<html>
<head>
<title>API Reference | UFMODBus</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-fmodutils.html">FMODUtils</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ffmodlistener.html">FFMODListener</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li><li><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li><li><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li><li><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li><li><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li><li><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li><li><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li><li><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li><li><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li><li><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li></ul></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>5. API Reference | UFMODBus</h1>
<div class="admonition warning">
<p class="admonition-title">This documentation is preliminary and is subject to change.</p>
</div>
<p>This class inherits from <a class="apilink" href="api-reference-ufmodasset.html" title="">UFMODAsset</a></p>
<p><strong>Methods:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ufmodbus_getassetregistrytags" title="">UFMODBus::GetAssetRegistryTags</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodbus_getdesc" title="">UFMODBus::GetDesc</span class="dead-link"> </li>
</ul></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

40
Plugins/FMODStudio/Docs/api-reference-ufmodevent.html Normal file
View file

@ -0,0 +1,40 @@
<html>
<head>
<title>API Reference | UFMODEvent</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-fmodutils.html">FMODUtils</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ffmodlistener.html">FFMODListener</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li><li><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li><li><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li><li><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li><li><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li><li><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li><li><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li><li><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li><li><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li><li><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li></ul></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>5. API Reference | UFMODEvent</h1>
<div class="admonition warning">
<p class="admonition-title">This documentation is preliminary and is subject to change.</p>
</div>
<p>This class inherits from <a class="apilink" href="api-reference-ufmodasset.html" title="">UFMODAsset</a></p>
<p><strong>Methods:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ufmodevent_getassetregistrytags" title="">UFMODEvent::GetAssetRegistryTags</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodevent_getdesc" title="">UFMODEvent::GetDesc</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodevent_getparameterdescriptions" title="">UFMODEvent::GetParameterDescriptions</span class="dead-link"> </li>
</ul></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

49
Plugins/FMODStudio/Docs/api-reference-ufmodeventcontrolsection.html Normal file
View file

@ -0,0 +1,49 @@
<html>
<head>
<title>API Reference | UFMODEventControlSection</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-fmodutils.html">FMODUtils</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ffmodlistener.html">FFMODListener</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li><li><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li><li><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li><li><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li><li><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li><li><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li><li><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li><li><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li><li><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li></ul></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>5. API Reference | UFMODEventControlSection</h1>
<div class="admonition warning">
<p class="admonition-title">This documentation is preliminary and is subject to change.</p>
</div>
<p>This class inherits from <a href="">UMovieSceneSection</a>.</p>
<p><strong>Defines:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#efmodeventcontrolkey" title="">EFMODEventControlKey</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodeventcontrolchannel" title="">FFMODEventControlChannel</span class="dead-link"> </li>
</ul>
<p><strong>Properties:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ffmodeventcontrolsection_controlkeys" title="">FFMODEventControlSection::ControlKeys</span class="dead-link"> </li>
</ul>
<p><strong>Methods:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ffmodeventcontrolsection_generatetemplate" title="">FFMODEventControlSection::GenerateTemplate</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodeventcontrolsection_assignvalue" title="">FFMODEventControlSection::AssignValue</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ffmodeventcontrolsection_evaluatechannel" title="">FFMODEventControlSection::EvaluateChannel</span class="dead-link"> </li>
</ul></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

53
Plugins/FMODStudio/Docs/api-reference-ufmodeventcontroltrack.html Normal file
View file

@ -0,0 +1,53 @@
<html>
<head>
<title>API Reference | UFMODEventControlTrack</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-fmodutils.html">FMODUtils</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ffmodlistener.html">FFMODListener</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li><li><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li><li><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li><li><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li><li><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li><li><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li><li><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li><li><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li><li><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li></ul></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>5. API Reference | UFMODEventControlTrack</h1>
<div class="admonition warning">
<p class="admonition-title">This documentation is preliminary and is subject to change.</p>
</div>
<p>This class inherits from <a href="">UMovieSceneNameableTrack</a>.</p>
<p><strong>Properties:</strong></p>
<p><strong><em>Private:</em></strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ufmodeventcontroltrack_controlsections" title="">UFMODEventControlTrack::ControlSections</span class="dead-link"> </li>
</ul>
<p><strong>Methods:</strong></p>
<p><strong><em>Public:</em></strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ufmodeventcontroltrack_getallcontrolsections" title="">UFMODEventControlTrack::GetAllControlSections</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodeventcontroltrack_removeallanimationdata" title="">UFMODEventControlTrack::RemoveAllAnimationData</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodeventcontroltrack_hassection" title="">UFMODEventControlTrack::HasSection</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodeventcontroltrack_addsection" title="">UFMODEventControlTrack::AddSection</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodeventcontroltrack_removesection" title="">UFMODEventControlTrack::RemoveSection</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodeventcontroltrack_isempty" title="">UFMODEventControlTrack::IsEmpty</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodeventcontroltrack_getallsections" title="">UFMODEventControlTrack::GetAllSections</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodeventcontroltrack_addnewsection" title="">UFMODEventControlTrack::AddNewSection</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodeventcontroltrack_createnewsection" title="">UFMODEventControlTrack::CreateNewSection</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodeventcontroltrack_getdefauldisplayname" title="">UFMODEventControlTrack::GetDefaulDisplayName</span class="dead-link"> </li>
</ul></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

53
Plugins/FMODStudio/Docs/api-reference-ufmodeventparametertrack.html Normal file
View file

@ -0,0 +1,53 @@
<html>
<head>
<title>API Reference | UFMODEventParameterTrack</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-fmodutils.html">FMODUtils</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ffmodlistener.html">FFMODListener</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li><li><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li><li><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li><li><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li><li><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li><li><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li><li><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li><li><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li><li><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li></ul></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>5. API Reference | UFMODEventParameterTrack</h1>
<div class="admonition warning">
<p class="admonition-title">This documentation is preliminary and is subject to change.</p>
</div>
<p>This class inherits from <a href="">UMovieSceneNameableTrack</a>.</p>
<p><strong>Properties:</strong></p>
<p><strong><em>Private:</em></strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ufmodeventparametertrack_sections" title="">UFMODEventParameterTrack::Sections</span class="dead-link"> </li>
</ul>
<p><strong>Methods:</strong></p>
<p><strong><em>Public:</em></strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ufmodeventparametertrack_createtemplateforsection" title="">UFMODEventParameterTrack::CreateTemplateForSection</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodeventparametertrack_createnewsection" title="">UFMODEventParameterTrack::CreateNewSection</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodeventparametertrack_removeallanimationdata" title="">UFMODEventParameterTrack::RemoveAllAnimationData</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodeventparametertrack_hassection" title="">UFMODEventParameterTrack::HasSection</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodeventparametertrack_addsection" title="">UFMODEventParameterTrack::AddSection</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodeventparametertrack_removesection" title="">UFMODEventParameterTrack::RemoveSection</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodeventparametertrack_isempty" title="">UFMODEventParameterTrack::IsEmpty</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodeventparametertrack_getallsections" title="">UFMODEventParameterTrack::GetAllSections</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodeventparametertrack_getdefaultdisplayname" title="">UFMODEventParameterTrack::GetDefaultDisplayName</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodeventparametertrack_addparameterkey" title="">UFMODEventParameterTrack::AddParameterKey</span class="dead-link"> </li>
</ul></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

84
Plugins/FMODStudio/Docs/api-reference-ufmodsettings.html Normal file
View file

@ -0,0 +1,84 @@
<html>
<head>
<title>API Reference | UFMODSettings</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-fmodutils.html">FMODUtils</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ffmodlistener.html">FFMODListener</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li><li><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li><li><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li><li><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li><li><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li><li><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li><li><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li><li><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li><li><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li><li><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li></ul></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>5. API Reference | UFMODSettings</h1>
<div class="admonition warning">
<p class="admonition-title">This documentation is preliminary and is subject to change.</p>
</div>
<p>This class inherits from <a href="">UObject</a>.</p>
<p><strong>Defines:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#efmodlogging" title="">EFMODLogging</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#efmodspeakermode" title="">EFMODSpeakerMode</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#fcustompoolsizes" title="">FCustomPoolSizes</span class="dead-link"> </li>
</ul>
<p><strong>Properties:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_bloadallbanks" title="">UFMODSettings::bLoadAllBanks</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_bloadallsampledata" title="">UFMODSettings::bLoadAllSampleData</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_benableliveupdate" title="">UFMODSettings::bEnableLiveUpdate</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_benableeditorliveupdate" title="">UFMODSettings::bEnableEditorLiveUpdate</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_bankoutputdirectory" title="">UFMODSettings::BankOutputDirectory</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_outputformat" title="">UFMODSettings::OutputFormat</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_bvol0virtual" title="">UFMODSettings::bVol0Virtual</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_vol0virtuallevel" title="">UFMODSettings::Vol0VirtualLevel</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_samplerate" title="">UFMODSettings::SampleRate</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_bmatchhardwaresamplerate" title="">UFMODSettings::bMatchHardwareSampleRate</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_realchannelcount" title="">UFMODSettings::RealChannelCount</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_totalchannelcount" title="">UFMODSettings::TotalChannelCount</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_dspbufferlength" title="">UFMODSettings::DSPBufferLength</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_dspbuffercount" title="">UFMODSettings::DSPBufferCount</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_filebuffersize" title="">UFMODSettings::FileBufferSize</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_studioupdateperiod" title="">UFMODSettings::StudioUpdatePeriod</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_initialoutputdrivername" title="">UFMODSettings::InitialOutputDriverName</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_blockallbuses" title="">UFMODSettings::bLockAllBuses</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_memorypoolsizes" title="">UFMODSettings::MemoryPoolSizes</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_liveupdateport" title="">UFMODSettings::LiveUpdatePort</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_editorliveupdateport" title="">UFMODSettings::EditorLiveUpdatePort</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_pluginfiles" title="">UFMODSettings::PluginFiles</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_contentbrowserprefix" title="">UFMODSettings::ContentBrowserPrefix</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_forceplatformname" title="">UFMODSettings::ForcePlatformName</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_masterbankname" title="">UFMODSettings::MasterBankName</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_skiploadbankname" title="">UFMODSettings::SkipLoadBankName</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_encryptionkey" title="">UFMODSettings::EncryptionKey</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_wavwriterpath" title="">UFMODSettings::WavWriterPath</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_logginglevel" title="">UFMODSettings::LoggingLevel</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_occlusionparameter" title="">UFMODSettings::OcclusionParameter</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_ambientvolumeparameter" title="">UFMODSettings::AmbientVolumeParameter</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_ambientlpfparameter" title="">UFMODSettings::AmbientLPFParameter</span class="dead-link"> </li>
</ul>
<p><strong>Methods:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_isbankpathset" title="">UFMODSettings::IsBankPathSet</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_getfullbankpath" title="">UFMODSettings::GetFullBankPath</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_getmasterbankfilename" title="">UFMODSettings::GetMasterBankFilename</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_getmasterassetsbankfilename" title="">UFMODSettings::GetMasterAssetsBankFilename</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_getmasterstringsbankfilename" title="">UFMODSettings::GetMasterStringsBankFilename</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsettings_getallbankpaths" title="">UFMODSettings::GetAllBankPaths</span class="dead-link"> </li>
</ul></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

38
Plugins/FMODStudio/Docs/api-reference-ufmodsnapshot.html Normal file
View file

@ -0,0 +1,38 @@
<html>
<head>
<title>API Reference | UFMODSnapshot</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-fmodutils.html">FMODUtils</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ffmodlistener.html">FFMODListener</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li><li><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li><li><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li><li><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li><li><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li><li><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li><li><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li><li><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li><li><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li><li><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li></ul></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>5. API Reference | UFMODSnapshot</h1>
<div class="admonition warning">
<p class="admonition-title">This documentation is preliminary and is subject to change.</p>
</div>
<p>This class inherits from <a class="apilink" href="api-reference-ufmodevent.html" title="">UFMODEvent</a>.</p>
<p><strong>Methods:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ufmodsnapshot_getdesc" title="">UFMODSnapshot::GetDesc</span class="dead-link"> </li>
</ul></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

44
Plugins/FMODStudio/Docs/api-reference-ufmodsnapshotreverb.html Normal file
View file

@ -0,0 +1,44 @@
<html>
<head>
<title>API Reference | UFMODSnapshotReverb</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-fmodutils.html">FMODUtils</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ffmodlistener.html">FFMODListener</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li><li><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li><li><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li><li><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li><li><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li><li><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li><li><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li><li><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li><li><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li><li><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li></ul></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>5. API Reference | UFMODSnapshotReverb</h1>
<div class="admonition warning">
<p class="admonition-title">This documentation is preliminary and is subject to change.</p>
</div>
<p>This class inherits from <a href="">UReverbEffect</a>.</p>
<p><strong>Properties:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ufmodsnapshotreverb_assetguid" title="">UFMODSnapshotReverb::AssetGuid</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsnapshotreverb_bshowasasset" title="">UFMODSnapshotReverb::bShowAsAsset</span class="dead-link"> </li>
</ul>
<p><strong>Methods:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ufmodsnapshotreverb_isasset" title="">UFMODSnapshotReverb::IsAsset</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodsnapshotreverb_posteditchangeproperty" title="">UFMODSnapshotReverb::PostEditChangeProperty</span class="dead-link"> </li>
</ul></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

39
Plugins/FMODStudio/Docs/api-reference-ufmodvca.html Normal file
View file

@ -0,0 +1,39 @@
<html>
<head>
<title>API Reference | UFMODVCA</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-fmodutils.html">FMODUtils</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ffmodlistener.html">FFMODListener</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li><li><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li><li><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li><li><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li><li><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li><li><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li><li><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li><li><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li><li><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li><li><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li></ul></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>5. API Reference | UFMODVCA</h1>
<div class="admonition warning">
<p class="admonition-title">This documentation is preliminary and is subject to change.</p>
</div>
<p>This class inherits from <a class="apilink" href="api-reference-ufmodasset.html" title="">UFMODAsset</a>.</p>
<p><strong>Methods:</strong></p>
<ul>
<li><span class="dead-link" class="apilink" href="#ufmodvca_getassetregistrytags" title="">UFMODVCA::GetAssetRegistryTags</span class="dead-link"> </li>
<li><span class="dead-link" class="apilink" href="#ufmodvca_getdesc" title="">UFMODVCA::GetDesc</span class="dead-link"> </li>
</ul></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

56
Plugins/FMODStudio/Docs/api-reference.html Normal file
View file

@ -0,0 +1,56 @@
<html>
<head>
<title>API Reference</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li class="manual-current-chapter manual-active-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-fmodutils.html">FMODUtils</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ffmodlistener.html">FFMODListener</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li><li><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li><li><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li><li><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li><li><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li><li><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li><li><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li><li><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li><li><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li><li><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li></ul></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>5. API Reference</h1>
<ul class="docs-body-subchapters"><li><a href="api-reference-ffmodstudiomodule.html">FFMODStudioModule</a></li>
<li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li>
<li><a href="api-reference-fmodutils.html">FMODUtils</a></li>
<li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li>
<li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li>
<li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li>
<li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li>
<li><a href="api-reference-ffmodlistener.html">FFMODListener</a></li>
<li><a href="api-reference-ufmodbank.html">UFMODBank</a></li>
<li><a href="api-reference-ufmodbus.html">UFMODBus</a></li>
<li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li>
<li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li>
<li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li>
<li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li>
<li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li>
<li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li>
<li><a href="api-reference-ffmodassettable.html">FFmodAssetTable</a></li>
<li><a href="api-reference-ffmodfilecallbacks.html">FFMODFileCallbacks</a></li>
<li><a href="api-reference-ffmodbankupdatenotifier.html">FFMODBankUpdateNotifier</a></li>
<li><a href="api-reference-fmodplatformloaddll_generic.html">FMODPlatformLoadDll_Generic</a></li>
<li><a href="api-reference-ffmodeventcontrolsectiontemplate.html">FFMODEventControlSectionTemplate</a></li>
<li><a href="api-reference-ffmodeventparametersectiontemplate.html">FFMODEventParameterSectionTemplate</a></li>
<li><a href="api-reference-ufmodeventcontrolsection.html">UFMODEventControlSection</a></li>
<li><a href="api-reference-ufmodeventcontroltrack.html">UFMODEventControlTrack</a></li>
<li><a href="api-reference-ufmodeventparametertrack.html">UFMODEventParameterTrack</a></li>
</ul></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

34
Plugins/FMODStudio/Docs/blueprint-reference.html Normal file
View file

@ -0,0 +1,34 @@
<html>
<head>
<title>Blueprint Reference</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li><a href="api-reference.html">API Reference</a></li>
<li class="manual-current-chapter manual-active-chapter"><a href="blueprint-reference.html">Blueprint Reference</a><ul>
<li><a href="#coming-soon">Coming soon...</a></li>
</ul>
</li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>6. Blueprint Reference</h1>
<h3 id="coming-soon"><a href="#coming-soon">6.0.1 Coming soon...</a></h3></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

74
Plugins/FMODStudio/Docs/glossary.html Normal file
View file

@ -0,0 +1,74 @@
<html>
<head>
<title>Glossary</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li><a href="api-reference.html">API Reference</a></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li class="manual-current-chapter manual-active-chapter"><a href="glossary.html">Glossary</a><ul>
<li><a href="#documentation-conventions">Documentation Conventions</a><ul>
<li><a href="#parameter-tokens">Parameter Tokens</a></li>
</ul>
</li>
<li><a href="#version">Version</a></li>
</ul>
</li>
</ul>
</div>
<div class="manual-content api">
<h1>9. Glossary</h1>
<p>This page includes definitions for various common FMOD Studio terms, along with references to related terms and documentation.</p>
<h2 id="documentation-conventions"><a href="#documentation-conventions">9.1 Documentation Conventions</a></h2>
<h3 id="parameter-tokens"><a href="#parameter-tokens">9.1.1 Parameter Tokens</a></h3>
<table>
<thead>
<tr>
<th align="center">Token</th>
<th>Meaning</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center"><span><span class="token" title="Output">Out</span></span></td>
<td>The API function will fill in information in this parameter.</td>
</tr>
<tr>
<td align="center"><span><span class="token" title="Optional">Opt</span></span></td>
<td>This parameter is optional, specify null or zero to ignore.</td>
</tr>
<tr>
<td align="center"><span><span class="token" title="Read-only">R/O</span></span></td>
<td>This token applies to members of various structures which FMOD passes to user callbacks. User callbacks must not modify the values of these members. Modifying the values of these members will cause undefined behavior.</td>
</tr>
<tr>
<td align="center"><span><span class="token" title="C#only">C#</span></span></td>
<td>This is only available in C#.</td>
</tr>
<tr>
<td align="center"><span><span class="token" title="Javscript-only">JS</span></span></td>
<td>This is only available in Javascript.</td>
</tr>
</tbody>
</table>
<h2 id="version"><a href="#version">9.2 Version</a></h2>
<p>The version number of FMOD Studio. Version numbers are split into three parts, in the format: productVersion.majorVersion.minorVersion. For example, the version 1.23.45 would indicate product version 1, major version 23, and minor version 45 of that major version.</p>
<p>Major versions contain significant changes, add new features, and may affect bank compatibility. Updating to a new major version usually requires project migration. New major versions may change playback behavior in some cases.</p>
<p>Minor versions, also known as patch versions, contain bug fixes and smaller workflow improvements.</p></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

BIN
Plugins/FMODStudio/Docs/images/add-actor-button.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 953 B

BIN
Plugins/FMODStudio/Docs/images/add-parameter-button.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 734 B

BIN
Plugins/FMODStudio/Docs/images/add-track-button.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 587 B

BIN
Plugins/FMODStudio/Docs/images/ambient-setting.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 34 KiB

BIN
Plugins/FMODStudio/Docs/images/assign-to-bank.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 29 KiB

BIN
Plugins/FMODStudio/Docs/images/audio-table.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 39 KiB

BIN
Plugins/FMODStudio/Docs/images/banks-blueprint.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 73 KiB

BIN
Plugins/FMODStudio/Docs/images/blueprint-play-simple.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 86 KiB

BIN
Plugins/FMODStudio/Docs/images/blueprint-sample.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 25 KiB

BIN
Plugins/FMODStudio/Docs/images/build-menu.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 7.3 KiB

BIN
Plugins/FMODStudio/Docs/images/callback-bp.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 8.4 KiB

BIN
Plugins/FMODStudio/Docs/images/callback-enable.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 2.2 KiB

BIN
Plugins/FMODStudio/Docs/images/callback-example.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 68 KiB

BIN
Plugins/FMODStudio/Docs/images/content-view.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 47 KiB

BIN
Plugins/FMODStudio/Docs/images/control-track.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 18 KiB

BIN
Plugins/FMODStudio/Docs/images/docs-menu.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 21 KiB

BIN
Plugins/FMODStudio/Docs/images/drag-ambient.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 512 KiB

BIN
Plugins/FMODStudio/Docs/images/engine-mac.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 96 KiB

BIN
Plugins/FMODStudio/Docs/images/engine-tree.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 6.6 KiB

BIN
Plugins/FMODStudio/Docs/images/event-tracks.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 34 KiB

BIN
Plugins/FMODStudio/Docs/images/fmod-content.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 39 KiB

BIN
Plugins/FMODStudio/Docs/images/getglobalparameter.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 14 KiB

BIN
Plugins/FMODStudio/Docs/images/load-locale-bank.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 29 KiB

BIN
Plugins/FMODStudio/Docs/images/master-bank-name.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 34 KiB

BIN
Plugins/FMODStudio/Docs/images/occlusion-props.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 3.7 KiB

BIN
Plugins/FMODStudio/Docs/images/occlusion-props2.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 3.2 KiB

BIN
Plugins/FMODStudio/Docs/images/occlusion-setting.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 34 KiB

BIN
Plugins/FMODStudio/Docs/images/occlusion.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 5.9 KiB

BIN
Plugins/FMODStudio/Docs/images/parameter-keyframe-curve.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 58 KiB

BIN
Plugins/FMODStudio/Docs/images/parameter-track.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 12 KiB

BIN
Plugins/FMODStudio/Docs/images/plugins.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 8.9 KiB

BIN
Plugins/FMODStudio/Docs/images/possess-actor.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 39 KiB

BIN
Plugins/FMODStudio/Docs/images/programmer-asset-name.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 4.2 KiB

BIN
Plugins/FMODStudio/Docs/images/programmer-bp.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 20 KiB

BIN
Plugins/FMODStudio/Docs/images/programmer-file-path.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 7 KiB

BIN
Plugins/FMODStudio/Docs/images/project-deploy.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 79 KiB

BIN
Plugins/FMODStudio/Docs/images/project-settings.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 72 KiB

BIN
Plugins/FMODStudio/Docs/images/reverb-ambient.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 4.4 KiB

BIN
Plugins/FMODStudio/Docs/images/reverb-assets.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 18 KiB

BIN
Plugins/FMODStudio/Docs/images/reverb-settings.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 5.6 KiB

BIN
Plugins/FMODStudio/Docs/images/reverb-snapshot-intensity.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 5.9 KiB

BIN
Plugins/FMODStudio/Docs/images/reverb-user-property.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 2.5 KiB

BIN
Plugins/FMODStudio/Docs/images/save-as-studio.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 60 KiB

BIN
Plugins/FMODStudio/Docs/images/set-audio-listener-override.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 50 KiB

BIN
Plugins/FMODStudio/Docs/images/set-locale.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 16 KiB

BIN
Plugins/FMODStudio/Docs/images/setglobalparameter.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 15 KiB

BIN
Plugins/FMODStudio/Docs/images/settings-advanced.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 32 KiB

BIN
Plugins/FMODStudio/Docs/images/settings-basic.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 21 KiB

BIN
Plugins/FMODStudio/Docs/images/settings-encryption.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 34 KiB

BIN
Plugins/FMODStudio/Docs/images/settings-init.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 35 KiB

BIN
Plugins/FMODStudio/Docs/images/settings-locale.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 25 KiB

BIN
Plugins/FMODStudio/Docs/images/studio-bank-layout.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 2.6 KiB

BIN
Plugins/FMODStudio/Docs/images/studio-export-path.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 30 KiB

BIN
Plugins/FMODStudio/Docs/images/studio-programmer.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 13 KiB

BIN
Plugins/FMODStudio/Docs/images/unload-setlocale-load.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 36 KiB

160
Plugins/FMODStudio/Docs/platform-specifics.html Normal file
View file

@ -0,0 +1,160 @@
<html>
<head>
<title>Platform Specifics</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li><a href="api-reference.html">API Reference</a></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li class="manual-current-chapter manual-active-chapter"><a href="platform-specifics.html">Platform Specifics</a><ul>
<li><a href="#android">Android</a><ul>
<li><a href="#deployment-of-android-plugins">Deployment of Android plugins</a></li>
</ul>
</li>
<li><a href="#tvos">TVOS</a></li>
<li><a href="#linux">Linux</a></li>
<li><a href="#xbox-one">Xbox One</a><ul>
<li><a href="#enabling-xboxone-microphone-input">Enabling XboxOne Microphone Input</a></li>
<li><a href="#copying-dlls-to-build">Copying dll's to build</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>7. Platform Specifics</h1>
<p>Some platforms require some extra steps to run properly.</p>
<h2 id="android"><a href="#android">7.1 Android</a></h2>
<p>To deploy on Android, make sure FMODStudio is in your game's directory, not in the Engine plugins directory. When FMODStudio is in your game's plugin directory, the engine will rebuild the plugin for Android and deploy all the files properly.</p>
<h3 id="deployment-of-android-plugins"><a href="#deployment-of-android-plugins">7.1.1 Deployment of Android plugins</a></h3>
<p>FMOD supports DSP plugins, which will be stand-alone .so files that will need to be packaged into the build. Add the .so file into the <code>FMODStudio/Binaries/Android/{Architecture}</code> directory. Unreal will also need an APL file so it knows to package the .so file. To do this, you will need to write an APL file and drop it into the <code>FMODStudio/Binaries/Android</code> directory. The FMODStudio.build.cs file looks for any file ending with __APL.xml_ and will pass that along to the unreal build tool for packaging.</p>
<p>The APL is a custom xml file format which is documented in the engine file AndroidPluginLanguage.cs. Here is a sample APL file for libovrfmod.so:</p>
<div class="highlight language-xml"><pre><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt;</span>
<span class="c">&lt;!--Plugin additions--&gt;</span>
<span class="nt">&lt;root</span> <span class="na">xmlns:android=</span><span class="s">&quot;http://schemas.android.com/apk/res/android&quot;</span><span class="nt">&gt;</span>
<span class="c">&lt;!-- init section is always evaluated once per architecture --&gt;</span>
<span class="nt">&lt;init&gt;</span>
<span class="nt">&lt;log</span> <span class="na">text=</span><span class="s">&quot;ovrfmod APL init&quot;</span><span class="nt">/&gt;</span>
<span class="nt">&lt;/init&gt;</span>
<span class="c">&lt;!-- optional files or directories to copy to Intermediate/Android/APK --&gt;</span>
<span class="nt">&lt;resourceCopies&gt;</span>
<span class="nt">&lt;log</span> <span class="na">text=</span><span class="s">&quot;ovrfmod APL copying files for $S(Architecture)/&quot;</span><span class="nt">/&gt;</span>
<span class="nt">&lt;copyFile</span> <span class="na">src=</span><span class="s">&quot;$S(PluginDir)/$S(Architecture)/libovrfmod.so&quot;</span>
<span class="na">dst=</span><span class="s">&quot;$S(BuildDir)/libs/$S(Architecture)/libovrfmod.so&quot;</span> <span class="nt">/&gt;</span>
<span class="nt">&lt;/resourceCopies&gt;</span>
<span class="c">&lt;!-- optional libraries to load in GameActivity.java before libUE4.so --&gt;</span>
<span class="nt">&lt;soLoadLibrary&gt;</span>
<span class="nt">&lt;log</span> <span class="na">text=</span><span class="s">&quot;ovrfmod APL adding loadLibrary references&quot;</span><span class="nt">/&gt;</span>
<span class="nt">&lt;loadLibrary</span> <span class="na">name=</span><span class="s">&quot;ovrfmod&quot;</span> <span class="na">failmsg=</span><span class="s">&quot;ovrfmod not loaded and required!&quot;</span> <span class="nt">/&gt;</span>
<span class="nt">&lt;/soLoadLibrary&gt;</span>
<span class="nt">&lt;/root&gt;</span>
</pre></div>
<p>You only need to write this if you want to load a DSP plugin on Android.</p>
<h2 id="tvos"><a href="#tvos">7.2 TVOS</a></h2>
<p>To build for TVOS, make sure FMODStudio is in your game's directory and not in the Engine plugins directory.</p>
<h2 id="linux"><a href="#linux">7.3 Linux</a></h2>
<p>To deploy on linux, you will need to rebuild the engine from source via github. For compiling linux from windows, see this <a href="https://wiki.unrealengine.com/Compiling_For_Linux">page</a> for instructions how to get up and running with UE4. Then, add in both the fmodstudio linux .zip and windows .zip on top of each other into the engine plugins directory.</p>
<p>The last thing you will need to do is to get the FMOD .so libraries into a directory that the executable can read them. The easiest way is to copy them from</p>
<div class="highlight language-text"><pre><span></span>&lt;DeployedDir&gt;\Engine\Plugins\FMODStudio\Binaries\Linux\x86_64
</pre></div>
<p>to</p>
<div class="highlight language-text"><pre><span></span>&lt;DeployedDir&gt;\&lt;GameName&gt;\Binaries\Linux
</pre></div>
<p>To see what directories the .so files can be located, look at LinuxToolChain.cs. Currently there are only a set of hard coded directories that are supported.</p>
<h2 id="xbox-one"><a href="#xbox-one">7.4 Xbox One</a></h2>
<h3 id="enabling-xboxone-microphone-input"><a href="#enabling-xboxone-microphone-input">7.4.1 Enabling XboxOne Microphone Input</a></h3>
<p>To enable FMOD Studio the use of any microphone input, including Kinect, on the Xbox One. The Engine ini file specific for the platform, located in '/Config/XboxOne/XboxOneEngine.ini', needs to have the following lines added:</p>
<div class="highlight language-xml"><pre><span></span>[AppxManifest]
Package.Capabilities.mx:Capability[0].Name=kinectAudio
Package.Capabilities.mx:Capability[1].Name=kinectGamechat
</pre></div>
<h3 id="copying-dlls-to-build"><a href="#copying-dlls-to-build">7.4.2 Copying dll's to build</a></h3>
<p>Add the following to GetFilesToDeployOrStage in XboxOnePlatform.Automation.cs, before the end of the function:</p>
<div class="highlight language-text"><pre><span></span>// FMOD code start
DirectoryReference FMODDLLPath = null;
if (Directory.Exists(Path.Combine(SC.ProjectRoot.ToString(), &quot;Plugins/FMODStudio&quot;)))
{
FMODDLLPath = DirectoryReference.Combine(SC.ProjectRoot, &quot;Plugins/FMODStudio/Binaries/XBoxOne/&quot;);
}
else if (Directory.Exists(Path.Combine(SC.LocalRoot.ToString(), &quot;Engine/Plugins/FMODStudio&quot;)))
{
FMODDLLPath = DirectoryReference.Combine(SC.LocalRoot, &quot;Engine/Plugins/FMODStudio/Binaries/XBoxOne/&quot;);
}
else
{
LogError(&quot;Failed to find FMODStudio plugin in game or engine directory&quot;);
}
if (FMODDLLPath != null)
{
Log.TraceInformation(&quot;Copying FMOD dlls to loose directory: &quot; + RelativeBinPath);
StagedDirectoryReference RelativeBinPathRef = new StagedDirectoryReference(RelativeBinPath);
StageFileIfExists(StagedFileType.NonUFS, FileReference.Combine(FMODDLLPath, &quot;fmod.dll&quot;), RelativeBinPathRef, SC);
StageFileIfExists(StagedFileType.NonUFS, FileReference.Combine(FMODDLLPath, &quot;fmodL.dll&quot;), RelativeBinPathRef, SC);
StageFileIfExists(StagedFileType.NonUFS, FileReference.Combine(FMODDLLPath, &quot;fmodstudio.dll&quot;), RelativeBinPathRef, SC);
StageFileIfExists(StagedFileType.NonUFS, FileReference.Combine(FMODDLLPath, &quot;fmodstudioL.dll&quot;), RelativeBinPathRef, SC);
}
// FMOD code end
</pre></div>
<p>Add the following to PrepTargetForDeployment in XboxOneDeploy.cs, in the same scope as 'DestDir':</p>
<div class="highlight language-text"><pre><span></span>// FMOD code start
string FMODDLLPath = null;
if (Directory.Exists(Path.Combine(ProjectDirectory.FullName, &quot;Plugins/FMODStudio&quot;)))
{
FMODDLLPath = Path.Combine(ProjectDirectory.FullName, &quot;Plugins/FMODStudio/Binaries/XBoxOne/&quot;);
}
else if (Directory.Exists(Path.Combine(RelativeEnginePath, &quot;Plugins/FMODStudio&quot;)))
{
FMODDLLPath = Path.Combine(RelativeEnginePath, &quot;Plugins/FMODStudio/Binaries/XBoxOne/&quot;);
}
else
{
Log.TraceWarning(&quot;Failed to find FMODStudio plugin in game or engine directory&quot;);
}
if (FMODDLLPath != null)
{
Log.TraceInformation(&quot;...copying the FMOD dlls...&quot;);
string FMODDLLName = &quot;fmod.dll&quot;;
Log.TraceInformation(&quot;\tcopying &quot; + FMODDLLPath + FMODDLLName + &quot; to &quot; + DestDir + &quot;/&quot; + FMODDLLName);
CopyFile(FMODDLLPath + FMODDLLName, DestDir + &quot;/&quot; + FMODDLLName, true);
FMODDLLName = &quot;fmodL.dll&quot;;
Log.TraceInformation(&quot;\tcopying &quot; + FMODDLLPath + FMODDLLName + &quot; to &quot; + DestDir + &quot;/&quot; + FMODDLLName);
CopyFile(FMODDLLPath + FMODDLLName, DestDir + &quot;/&quot; + FMODDLLName, true);
FMODDLLName = &quot;fmodstudio.dll&quot;;
Log.TraceInformation(&quot;\tcopying &quot; + FMODDLLPath + FMODDLLName + &quot; to &quot; + DestDir + &quot;/&quot; + FMODDLLName);
CopyFile(FMODDLLPath + FMODDLLName, DestDir + &quot;/&quot; + FMODDLLName, true);
FMODDLLName = &quot;fmodstudioL.dll&quot;;
Log.TraceInformation(&quot;\tcopying &quot; + FMODDLLPath + FMODDLLName + &quot; to &quot; + DestDir + &quot;/&quot; + FMODDLLName);
CopyFile(FMODDLLPath + FMODDLLName, DestDir + &quot;/&quot; + FMODDLLName, true);
}
// FMOD code end
</pre></div></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

53
Plugins/FMODStudio/Docs/plugins.html Normal file
View file

@ -0,0 +1,53 @@
<html>
<head>
<title>Plugins</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li class="manual-current-chapter manual-active-chapter"><a href="plugins.html">Plugins</a><ul>
<li><a href="#adding-plugins-to-the-project">Adding plugins to the project</a></li>
<li><a href="#deploying-fmod-plugins">Deploying FMOD plugins</a></li>
</ul>
</li>
<li><a href="api-reference.html">API Reference</a></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>4. Plugins</h1>
<p>FMOD Studio projects can be set up to use third party plugins. These can include custom DSP effects that are created in-house or commercial products that can be used with FMOD Studio.</p>
<h2 id="adding-plugins-to-the-project"><a href="#adding-plugins-to-the-project">4.1 Adding plugins to the project</a></h2>
<p>The plugins must be loaded at runtime so that they are there when loading the banks that need them. <a href="settings.html#plugin-files">Plugins</a> are set up in the project settings <a href="settings.html#advanced">Advanced</a> section.</p>
<p><img alt="Plugins" src="images/plugins.png" /></p>
<p>Each entry should be the filename of the plugin, without any extension. Any plugin files required should be added to the FMODStudio/Binaries/Platform/ directory.</p>
<p>For example, to use fmod_gain.dll on Win64 builds, you should add the file here:</p>
<div class="highlight language-text"><pre><span></span>FMODStudio/Binaries/Win64/fmod_gain.dll
</pre></div>
<h2 id="deploying-fmod-plugins"><a href="#deploying-fmod-plugins">4.2 Deploying FMOD plugins</a></h2>
<p>You will need to make sure the plugins are deployed as well. Unreal deployment doesn't have access to the settings information so you will need to create an extra file that lists the plugins you want to deploy.</p>
<p>Create a file "plugins.txt" in the FMODStudio/Binaries/Platform/ directory. The text file should contain the plugin names (just the name without file extension).</p>
<p>For example, to deploy fmod_gain.dll on Win64 builds, create a file FMODStudio/Binaries/Win64/plugins.txt with the following contents:</p>
<div class="highlight language-text"><pre><span></span>fmod_gain
</pre></div>
<p>Check the <a href="platform-specifics.html">Platform Specifics</a> for information relating to plugins on specific platforms.</p></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

94
Plugins/FMODStudio/Docs/scripts/language-selector.js Normal file
View file

@ -0,0 +1,94 @@
var languageTabs = null;
var languageSpecificElements = null;
var availableLanguages = null;
// Helper function to iterate over an HTMLCollection or NodeList (https://stackoverflow.com/questions/3871547/js-iterating-over-result-of-getelementsbyclassname-using-array-foreach)
function forEachElement(collection, func) {
Array.prototype.forEach.call(collection, func);
}
function matchLanguage(el, lang) {
if (lang == "language-all" || el.classList.contains("language-all")) {
return true;
} else if ((lang === "language-c" || lang === "language-cpp") && el.classList.contains("language-c-cpp")) {
return true;
} else {
return el.classList.contains(lang);
}
}
function setLanguage(lang) {
if (languageSpecificElements == null) {
return;
}
window.localStorage.setItem("FMOD.Documents.selected-language", lang);
if (availableLanguages.length > 0 && !availableLanguages.includes(lang)) {
lang = availableLanguages[0];
}
forEachElement(languageTabs, function(el) {
var ellang = el.attributes['data-language'].value;
if (ellang === lang) {
el.classList.add("selected");
} else {
el.classList.remove("selected");
}
});
forEachElement(languageSpecificElements, function(el) {
if (matchLanguage(el, lang)) {
el.style.display = 'block';
} else {
el.style.display = 'none';
}
});
window.localStorage.setItem("FMOD.Documents.selected-language", lang);
}
function init() {
var docsBody = document.querySelector("div.manual-content.api");
if (docsBody) {
// API docs
// Setup language tabs
languageTabs = docsBody.getElementsByClassName("language-tab");
forEachElement(languageTabs, function(el) {
el.onclick = function() { setLanguage(this.attributes['data-language'].value); }
});
// Cache language specific elements on the page
languageSpecificElements = docsBody.querySelectorAll(".language-c, .language-cpp, .language-c-cpp, .language-csharp, .language-javascript");
// Determine languages used on the page
availableLanguages = [];
["language-c", "language-cpp", "language-c-cpp", "language-csharp", "language-javascript"].forEach(function(lang) {
if (docsBody.querySelector("." + lang) != null) {
availableLanguages.push(lang);
}
});
// Set initial language
var lang = window.localStorage.getItem("FMOD.Documents.selected-language");
if (lang == null) {
lang = "language-cpp";
}
setLanguage(lang);
}
}
if (typeof module !== 'undefined') {
module.exports = { initLanguageSelector: init };
} else {
// Call our init function when the document is loaded. (https://plainjs.com/javascript/events/running-code-when-the-document-is-ready-15/)
if (document.readyState != 'loading') init();
else if (document.addEventListener) document.addEventListener('DOMContentLoaded', init);
else document.attachEvent('onreadystatechange', function() { if (document.readyState == 'complete') init(); });
}

110
Plugins/FMODStudio/Docs/settings.html Normal file
View file

@ -0,0 +1,110 @@
<html>
<head>
<title>Settings</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li class="manual-current-chapter manual-active-chapter"><a href="settings.html">Settings</a><ul>
<li><a href="#basic">Basic</a><ul>
<li><a href="#load-all-banks">Load All Banks</a></li>
<li><a href="#load-all-sample-data">Load All Sample Data</a></li>
<li><a href="#enable-live-update">Enable Live Update</a></li>
<li><a href="#enable-editor-live-update">Enable Editor Live Update</a></li>
<li><a href="#bank-output-directory">Bank Output Directory</a></li>
<li><a href="#output-format">Output Format</a></li>
</ul>
</li>
<li><a href="#init">Init</a><ul>
<li><a href="#vol-0-virtual">Vol 0 Virtual</a></li>
<li><a href="#vol-0-virtual-level">Vol 0 Virtual Level</a></li>
<li><a href="#sample-rate">Sample Rate</a></li>
<li><a href="#match-hardware-sample-rate">Match Hardware Sample Rate</a></li>
<li><a href="#real-channel-count">Real Channel Count</a></li>
<li><a href="#total-channel-count">Total Channel Count</a></li>
<li><a href="#dsp-buffer-length">DSP Buffer Length</a></li>
<li><a href="#dsp-buffer-count">DSP Buffer Count</a></li>
<li><a href="#file-buffer-size">File Buffer Size</a></li>
<li><a href="#studio-update-period">Studio Update Period</a></li>
<li><a href="#initial-output-driver-name">Initial Output Driver Name</a></li>
<li><a href="#lock-all-buses">Lock All Buses</a></li>
<li><a href="#memory-pool-sizes">Memory Pool Sizes</a></li>
</ul>
</li>
<li><a href="#advanced">Advanced</a><ul>
<li><a href="#live-update-port">Live Update Port</a></li>
<li><a href="#editor-live-update-port">Editor Live Update Port</a></li>
<li><a href="#plugin-files">Plugin Files</a></li>
<li><a href="#content-browser-prefix">Content Browser Prefix</a></li>
<li><a href="#force-platform-name">Force Platform Name</a></li>
<li><a href="#master-bank-name">Master Bank Name</a></li>
<li><a href="#skip-load-bank-name">Skip Load Bank Name</a></li>
<li><a href="#encryption-key">Encryption Key</a></li>
<li><a href="#wav-writer-path">Wav Writer Path</a></li>
<li><a href="#logging-level">Logging Level</a></li>
<li><a href="#occlusion-parameter">Occlusion Parameter</a></li>
<li><a href="#ambient-volume-parameter">Ambient Volume Parameter</a></li>
<li><a href="#ambient-lpf-parameter">Ambient LPF Parameter</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="plugins.html">Plugins</a></li>
<li><a href="api-reference.html">API Reference</a></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>3. Settings</h1>
<p>The FMOD UE4 Integration settings can be found in the UE4 Editor, under "Project Settings &gt; Plugins &gt; FMOD Studio".<br />
<img alt="Settings" src="images/project-settings.png" /></p>
<h2 id="basic"><a href="#basic">3.1 Basic</a></h2>
<h3 id="load-all-banks"><a href="#load-all-banks">3.1.1 Load All Banks</a></h3>
<h3 id="load-all-sample-data"><a href="#load-all-sample-data">3.1.2 Load All Sample Data</a></h3>
<h3 id="enable-live-update"><a href="#enable-live-update">3.1.3 Enable Live Update</a></h3>
<h3 id="enable-editor-live-update"><a href="#enable-editor-live-update">3.1.4 Enable Editor Live Update</a></h3>
<h3 id="bank-output-directory"><a href="#bank-output-directory">3.1.5 Bank Output Directory</a></h3>
<h3 id="output-format"><a href="#output-format">3.1.6 Output Format</a></h3>
<h2 id="init"><a href="#init">3.2 Init</a></h2>
<h3 id="vol-0-virtual"><a href="#vol-0-virtual">3.2.1 Vol 0 Virtual</a></h3>
<h3 id="vol-0-virtual-level"><a href="#vol-0-virtual-level">3.2.2 Vol 0 Virtual Level</a></h3>
<h3 id="sample-rate"><a href="#sample-rate">3.2.3 Sample Rate</a></h3>
<h3 id="match-hardware-sample-rate"><a href="#match-hardware-sample-rate">3.2.4 Match Hardware Sample Rate</a></h3>
<h3 id="real-channel-count"><a href="#real-channel-count">3.2.5 Real Channel Count</a></h3>
<h3 id="total-channel-count"><a href="#total-channel-count">3.2.6 Total Channel Count</a></h3>
<h3 id="dsp-buffer-length"><a href="#dsp-buffer-length">3.2.7 DSP Buffer Length</a></h3>
<h3 id="dsp-buffer-count"><a href="#dsp-buffer-count">3.2.8 DSP Buffer Count</a></h3>
<h3 id="file-buffer-size"><a href="#file-buffer-size">3.2.9 File Buffer Size</a></h3>
<h3 id="studio-update-period"><a href="#studio-update-period">3.2.10 Studio Update Period</a></h3>
<h3 id="initial-output-driver-name"><a href="#initial-output-driver-name">3.2.11 Initial Output Driver Name</a></h3>
<h3 id="lock-all-buses"><a href="#lock-all-buses">3.2.12 Lock All Buses</a></h3>
<h3 id="memory-pool-sizes"><a href="#memory-pool-sizes">3.2.13 Memory Pool Sizes</a></h3>
<h2 id="advanced"><a href="#advanced">3.3 Advanced</a></h2>
<h3 id="live-update-port"><a href="#live-update-port">3.3.1 Live Update Port</a></h3>
<h3 id="editor-live-update-port"><a href="#editor-live-update-port">3.3.2 Editor Live Update Port</a></h3>
<h3 id="plugin-files"><a href="#plugin-files">3.3.3 Plugin Files</a></h3>
<h3 id="content-browser-prefix"><a href="#content-browser-prefix">3.3.4 Content Browser Prefix</a></h3>
<h3 id="force-platform-name"><a href="#force-platform-name">3.3.5 Force Platform Name</a></h3>
<h3 id="master-bank-name"><a href="#master-bank-name">3.3.6 Master Bank Name</a></h3>
<h3 id="skip-load-bank-name"><a href="#skip-load-bank-name">3.3.7 Skip Load Bank Name</a></h3>
<h3 id="encryption-key"><a href="#encryption-key">3.3.8 Encryption Key</a></h3>
<h3 id="wav-writer-path"><a href="#wav-writer-path">3.3.9 Wav Writer Path</a></h3>
<h3 id="logging-level"><a href="#logging-level">3.3.10 Logging Level</a></h3>
<h3 id="occlusion-parameter"><a href="#occlusion-parameter">3.3.11 Occlusion Parameter</a></h3>
<h3 id="ambient-volume-parameter"><a href="#ambient-volume-parameter">3.3.12 Ambient Volume Parameter</a></h3>
<h3 id="ambient-lpf-parameter"><a href="#ambient-lpf-parameter">3.3.13 Ambient LPF Parameter</a></h3></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

BIN
Plugins/FMODStudio/Docs/style/DINWeb-Medium.woff Normal file
View file

Binary file not shown.

BIN
Plugins/FMODStudio/Docs/style/DINWeb.woff Normal file
View file

Binary file not shown.

69
Plugins/FMODStudio/Docs/style/code_highlight.css Normal file
View file

@ -0,0 +1,69 @@
.highlight .hll { background-color: #ffffcc }
.highlight { background: #f8f8f8; }
.highlight .c { color: #408080; font-style: italic } /* Comment */
.highlight .err { border: 1px solid #FF0000 } /* Error */
.highlight .k { color: #008000; font-weight: bold } /* Keyword */
.highlight .o { color: #666666 } /* Operator */
.highlight .ch { color: #408080; font-style: italic } /* Comment.Hashbang */
.highlight .cm { color: #408080; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #BC7A00 } /* Comment.Preproc */
.highlight .cpf { color: #408080; font-style: italic } /* Comment.PreprocFile */
.highlight .c1 { color: #408080; font-style: italic } /* Comment.Single */
.highlight .cs { color: #408080; font-style: italic } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.highlight .gt { color: #0044DD } /* Generic.Traceback */
.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008000 } /* Keyword.Pseudo */
.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #B00040 } /* Keyword.Type */
.highlight .m { color: #666666 } /* Literal.Number */
.highlight .s { color: #BA2121 } /* Literal.String */
.highlight .na { color: #7D9029 } /* Name.Attribute */
.highlight .nb { color: #008000 } /* Name.Builtin */
.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
.highlight .no { color: #880000 } /* Name.Constant */
.highlight .nd { color: #AA22FF } /* Name.Decorator */
.highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */
.highlight .ne { color: #D2413A; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0000FF } /* Name.Function */
.highlight .nl { color: #A0A000 } /* Name.Label */
.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #19177C } /* Name.Variable */
.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #666666 } /* Literal.Number.Bin */
.highlight .mf { color: #666666 } /* Literal.Number.Float */
.highlight .mh { color: #666666 } /* Literal.Number.Hex */
.highlight .mi { color: #666666 } /* Literal.Number.Integer */
.highlight .mo { color: #666666 } /* Literal.Number.Oct */
.highlight .sa { color: #BA2121 } /* Literal.String.Affix */
.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
.highlight .sc { color: #BA2121 } /* Literal.String.Char */
.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */
.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
.highlight .s2 { color: #BA2121 } /* Literal.String.Double */
.highlight .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */
.highlight .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
.highlight .sx { color: #008000 } /* Literal.String.Other */
.highlight .sr { color: #BB6688 } /* Literal.String.Regex */
.highlight .s1 { color: #BA2121 } /* Literal.String.Single */
.highlight .ss { color: #19177C } /* Literal.String.Symbol */
.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #0000FF } /* Name.Function.Magic */
.highlight .vc { color: #19177C } /* Name.Variable.Class */
.highlight .vg { color: #19177C } /* Name.Variable.Global */
.highlight .vi { color: #19177C } /* Name.Variable.Instance */
.highlight .vm { color: #19177C } /* Name.Variable.Magic */
.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */

265
Plugins/FMODStudio/Docs/style/docs.css Normal file
View file

@ -0,0 +1,265 @@
@font-face {
font-family:'DINWeb-Medium';
src:url('DINWeb-Medium.woff');
}
@font-face {
font-family:'DINWeb';
src:url('DINWeb.woff');
}
body {
background-color: black;
}
.docs-body {
font-family: DINWeb-Medium, -apple-system, sans-serif;
background-color: black;
padding: 24px;
}
.docs-body a {
color: #020eab;
text-decoration: none;
font-weight: bold;
}
.manual-content h1 a,
.manual-content h2 a,
.manual-content h3 a,
.manual-content h4 a,
.manual-content h5 a,
.manual-content h6 a {
color: black;
}
.docs-body img {
max-width: 100%;
box-shadow: 0px 4px 30px #333333;
margin: 20px;
}
.admonition {
border: 1px solid #b3b3b3;
border-top: 4px solid black;
background-color: #f1f1f1;
padding: 3px;
}
.admonition.warning {
border-top: 4px solid #cc0000;
}
.highlight {
border: 1px solid #b3b3b3;
background-color: #f1f1f1;
overflow: auto;
padding: 6px;
}
.highlight pre {
margin: 0;
}
code {
background-color: #eeeeee;
}
.manual-toc {
float: right;
display: inline-block;
width: 20%;
min-width: 300px;
margin: 0;
margin-left: 20px;
margin-bottom: 20px;
color: black;
background-color: #d6dceb;
font-weight: bold;
}
.manual-toc p {
color: black;
font-size: larger;
text-align: center;
}
.manual-toc > ul {
padding: 0px;
}
.manual-toc > ul > li {
padding: 12px;
list-style-position: inside;
}
.manual-toc ul { list-style-type: none; }
.manual-toc ul { counter-reset: toc-level-1; }
.manual-toc li { counter-increment: toc-level-1; }
.manual-toc li > a:before { content: counter(toc-level-1)". "; }
.manual-toc li ul { counter-reset: toc-level-2; }
.manual-toc li li { counter-increment: toc-level-2; }
.manual-toc li li a:before { content: counter(toc-level-1)"."counter(toc-level-2)" "; }
.manual-toc li li ul { counter-reset: toc-level-3; }
.manual-toc li li li { counter-increment: toc-level-3; }
.manual-toc li li li a:before { content: counter(toc-level-1)"."counter(toc-level-2)"."counter(toc-level-3)" "; }
.manual-inactive-chapter li ul { display: none; }
.manual-current-chapter {
background-color: white;
}
.manual-current-chapter ul {
padding-left: 20px;
}
.manual-active-chapter > a {
color: black;
}
.manual-current-chapter > ul { margin-top: 14px; }
.manual-current-chapter li { padding-top: 18px; font-size: 14px; }
.manual-current-chapter > ul > li:first-child { padding-top: 0px; }
.manual-current-chapter li > ul > li > ul {
display: none;
}
ul.subchapters { border-left: 2px dotted #b3b3b3; }
ul.subchapters li > a:before { content: ""; }
ul.subchapters .manual-active-chapter > a { border-bottom: 2px solid black; }
.manual-content {
background-color: white;
overflow: hidden;
padding: 20px 50px 40px;
min-width: 300px;
}
.manual-content li {
margin: 1em 0;
}
.manual-content h2 {
margin: 1.5em 0 1em 0;
}
.manual-content table {
margin-bottom: 1.5em;
width: 100%;
border-collapse: collapse;
display: block;
overflow-x: auto;
}
.manual-content th {
background-color: #d6dceb;
}
.manual-content th, .manual-content td {
border: 1px solid #b3b3b3;
padding: 12px;
text-align: left;
}
.manual-content.api dt {
font-style:italic;
margin-bottom: 1em;
}
/* Exclude token links (e.g. "Optional", "Output") - TODO: these need proper styling */
.manual-content.api dt a.token {
font-style:initial;
}
.manual-content.api dd {
margin-bottom: 2em;
}
.manual-content.api dd ul {
margin: 0;
padding: 0.75em 0 0.5em 1em;
font-family: DINWeb;
border: 1px solid #b3b3b3;
width:max-content;
}
.manual-content.api dd ul li {
margin: 0;
margin-right: 1em;
display: inline;
}
.manual-content.api dd ul li .label {
font-weight: bold;
}
.manual-content.api dd p {
margin: 0.25em;
}
.manual-footer {
color: white;
padding: 20px;
font-size: smaller;
}
div.language-selector {
display: -webkit-flex;
display: flex;
text-align: center;
}
div.language-tab {
-webkit-flex: 1;
-ms-flex: 1;
flex: 1;
border: 1px solid #bbbbbb;
border-top-left-radius: 6px;
border-top-right-radius: 6px;
box-sizing: content-box;
max-width: 30px;
padding: 2px 10px;
margin-right: -1px;
margin-bottom: -1px;
cursor: pointer;
}
.language-tab:hover {
background-color: #d6dceb;
}
.language-tab.selected {
background-color: #f1f1f1;
border-bottom-width: 0;
}
.language-tab.selected:after {
content: '';
width: 100%;
height: 3px;
bottom: -1px;
left: 0;
background: inherit;
}
div.language-selector + p {
display: none;
}
a.token, .token {
padding: 6px;
margin-left: 8px;
color: black;
font-size: small;
font-weight: normal;
border: 1px solid #bbbbbb;
border-radius: 6px;
}
a.token:hover {
background-color: #d6dceb;
}
[id]:target { animation:highlighter 3s }
@keyframes highlighter { 25% { background-color: gold; } 75% { background-color: gold; } }

63
Plugins/FMODStudio/Docs/troubleshooting.html Normal file
View file

@ -0,0 +1,63 @@
<html>
<head>
<title>Troubleshooting</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li><a href="api-reference.html">API Reference</a></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li class="manual-current-chapter manual-active-chapter"><a href="troubleshooting.html">Troubleshooting</a><ul>
<li><a href="#check-the-plugin-is-installed">Check the plugin is installed</a></li>
<li><a href="#project-output-format">Project Output Format</a></li>
<li><a href="#content-changes">Content Changes</a><ul>
<li><a href="#asset-paths">Asset Paths</a></li>
</ul>
</li>
<li><a href="#deployment-issues">Deployment Issues</a></li>
<li><a href="#live-update">Live Update</a></li>
<li><a href="#additional-logging">Additional Logging</a></li>
</ul>
</li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>8. Troubleshooting</h1>
<p>If you are experiencing an issue with the integration and none of the topics below help, visit to our <a href="https://qa.fmod.com/c/ue4">Q&amp;A Forum</a>.</p>
<h2 id="check-the-plugin-is-installed"><a href="#check-the-plugin-is-installed">8.1 Check the plugin is installed</a></h2>
<p>You should see a shortcut to the manual is available under the help menu, that means the plugin is in the right place and has been enabled.</p>
<p><img alt="UE4 Help Menu" src="images/docs-menu.png" /></p>
<p>If you see the FMOD Help in the manual, then the plugin installed correctly. If you don't see FMOD help, it isn't installed.</p>
<h2 id="project-output-format"><a href="#project-output-format">8.2 Project Output Format</a></h2>
<p>If you have modified the project output format in your FMOD Studio project, you will need to update your Unreal project settings to match. <br />
This can be found under "Edit &gt; Project Settings &gt; FMOD Studio &gt; Output Format". Keep in mind that this must match the Studio project settings in order for the mix to behave correctly.</p>
<h2 id="content-changes"><a href="#content-changes">8.3 Content Changes</a></h2>
<p>The editor does not mark FMOD assets as read-only, so there is nothing stopping the user from trying to rearrange the folder structure. <br />
However any such changes aren't going to change the underlying Studio project, so the changes will be lost next time Unreal is restarted.</p>
<h3 id="asset-paths"><a href="#asset-paths">8.3.1 Asset Paths</a></h3>
<p>The inbuilt Unreal asset serialization stores asset by full path, not by GUID. This means that if you rename events or folders in the Studio Tool, then any references in Unreal levels will be lost. For now the only workaround is to avoid renaming events or folders once you have started using them in levels.</p>
<h2 id="deployment-issues"><a href="#deployment-issues">8.4 Deployment Issues</a></h2>
<p>See the <a href="user-guide.html#deployment">Deployment</a> page for information about issues with deployment.</p>
<p>If you Launch your game and there is no sound playing or there is error loading the FMODStudio module, it an issue with Deployment.</p>
<h2 id="live-update"><a href="#live-update">8.5 Live Update</a></h2>
<p>If Live Update is enabled and the FMOD Studio will error when it fails to open the required network port. If this is a problem, then Live Update can be disabled in the Project Settings window.</p>
<h2 id="additional-logging"><a href="#additional-logging">8.6 Additional Logging</a></h2>
<p>To help track down problems, verbose logging can be turned on for the FMOD UE4 integration. Add the following command line to the UE4 editor:</p>
<div class="highlight language-text"><pre><span></span>-LogCmds=&quot;LogFMOD verbose&quot;
</pre></div></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

516
Plugins/FMODStudio/Docs/user-guide.html Normal file
View file

@ -0,0 +1,516 @@
<html>
<head>
<title>User Guide</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD UE4 Integration</a></li>
<li class="manual-current-chapter manual-active-chapter"><a href="user-guide.html">User Guide</a><ul>
<li><a href="#installing-the-integration">Installing the integration</a><ul>
<li><a href="#windows">Windows</a></li>
<li><a href="#mac">Mac</a></li>
</ul>
</li>
<li><a href="#updatingupgrading-the-integration">Updating/Upgrading the Integration</a></li>
<li><a href="#setting-up-your-project">Setting up your project</a><ul>
<li><a href="#automatically">Automatically</a></li>
<li><a href="#manually">Manually</a></li>
<li><a href="#confirm-the-banks-are-built-and-loaded">Confirm the Banks are Built and Loaded</a></li>
</ul>
</li>
<li><a href="#compiling-the-plugin-optional">Compiling the plugin (Optional)</a></li>
<li><a href="#programming-support">Programming Support</a><ul>
<li><a href="#programming-with-the-fmod-ue4-integration">Programming with the FMOD UE4 Integration</a></li>
<li><a href="#programming-with-the-fmod-studio-c-api">Programming with the FMOD Studio C++ API</a></li>
<li><a href="#further-programming-documentation">Further Programming Documentation</a></li>
</ul>
</li>
<li><a href="#making-sounds">Making sounds</a><ul>
<li><a href="#ambient-sounds">Ambient Sounds</a></li>
<li><a href="#playing-sounds-from-blueprint">Playing Sounds From Blueprint</a></li>
<li><a href="#other-avenues">Other avenues</a></li>
</ul>
</li>
<li><a href="#listener">Listener</a><ul>
<li><a href="#example">Example</a></li>
</ul>
</li>
<li><a href="#working-with-banks">Working with Banks</a><ul>
<li><a href="#studio-bank-output-directory">Studio Bank Output Directory</a></li>
<li><a href="#assigning-events-to-banks">Assigning Events to Banks</a></li>
<li><a href="#loading-banks-within-unreal">Loading Banks within Unreal</a><ul>
<li><a href="#in-editor">In Editor</a></li>
<li><a href="#in-game">In Game</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#sequencer-integration">Sequencer Integration</a><ul>
<li><a href="#adding-fmod-events-to-a-level-sequence">Adding FMOD Events to a Level Sequence</a></li>
<li><a href="#adding-event-sub-tracks">Adding Event Sub-Tracks</a></li>
<li><a href="#event-control-sub-track">Event Control Sub-Track</a></li>
<li><a href="#parameter-track">Parameter Track</a></li>
</ul>
</li>
<li><a href="#occlusion">Occlusion</a><ul>
<li><a href="#occlusion-settings">Occlusion Settings</a></li>
</ul>
</li>
<li><a href="#reverb-zones">Reverb Zones</a><ul>
<li><a href="#snapshot-reverb-effects">Snapshot Reverb Effects</a></li>
<li><a href="#ambient-zone-settings">Ambient Zone Settings</a></li>
</ul>
</li>
<li><a href="#callbacks">Callbacks</a></li>
<li><a href="#localization">Localization</a><ul>
<li><a href="#setting-up-audio-tables">Setting up Audio Tables</a></li>
<li><a href="#loading-localized-banks">Loading Localized Banks</a></li>
</ul>
</li>
<li><a href="#programmer-sounds">Programmer Sounds</a><ul>
<li><a href="#programmer-sounds-via-audio-tables">Programmer Sounds via Audio Tables</a><ul>
<li><a href="#choosing-the-audio-entry-to-play">Choosing the audio entry to play</a></li>
</ul>
</li>
<li><a href="#programmer-sounds-by-path">Programmer Sounds by Path</a></li>
<li><a href="#programmer-sounds-via-api">Programmer Sounds via API</a></li>
<li><a href="#troubleshooting">Troubleshooting</a></li>
</ul>
</li>
<li><a href="#deployment">Deployment</a><ul>
<li><a href="#packaging-banks">Packaging banks</a></li>
<li><a href="#bank-files-inside-content-directory">Bank Files Inside Content Directory</a></li>
<li><a href="#deploying-fmod-audio-plugins">Deploying FMOD audio plugins</a></li>
<li><a href="#loading-blueprints-before-plugin-load">Loading blueprints before plugin load</a></li>
<li><a href="#disabling-unreal-audio-device">Disabling Unreal Audio Device</a></li>
<li><a href="#enabling-live-update">Enabling Live Update</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li><a href="api-reference.html">API Reference</a></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>2. User Guide</h1>
<p>The FMOD UE4 Integration is a plugin that allows you to use the FMOD APIs and projects from the FMOD Studio authoring tool in your UE4 game.</p>
<p>Normally you will just need one copy of the integration. If you develop for multiple platforms at once, you can copy multiple integrations over the top of each other.</p>
<hr />
<h2 id="installing-the-integration"><a href="#installing-the-integration">2.1 Installing the integration</a></h2>
<p>The integration consists of a single FMODStudio folder which can be placed in either the <code>Engine/Plugins</code> directory or your UE4 game's Plugin directory <code>{ProjectName}/Plugins</code>. The next steps show how to install it into your Engine directory, so it will be available for all projects using UE4.</p>
<h3 id="windows"><a href="#windows">2.1.1 Windows</a></h3>
<p>Browse to your UE4 Engine folder and unzip FMODStudio into the plugins directory.</p>
<p><img alt="UE4 Engine Tree" src="images/engine-tree.png" /></p>
<h3 id="mac"><a href="#mac">2.1.2 Mac</a></h3>
<p>Use Finder to browse to your <code>/Users/Shared/UnrealEngine/4.X/Engine</code> directory and drop FMODStudio into the plugins directory.</p>
<p><img alt="UE4 Engine Tree OSX" src="images/engine-mac.png" /></p>
<p>If you have trouble getting the plugin working on a certain platform, then try putting FMODStudio in your game's Plugins directory instead of the engine.</p>
<p>Otherwise see the <a href="troubleshooting.html#check-the-plugin-is-installed">TroubleShooting</a> section.</p>
<hr />
<h2 id="updatingupgrading-the-integration"><a href="#updatingupgrading-the-integration">2.2 Updating/Upgrading the Integration</a></h2>
<p>Start by replacing the old FMODStudio folder with the new version:</p>
<ul>
<li>Delete the old FMODStudio folder then follow the same steps from <a href="user-guide.html#installing-the-integration">Installing the integration</a>.</li>
</ul>
<p>If you are updating to a newer <a href="glossary.html#version">minor version</a> of FMOD no additional steps are required unless specified in the <a href="https://fmod.com/resources/documentation-api?version=2.0&amp;page=welcome-revision-history.html">revision history</a>.</p>
<p>Upgrading to a newer <a href="glossary.html#version">major version</a> of FMOD is usually only recommend for projects at or near the beginning of development, because new major versions may introduce behavioral and breaking changes. If you are upgrading to a new major version, you will need to read over:</p>
<ul>
<li><a href="welcome.html">What's new in FMOD UE4 Integration...</a></li>
<li><a href="https://fmod.com/resources/documentation-api?version=2.0&amp;page=welcome.html">What's new in FMOD API...</a></li>
</ul>
<p>These will describe specific changes that might need to be made to your project.</p>
<h2 id="setting-up-your-project"><a href="#setting-up-your-project">2.3 Setting up your project</a></h2>
<p>There are settings in both UE4 and FMOD Studio that need to be configured to link the two together.</p>
<p>If you have any trouble setting up your project, use the automatic method. These settings can always be changed later.</p>
<h3 id="automatically"><a href="#automatically">2.3.1 Automatically</a></h3>
<p>You can run the "Help &gt; FMOD Validate" option in the UE4 Help menu. It finds and fixes common issues, and can automatically set up your FMOD Studio project for you!</p>
<p>It will check the following:</p>
<ul>
<li>You are running the right version of FMOD Studio</li>
<li>Your FMOD Studio bank export path is correct</li>
<li>Banks have been exported</li>
<li>Studio events have been added to the banks</li>
<li>Any plugins have been added to the plugin list</li>
<li>FMOD has been added to the packaging settings for deployment</li>
</ul>
<h3 id="manually"><a href="#manually">2.3.2 Manually</a></h3>
<p>From your FMOD Studio Project, select "Edit &gt; Preferences..." ("FMOD Studio &gt; Preferences..." on Mac) and select the build tab. Set your built banks output directory to a directory called "FMOD" under your game's content path.</p>
<p><img alt="Studio export path" src="images/studio-export-path.png" /></p>
<p>Now select "File &gt; Build". This will build bank files for events that have been assigned to banks. You should do this whenever project data has been modified.</p>
<h3 id="confirm-the-banks-are-built-and-loaded"><a href="#confirm-the-banks-are-built-and-loaded">2.3.3 Confirm the Banks are Built and Loaded</a></h3>
<p>Now, open UE4 and look at the content browser. The plug-in defaults to looking in <code>Content/FMOD</code> directory for banks, so if you have exported banks there, assets should appear in the content window automatically. These represent items in your Studio project which update automatically when banks are built.</p>
<p><img alt="Content browser" src="images/fmod-content.png" /></p>
<p>For more information about banks, see the <a href="user-guide.html#working-with-banks">Banks</a> page.</p>
<hr />
<h2 id="compiling-the-plugin-optional"><a href="#compiling-the-plugin-optional">2.4 Compiling the plugin (Optional)</a></h2>
<p>If you want to recompile the plugin, you can drop the plugin into a code project under your game's <code>Plugins/FMODStudio</code> directory, then re-generate the project. This might be useful if you want to use the plugin with a different version of the engine, such as a new pre-release of UE4. You can also do this if you want to get the plugin from github.</p>
<p>To recompile the plugin after downloading it from FMOD, do the following:</p>
<ul>
<li>Delete the <code>FMODStudio/Intermediate</code> directory.</li>
<li>Delete the <code>FMODStudio/Binaries/Platform/UE4*.*</code> files. Leave the fmod libraries in the binaries directory!</li>
<li>Create a new code project using UE4.</li>
<li>Copy the plugin into <code>YourGame/Plugins/FMODStudio</code>.</li>
<li>Regenerate the game's solution or xcode project.</li>
<li>Build the game for "Development Editor".</li>
<li>Build the game for whatever other configurations you need.</li>
</ul>
<p>To compile the plugin after downloading the source from github, do the following</p>
<ul>
<li>Add FMOD dynamic libraries into the <code>FMODStudio/Binaries/Platform/</code> directory. The libs can be obtained in the programmers API download or from the FMOD for UE4 download.</li>
<li>Create a new code project using UE4.</li>
<li>Copy the plugin into <code>YourGame/Plugins/FMODStudio</code>.</li>
<li>Regenerate the game's solution or XCode project.</li>
<li>Build the game for development editor.</li>
<li>Build the game for whatever other configurations you need.</li>
</ul>
<p>When rebuilding the plugin inside a code project, make sure you haven't also left it in the engine directory as well!</p>
<hr />
<h2 id="programming-support"><a href="#programming-support">2.5 Programming Support</a></h2>
<p>You are able to interface with the FMOD UE4 Integration and/or the FMOD C++ APIs.</p>
<h3 id="programming-with-the-fmod-ue4-integration"><a href="#programming-with-the-fmod-ue4-integration">2.5.1 Programming with the FMOD UE4 Integration</a></h3>
<p>To reference FMOD Studio, the programmer will need to add the following to their .Build.cs file:</p>
<ul>
<li>Add "FMODStudio" to <code>PrivateDependencyModuleNames</code></li>
</ul>
<p>To add some FMOD Events to a class, do the following:</p>
<ul>
<li>Include "FMODEvent.h" at the top of your own class</li>
<li>Add a <a href="api-reference-ufmodevent.html">UFMODEvent</a> * and mark with the <code>UPROPERTY</code> macro like any other field</li>
</ul>
<p>To play the event at a location, do the following:</p>
<ul>
<li>Include "FMODBlueprintStatics.h" in the file you want to trigger the sound</li>
<li>Call <a href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_playeventatlocation">UFMODBlueprintStatics::PlayEventAtLocation</a> with the following arguments:<ul>
<li>Set WorldContextObject to any UObject in the world, such as the owning actor object</li>
<li>Set Event to the UFMODEvent stored in the class or passed into your function</li>
<li>Set Transform to the place in the world you want to play the sound</li>
<li>Set bAutoPlay to true so that it starts the sound automatically</li>
</ul>
</li>
</ul>
<p>You can also call <a href="api-reference-ufmodblueprintstatics.html#ufmodblueprintstatics_playeventattached">UFMODBlueprintStatics::PlayEventAttached</a> to create a new audio component attached to an actor, which will update the location automatically as the actor moves around the world.</p>
<h3 id="programming-with-the-fmod-studio-c-api"><a href="#programming-with-the-fmod-studio-c-api">2.5.2 Programming with the FMOD Studio C++ API</a></h3>
<p>Programmers can interface with FMOD Studio directly by including "fmod_studio.hpp".</p>
<p>The Studio system can be obtained by <span class="dead-link" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_getstudiosystem">GetStudioSystem</span class="dead-link">. The function takes an enum because there may be a separate Studio system for auditioning in-editor and the proper system for play-in-editor. Normally, you will want to obtain the system with <span class="dead-link" href="api-reference-ifmodstudiomodule.html#efmodsystemcontext">EFMODSystemContext.Runtime</span class="dead-link"> since that is the real system used in game.</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">if</span> <span class="p">(</span><span class="n">IFMODStudioModule</span><span class="o">::</span><span class="n">IsAvailable</span><span class="p">())</span>
<span class="p">{</span>
<span class="n">FMOD</span><span class="o">::</span><span class="n">Studio</span><span class="o">::</span><span class="n">System</span><span class="o">*</span> <span class="n">StudioSystem</span> <span class="o">=</span> <span class="n">IFMODStudioModule</span><span class="o">::</span><span class="n">Get</span><span class="p">().</span><span class="n">GetStudioSystem</span><span class="p">(</span><span class="n">EFMODSystemContext</span><span class="o">::</span><span class="n">Runtime</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="n">StudioSystem</span><span class="p">)</span>
<span class="p">{</span>
<span class="c1">// Use it here</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
<p>You can use a mixture of FMOD Studio wrapper and FMOD Studio API functions. For example:</p>
<div class="highlight language-cpp"><pre><span></span><span class="c1">// Call wrapper helper function to create and start an event instance</span>
<span class="n">FFMODEventInstance</span> <span class="n">InstanceWrapper</span> <span class="o">=</span> <span class="n">UFMODBlueprintStatics</span><span class="o">::</span><span class="n">PlayEventAtLocation</span><span class="p">(</span><span class="n">ThisActor</span><span class="p">,</span> <span class="n">MyEvent</span><span class="p">,</span> <span class="n">FTransform</span><span class="p">(</span><span class="n">MyLocation</span><span class="p">),</span> <span class="nb">true</span><span class="p">);</span>
<span class="n">FMOD</span><span class="o">::</span><span class="n">Studio</span><span class="o">::</span><span class="n">EventInstance</span><span class="o">*</span> <span class="n">Instance</span> <span class="o">=</span> <span class="n">InstanceWrapper</span><span class="p">.</span><span class="n">Instance</span><span class="p">;</span>
<span class="c1">// Call into FMOD API directly</span>
<span class="n">Instance</span><span class="o">-&gt;</span><span class="n">setVolume</span><span class="p">(</span><span class="mf">0.5f</span><span class="p">);</span>
<span class="c1">// The instance handle will be cleaned up automatically when the sound finishes</span>
</pre></div>
<h3 id="further-programming-documentation"><a href="#further-programming-documentation">2.5.3 Further Programming Documentation</a></h3>
<p>For further documentation, see:<br />
- <a href="api-reference.html">Integration API Reference</a><br />
- <a href="https://fmod.com/resources/documentation-api?version=2.0&amp;page=welcome.html">FMOD API Reference</a>.</p>
<hr />
<h2 id="making-sounds"><a href="#making-sounds">2.6 Making sounds</a></h2>
<p>The FMOD UE4 integration provides multiple ways in which Studio events can be played.</p>
<h3 id="ambient-sounds"><a href="#ambient-sounds">2.6.1 Ambient Sounds</a></h3>
<p>The simplest way to play a looping ambience, is to drag and drop an event from the content browser into a scene viewport.</p>
<p><img alt="Drag sample" src="images/drag-ambient.png" /></p>
<p>For example, try dragging the <code>Game/FMOD/Events/Ambience/Forest</code> event into a level. This will create an <a href="api-reference-afmodambientsound.html">FMODAmbientSound</a>. Hit Play to begin playing in editor, and you should immediately hear the Forest ambience.</p>
<p>Make sure you drag an event into the main viewport. Dragging a bank into main viewport won't do anything.</p>
<h3 id="playing-sounds-from-blueprint"><a href="#playing-sounds-from-blueprint">2.6.2 Playing Sounds From Blueprint</a></h3>
<p>Another easy way to trigger a sound is via blueprint. You can use the play event at location function to quickly trigger any given event.</p>
<p><img alt="Blueprint Sample" src="images/blueprint-sample.png" /></p>
<p>In the example shown below, the Single_Explosion event is triggered at the location of the camera, every time the spacebar is pressed.</p>
<p><img alt="Blueprint simple playback" src="images/blueprint-play-simple.png" /></p>
<h3 id="other-avenues"><a href="#other-avenues">2.6.3 Other avenues</a></h3>
<p>Keep in mind that more advanced control is also available from blueprints. There are graph functions for playing and stopping events, setting parameters, and loading or unloading banks. You can also add <a href="api-reference-ufmodaudiocomponent.html">FMODAudioComponents</a> to blueprints, allowing you attach audio directly to an object.</p>
<hr />
<h2 id="listener"><a href="#listener">2.7 Listener</a></h2>
<p>FMOD can support up to 8 listeners in game. The <a href="api-reference-ffmodlistener.html">FMODListeners</a> will follow the UE4 listeners which by default is attached to the camera, but we can move them by moving the UE4 listeners.</p>
<p>This is particularly useful for Third-Person and Top-Down style games.</p>
<h3 id="example"><a href="#example">2.7.1 Example</a></h3>
<p>Using <a href="http://api.unrealengine.com/INT/BlueprintAPI/Game/Audio/SetAudioListenerOverride/index.html">SetAudioListenerOverride</a> allows you either attach the listener to a component or set the transform and rotation manually.</p>
<p><img alt="Listener Override" src="images/set-audio-listener-override.png" /></p>
<hr />
<h2 id="working-with-banks"><a href="#working-with-banks">2.8 Working with Banks</a></h2>
<p>Content created in FMOD Studio is exported into bank files. These bank files can then be loaded within Unreal using the FMOD UE4 integration. Banks can contain multiple events, which will implicitly pull in any audio assets they depend on.</p>
<p><img alt="Studio bank layout" src="images/studio-bank-layout.png" /></p>
<p>Loading a bank will load all metadata, which contains information about all the events, parameters, and other data needed for all events assigned to that bank.</p>
<h3 id="studio-bank-output-directory"><a href="#studio-bank-output-directory">2.8.1 Studio Bank Output Directory</a></h3>
<p>It is highly recommended that banks are exported to the Content directory of your project (see <a href="user-guide.html#deployment">Deployment</a> for more information). This can set via the built banks output directory setting in the FMOD Studio, which can be found in "Edit &gt; Preferences..." on Windows (or "FMOD Studio &gt; Preferences..." on Mac), under the Build tab.</p>
<p><img alt="Studio export path" src="images/studio-export-path.png" /></p>
<p>When using the UE4 editor, as long as you match the FMOD Studio built banks output directory to the bank output directory specified in the Unreal project settings ("Edit &gt; Project Settings &gt; FMOD Studio"), the integration will find and load all bank content automatically.</p>
<p><img alt="Project Settings" src="images/project-settings.png" /></p>
<h3 id="assigning-events-to-banks"><a href="#assigning-events-to-banks">2.8.2 Assigning Events to Banks</a></h3>
<p>Before a new FMOD Studio event can be used in Unreal, it must first be assigned and built to a bank which can be loaded by Unreal. This can be done within FMOD Studio via the context menu of an event, or by dragging and dropping an event onto a bank.</p>
<p><img alt="Assign events to banks" src="images/assign-to-bank.png" /></p>
<p>Events are typically assigned to the same bank when they should be loaded and unloaded at the same time. For example, you might put all the events for the Goblin enemy within the Goblin bank.</p>
<p>Once you have assigned your events to a bank, you should rebuild your banks. This is done via the "File &gt; Build..." menu item.</p>
<p><img alt="Build menu" src="images/build-menu.png" /></p>
<h3 id="loading-banks-within-unreal"><a href="#loading-banks-within-unreal">2.8.3 Loading Banks within Unreal</a></h3>
<p>The banks built in FMOD Studio are loaded in editor by the plugin, so that you can browse Events, Buses, Snapshots, etc. from the Studio Project. You are able to customize the way the banks are loaded in game, to suit your requirement, otherwise by default all the banks will be loaded at initialization.</p>
<h4 id="in-editor"><a href="#in-editor">In Editor</a></h4>
<p>Within the Unreal editor, banks are loaded automatically as soon they are built. When correctly configured, any data within banks (e.g. events, mixer strips) should appear within the content browser under <code>Game/FMOD</code> by default.</p>
<p><img alt="Content view" src="images/content-view.png" /></p>
<h4 id="in-game"><a href="#in-game">In Game</a></h4>
<p>The FMOD UE4 integration will load all banks by default. If you would like to manually control bank loading, this behavior can be disabled via the load all banks checkbox withing the FMOD Studio settings dialog ("Edit &gt; Project Settings &gt; FMOD Studio").</p>
<p>If using split banks, make sure to load the assets bank first and using load sample data on the metadata bank.</p>
<p>Banks can then manually be loaded and unloaded using the <code>Load Bank</code> and <code>Unload Bank</code> blueprint functions.</p>
<p><img alt="Banks blueprint" src="images/banks-blueprint.png" /></p>
<div class="admonition warning">
<p>The Master Bank does not need to be loaded manually. It is automatically loaded at startup.</p>
</div>
<hr />
<h2 id="sequencer-integration"><a href="#sequencer-integration">2.9 Sequencer Integration</a></h2>
<p>FMOD is integrated into Unreal Engine 4's Sequencer.</p>
<h3 id="adding-fmod-events-to-a-level-sequence"><a href="#adding-fmod-events-to-a-level-sequence">2.9.1 Adding FMOD Events to a Level Sequence</a></h3>
<p>Events can be added in one of two ways:</p>
<ol>
<li>
<p>Ambient sounds already placed in the level may be possessed by the level sequence. Add ambient sound actors to the sequence by clicking the <img alt="Add actor button" src="images/add-actor-button.png" /> button in the Sequencer editor and choosing the ambient sound actor to add. Alternatively the actor can be dragged from the World Outliner into the Sequencer editor.<br />
<img alt="Possess actor" src="images/possess-actor.png" /><br />
Possessed events will retain any state set by the level sequence when playback is complete. The level sequence's Restore State setting can be enabled to restore the state of possessed events (and any other actors possessed by the level sequence).</p>
</li>
<li>
<p>New events may be spawned from Sequencer. Sequencer can spawn FMOD events during playback. To create a spawned event drag an FMOD event from the Content Browser into the Sequencer editor.<br />
<img alt="Audio Table" src="images/audio-table.png" /><br />
Spawned events will not automatically play when spawned.</p>
</li>
</ol>
<h3 id="adding-event-sub-tracks"><a href="#adding-event-sub-tracks">2.9.2 Adding Event Sub-Tracks</a></h3>
<p>Once added to a sequence additional sub-tracks are required to do anything interesting. Sub-tracks can be added by clicking the <img alt="Add track button" src="images/add-track-button.png" /> button in the object's track. FMOD adds two new sub-track types for events in addition to the standard Sequencer sub-tracks.</p>
<ol>
<li>Event control tracks allow events to be played and stopped.</li>
<li>Parameter tracks allow event parameters to be animated using Sequencer's keyframe animation tools.</li>
</ol>
<p><img alt="Event tracks" src="images/event-tracks.png" /></p>
<h3 id="event-control-sub-track"><a href="#event-control-sub-track">2.9.3 Event Control Sub-Track</a></h3>
<p>Keyframes on the event control sub-track can be used to Play or Stop the event.</p>
<p><img alt="Control track" src="images/control-track.png" /></p>
<h3 id="parameter-track"><a href="#parameter-track">2.9.4 Parameter Track</a></h3>
<p>An FMOD Event Parameter Track allows additional sub-tracks to be added for each parameter in the targeted FMOD event. Additional sub-tracks can be added by clicking the <img alt="Add parameter button" src="images/add-parameter-button.png" /> button in the FMOD Event Parameter Track.</p>
<p><img alt="Parameter track" src="images/parameter-track.png" /></p>
<p>Keyframes may be added to the parameter sub-tracks to control the value of the event parameter during playback of the level sequence. The Unreal Engine 4 curve editor may be used to create rich curves for FMOD event parameters.</p>
<p><img alt="Parameter keyframe track" src="images/parameter-keyframe-curve.png" /></p>
<p>The FMOD UE4 integration is unable to validate the range of parameter values set by Sequencer. The FMOD Engine will clamp any parameter value outside the range specified in FMOD Studio.</p>
<hr />
<h2 id="occlusion"><a href="#occlusion">2.10 Occlusion</a></h2>
<p>The FMOD UE4 integration supports the use of ray casts, to drive a specified parameter, for per instance occlusion of sounds.</p>
<h3 id="occlusion-settings"><a href="#occlusion-settings">2.10.1 Occlusion Settings</a></h3>
<p>To enable occlusion ray casts for FMOD in your UE4 project, set the name of the parameter that will be used for occlusion in Studio.</p>
<p><img alt="Occlusion Settings" src="images/occlusion-setting.png" /></p>
<p>If an Event contains this parameter, the integration will set the parameter value any time the occlusion value changes.<br />
You can disable occlusion, per instance, and adjust the Trace Channel in the Component Details window.</p>
<p><img alt="Occlusion Settings" src="images/occlusion.png" /></p>
<hr />
<h2 id="reverb-zones"><a href="#reverb-zones">2.11 Reverb Zones</a></h2>
<p>The FMOD UE4 integration supports the use of the standard UE4 audio volumes to trigger Studio's advanced snapshot system.</p>
<h3 id="snapshot-reverb-effects"><a href="#snapshot-reverb-effects">2.11.1 Snapshot Reverb Effects</a></h3>
<p>The workflow to use reverb zones is to set up snapshots in FMOD Studio. Snapshots can modify global reverb effects, change any bus volume, and modify any DSP value. To help trigger snapshots for reverb effects, the integration exports all snapshots as reverb effects in the <code>FMOD/Reverbs</code> folder.</p>
<p><img alt="Reverb assets" src="images/reverb-assets.png" /></p>
<p>These reverb effects can be dragged into audio volume Reverb Settings panel to be triggered when the audio listener enters the audio zone. It uses the same logic as the inbuilt UE4 audio system to determine which audio volume should be enabled, based on the priority of the volume.</p>
<p><img alt="Reverb settings" src="images/reverb-settings.png" /></p>
<p>By default, snapshots apply instantly. To have a snapshot fade in, one of two things can be done. The first is by adding a AHDSR modulation to the intensity dial. The second way is to expose the intensity as a parameter, which allows it to be driven from the integration.</p>
<p><img alt="Reverb snapshot intensity" src="images/reverb-snapshot-intensity.png" /></p>
<p>If the snapshot has its intensity exposed as a parameter, then the integration will ramp in the intensity over time based on the audio volume's Volume and Fade Time settings. If the snapshot does not expose its intensity as a parameter, then these values will not do anything.</p>
<h3 id="ambient-zone-settings"><a href="#ambient-zone-settings">2.11.2 Ambient Zone Settings</a></h3>
<p>Another feature of the UE4 audio system is the ability to have an ambient effect applied to selected instances, based on both the listener position and the emitter position. Unlike the global reverb effects, this is something which is applied per instance.</p>
<p><img alt="Reverb ambient" src="images/reverb-ambient.png" /></p>
<p>Only some sounds should be affected by the ambient settings. To enable the ambient effect your Events will need two parameters, one for volume and one for LPF.<br />
You will need to add these parameter names to the integration settings.</p>
<p><img alt="Reverb user property" src="images/ambient-setting.png" /></p>
<p>If an Event contains these parameters, the integration will set the parameter value any time the ambient values change.</p>
<div class="admonition warning">
<p>Only FMOD audio components are affected by ambient zones. The simpler <code>PlayEventAtLocation</code> blueprint function to spawn one-shots does not apply ambient effects.</p>
</div>
<hr />
<h2 id="callbacks"><a href="#callbacks">2.12 Callbacks</a></h2>
<p>You can hook up event callbacks using blueprints. FMOD Audio component callbacks are only triggered if the enable callback option is ticked. This is because each component that triggers callbacks can incur a small CPU overhead, so it has to be turned on explicitly for the components you want to use.</p>
<p><img alt="Callback enable" src="images/callback-enable.png" /></p>
<p>Once enabled, then tempo beat callbacks and timeline callbacks can be added in blueprints. One way is via the <code>Assign On Timeline Beat</code> and <code>Assign On Timeline Marker</code> blueprint actions. For FMOD audio components used in blueprint actors, you can add events from the details window instead.</p>
<p><img alt="Callback blueprints" src="images/callback-bp.png" /></p>
<p>You can trigger various actions to occur on the beat or when a timeline hits a named marker. The event contains the same fields as <code>FMOD_STUDIO_TIMELINE_BEAT_PROPERTIES</code> and <code>FMOD_STUDIO_TIMELINE_MARKER_PROPERTIES</code>.</p>
<p><img alt="Callback example" src="images/callback-example.png" /></p>
<hr />
<h2 id="localization"><a href="#localization">2.13 Localization</a></h2>
<p>Localized audio tables are a special kind of audio table with features that facilitate localization. We recommend using localized audio tables if your game supports multiple spoken languages, or if you intend to add support for additional languages in a future patch.</p>
<h3 id="setting-up-audio-tables"><a href="#setting-up-audio-tables">2.13.1 Setting up Audio Tables</a></h3>
<p><a href="https://fmod.com/resources/documentation-api?version=2.0&amp;page=dialogue-and-localization.html#audio-tables">Audio Tables</a> are lists of audio files stored outside your FMOD Studio project's asset folder. You can use audio tables to control localized sounds. See the <a href="https://fmod.com/resources/documentation-studio?version=2.0&amp;page=dialogue-and-localization.html#localized-audio-tables">Dialogue and Localization</a> section of the <a href="https://fmod.com/resources/documentation-studio?version=2.0&amp;page=welcome-to-fmod-studio.html">FMOD Studio Docs</a> on how to set up an audio table in your project.</p>
<p><img alt="Audio Table" src="images/audio-table.png" /></p>
<h3 id="loading-localized-banks"><a href="#loading-localized-banks">2.13.2 Loading Localized Banks</a></h3>
<p>Audio tables are assigned to an associated bank, this means that in order to change the currently loaded audio table you will need to change the bank. Only one localized bank should be loaded at a time, otherwise just the first one to be loaded will be used.</p>
<p>You will need to define the different locale names and codes in the Localization Settings.</p>
<p><img alt="Localization Settings" src="images/settings-locale.png" /></p>
<p>Only the locale that is selected as default will have it's bank loaded at startup, if <a href="file:///D:/Source/release.2.0/docs/ue4/build/settings.html#load-all-banks">Load All Banks</a> has been enabled in the settings.</p>
<p>To change the locale, you will need to:</p>
<ul>
<li>unload the bank</li>
<li>change the locale</li>
<li>then reload the bank</li>
</ul>
<p><img alt="Load locale bank" src="images/unload-setlocale-load.png" /></p>
<hr />
<h2 id="programmer-sounds"><a href="#programmer-sounds">2.14 Programmer Sounds</a></h2>
<p>FMOD Studio events can include programmer sound modules that are controlled at runtime. There are a few different ways of hooking them up.</p>
<h3 id="programmer-sounds-via-audio-tables"><a href="#programmer-sounds-via-audio-tables">2.14.1 Programmer Sounds via Audio Tables</a></h3>
<p>With this approach, you don't need to do any programming at all!</p>
<h4 id="choosing-the-audio-entry-to-play"><a href="#choosing-the-audio-entry-to-play">Choosing the audio entry to play</a></h4>
<p>Create an event with a programmer sound module on it. If the module has a name, then if nothing else is assigned then that sound will be used. For example, if the sound designer sets the module name as "Welcome", then the audio table entry "Welcome" will be used by default.</p>
<p><img alt="Studio programmer sound" src="images/studio-programmer.png" /></p>
<p>To select at runtime what audio entry to use, set the programmer sound name field in the <a href="">FMODAudioComponent</a>.</p>
<p><img alt="Programmer asset name" src="images/programmer-asset-name.png" /></p>
<p>Or you can assign the name via blueprint.</p>
<p><img alt="Programmer blueprint" src="images/programmer-bp.png" /></p>
<p>The name has to be one of the audio asset entries of a loaded audio table, or it won't find the sound to play.</p>
<p>Be careful to set the name before you play the audio component. If the name is assigned after the event has started, it may not play the right sound.</p>
<h3 id="programmer-sounds-by-path"><a href="#programmer-sounds-by-path">2.14.2 Programmer Sounds by Path</a></h3>
<p>With this approach, you can easily play any media file for your event.</p>
<p>You can set up a programmer sound to point directly to a file. To do this, set the FMOD audio component's programmer sound name to the path to the .wav or .ogg file that you want to load. If this path is relative, it will be looked up relative to the content directory.</p>
<p><img alt="Programmer file path" src="images/programmer-file-path.png" /></p>
<p>If you do this, you'll need to make sure that directory with the media files is added to directories to package in the packaging settings, otherwise it will work in the editor, but not when packaged into the final game.</p>
<h3 id="programmer-sounds-via-api"><a href="#programmer-sounds-via-api">2.14.3 Programmer Sounds via API</a></h3>
<p>With this approach, you have the most flexibility for programmers.</p>
<p>If you are writing code, you can programmatically set the FMOD Sound to use by calling the FMOD audio component function <code>SetProgrammerSound</code>. Here is an example of setting the sound from code:</p>
<div class="highlight language-cpp"><pre><span></span><span class="kt">void</span> <span class="n">AExampleGameMode</span><span class="o">::</span><span class="n">InitAudio</span><span class="p">(</span><span class="n">UFMODAudioComponent</span><span class="o">*</span> <span class="n">AudioComponent</span><span class="p">)</span>
<span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="n">AudioComponent</span><span class="p">)</span>
<span class="p">{</span>
<span class="n">FMOD</span><span class="o">::</span><span class="n">Studio</span><span class="o">::</span><span class="n">System</span><span class="o">*</span> <span class="n">System</span> <span class="o">=</span> <span class="n">IFMODStudioModule</span><span class="o">::</span><span class="n">Get</span><span class="p">().</span><span class="n">GetStudioSystem</span><span class="p">(</span><span class="n">EFMODSystemContext</span><span class="o">::</span><span class="n">Runtime</span><span class="p">);</span>
<span class="n">FMOD</span><span class="o">::</span><span class="n">System</span><span class="o">*</span> <span class="n">CoreSystem</span> <span class="o">=</span> <span class="k">nullptr</span><span class="p">;</span>
<span class="n">System</span><span class="o">-&gt;</span><span class="n">getCoreSystem</span><span class="p">(</span><span class="o">&amp;</span><span class="n">CoreSystem</span><span class="p">);</span>
<span class="c1">// Create sound in memory</span>
<span class="k">static</span> <span class="k">const</span> <span class="kt">int</span> <span class="n">EXAMPLE_SOUND_LEN</span> <span class="o">=</span> <span class="mi">4096</span><span class="p">;</span>
<span class="kt">float</span> <span class="n">ExampleData</span><span class="p">[</span><span class="n">EXAMPLE_SOUND_LEN</span><span class="p">];</span>
<span class="k">for</span> <span class="p">(</span><span class="kt">int</span> <span class="n">i</span><span class="o">=</span><span class="mi">0</span><span class="p">;</span> <span class="n">i</span><span class="o">&lt;</span><span class="n">EXAMPLE_SOUND_LEN</span><span class="p">;</span> <span class="o">++</span><span class="n">i</span><span class="p">)</span>
<span class="p">{</span>
<span class="n">ExampleData</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="n">FMath</span><span class="o">::</span><span class="n">Sin</span><span class="p">((</span><span class="kt">float</span><span class="p">)</span><span class="n">i</span><span class="p">);</span>
<span class="p">}</span>
<span class="n">FMOD_CREATESOUNDEXINFO</span> <span class="n">SoundInfo</span> <span class="o">=</span> <span class="p">{</span><span class="mi">0</span><span class="p">};</span>
<span class="n">SoundInfo</span><span class="p">.</span><span class="n">cbsize</span> <span class="o">=</span> <span class="k">sizeof</span><span class="p">(</span><span class="n">SoundInfo</span><span class="p">);</span>
<span class="n">SoundInfo</span><span class="p">.</span><span class="n">format</span> <span class="o">=</span> <span class="n">FMOD_SOUND_FORMAT_PCMFLOAT</span><span class="p">;</span>
<span class="n">SoundInfo</span><span class="p">.</span><span class="n">defaultfrequency</span> <span class="o">=</span> <span class="mi">12000</span><span class="p">;</span>
<span class="n">SoundInfo</span><span class="p">.</span><span class="n">numchannels</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span>
<span class="n">SoundInfo</span><span class="p">.</span><span class="n">length</span> <span class="o">=</span> <span class="k">sizeof</span><span class="p">(</span><span class="kt">float</span><span class="p">)</span> <span class="o">*</span> <span class="n">EXAMPLE_SOUND_LEN</span><span class="p">;</span>
<span class="n">FMOD</span><span class="o">::</span><span class="n">Sound</span><span class="o">*</span> <span class="n">Sound</span> <span class="o">=</span> <span class="k">nullptr</span><span class="p">;</span>
<span class="k">if</span> <span class="p">(</span><span class="n">CoreSystem</span><span class="o">-&gt;</span><span class="n">createSound</span><span class="p">(</span><span class="k">reinterpret_cast</span><span class="o">&lt;</span><span class="k">const</span> <span class="kt">char</span><span class="o">*&gt;</span><span class="p">(</span><span class="n">ExampleData</span><span class="p">),</span> <span class="n">FMOD_OPENMEMORY</span> <span class="o">|</span> <span class="n">FMOD_OPENRAW</span> <span class="o">|</span> <span class="n">FMOD_LOOP_OFF</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">SoundInfo</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">Sound</span><span class="p">)</span> <span class="o">==</span> <span class="n">FMOD_OK</span><span class="p">)</span>
<span class="p">{</span>
<span class="n">AudioComponent</span><span class="o">-&gt;</span><span class="n">SetProgrammerSound</span><span class="p">(</span><span class="n">Sound</span><span class="p">);</span>
<span class="c1">// Note: Need to remember to release the sound *after* the audio component has finished using it.</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
<h3 id="troubleshooting"><a href="#troubleshooting">2.14.4 Troubleshooting</a></h3>
<p>Also, when setting the name to an audio table entry, you will need to make sure the audio table bank is already loaded before the event starts.</p>
<p>The FMOD audio component only supports a single programmer sound per event. If you want to have an event that has multiple programmer sounds, each one playing a different sound, then you'll need to create the event directly via the FMOD API and provide your own callback. You can look at how the FMOD audio component programmer sound callback works and use that as a base for your own class.</p>
<hr />
<h2 id="deployment"><a href="#deployment">2.15 Deployment</a></h2>
<p>These steps describe how to prepare your project for deployment. This is relevant to both the Launch option as well as the "File &gt; Package Project" menu item.<br />
If any platforms require specific steps, they can be found in <a href="platform-specifics.html">Platform Specifics</a>.</p>
<h3 id="packaging-banks"><a href="#packaging-banks">2.15.1 Packaging banks</a></h3>
<p>Banks need to be packaged and included in the game data. This can be done by selecting the "Edit &gt; Project Settings..." menu item. Navigating to the Packaging section from the left hand pane, under the game heading, presents you with options for specifying directories that include extra assets. There are two ways of doing this:</p>
<ul>
<li>Additional Non-Asset Directories to Package: Will copy banks inside the final package file.</li>
<li>Additional Non-Asset Directories to Copy: Will copy banks as loose files.</li>
</ul>
<p>We recommend using Directories to Package so that bank files are bundled into the package file automatically.</p>
<p><img alt="Project deployment" src="images/project-deploy.png" /></p>
<p>Each platform will look for its own type of banks in its own directory. Make sure you have added the platform to FMOD Studio project. The platforms are:</p>
<ul>
<li>Desktop (Windows, Mac, Linux)</li>
<li>PS4</li>
<li>XBox One</li>
<li>Switch</li>
<li>Mobile (Android, iOS, tvOS)</li>
</ul>
<p>If you only have the Desktop banks and want to run on another platform, you can set force platform name to Desktop in the FMOD advanced settings.</p>
<h3 id="bank-files-inside-content-directory"><a href="#bank-files-inside-content-directory">2.15.2 Bank Files Inside Content Directory</a></h3>
<p>The above directory name is relative to your Content directory. It is highly recommended that banks be placed within the content directory, as paths outside this directory will not deploy correctly to all platforms. For example:</p>
<ul>
<li>Mac doesn't allow support directories outside the content directory at all.</li>
<li>Windows and Android have issues looking up directories outside the Content directory when used with packages.</li>
</ul>
<p>This doesn't mean you need to put your whole Studio project inside the content directory. You can customize Studio by editing the Preferences and choosing a directory to export banks to, as described in the <a href="user-guide.html#working-with-banks">Working with Banks</a> page.</p>
<p>The integration will load the platform bank files automatically. On PC it will load from <code>FMOD/Desktop</code> but on Android and IOS it will look for banks under <code>FMOD/Mobile</code>.</p>
<p>If you use FMOD as the directory to deploy and have multiple platform banks exported, then they will all be packaged up. To slim down your final package size, you may need to tweak the additional directories setting on a per platform basis. That way you only package <code>FMOD/Mobile</code> for Android, <code>FMOD/Desktop</code> for PC, <code>FMOD/PS4</code> for PS4, etc.</p>
<h3 id="deploying-fmod-audio-plugins"><a href="#deploying-fmod-audio-plugins">2.15.3 Deploying FMOD audio plugins</a></h3>
<p>You will need to make sure the plugins are deployed as well. Unreal deployment doesn't access to the settings information so you will need to create an extra file that lists the plugins you want to deploy.</p>
<p>Create a file "plugins.txt" in the <code>FMODStudio/Binaries/Platform/</code> directory. The text file should contain the plugin names (just the name without file extension).</p>
<p>For example, to deploy fmod_gain.dll on Win64 builds, create a file <code>FMODStudio/Binaries/Win64/plugins.txt</code> with the following contents:</p>
<div class="highlight language-text"><pre><span></span>fmod_gain
</pre></div>
<h3 id="loading-blueprints-before-plugin-load"><a href="#loading-blueprints-before-plugin-load">2.15.4 Loading blueprints before plugin load</a></h3>
<p>One issue to be aware of is where blueprints are serialized from disk too early, before any plugins are loaded. This can occur from the following code, which is included by default in example C++ projects constructor:</p>
<div class="highlight language-cpp"><pre><span></span><span class="k">static</span> <span class="n">ConstructorHelpers</span><span class="o">::</span><span class="n">FClassFinder</span><span class="o">&lt;</span><span class="n">APawn</span><span class="o">&gt;</span> <span class="n">PlayerPawnClassFinder</span><span class="p">(</span><span class="n">TEXT</span><span class="p">(</span><span class="s">&quot;/Game/FirstPersonCPP/Blueprints/FirstPersonCharacter&quot;</span><span class="p">));</span>
</pre></div>
<p>The finder will serialize the first person character blueprint, but any FMOD references will fail to load since the FMOD plugin has not been created yet. To make sure that the FMOD plugin is loaded first, add the line of code above the class finder.</p>
<div class="highlight language-cpp"><pre><span></span><span class="n">IFMODStudioModule</span><span class="o">::</span><span class="n">Get</span><span class="p">();</span>
</pre></div>
<h3 id="disabling-unreal-audio-device"><a href="#disabling-unreal-audio-device">2.15.5 Disabling Unreal Audio Device</a></h3>
<p>By default FMOD Studio works side-by-side with the inbuilt Unreal audio device on the following platforms:</p>
<ul>
<li>Windows Desktop</li>
<li>Universal Windows Platform</li>
<li>Linux</li>
<li>MacOS</li>
<li>Android</li>
<li>PS4</li>
<li>Switch</li>
<li>Stadia</li>
</ul>
<p>Any of the platforms listed below will not work with the inbuilt Unreal audio:</p>
<ul>
<li>iOS / tvOS - Both UE4 and FMOD require exclusive control of the AudioSession to correctly handle interruptions.</li>
<li>Xbox One - Both UE4 and FMOD will attempt to consume all of the available XMA resources, this will cause the second system to fail initialization.</li>
</ul>
<p>To disable the Unreal audio while leaving the FMOD Studio audio, the standard Unreal ini file setting can be used.</p>
<p>For each required platform, add a new file <code>/Config/{Platform}/{Platform}Engine.ini</code> with this section:</p>
<div class="highlight language-xml"><pre><span></span>[Audio]
AudioDeviceModuleName=
AudioMixerModuleName=
</pre></div>
<p>The audio device can be disabled for every platform that you want to ship with.</p>
<h3 id="enabling-live-update"><a href="#enabling-live-update">2.15.6 Enabling Live Update</a></h3>
<p>The default permissions won't allow FMOD to set up a socket properly for live update. Uncheck the enable live update option in FMOD settings to avoid errors.</p>
<p>If you get a deployment error "resource.resw is in use by other process", go to the <code>YourGame/Config/DefaultGame.ini</code> and remove the following:</p>
<div class="highlight language-xml"><pre><span></span>-CulturesToStage=en
+CulturesToStage=en
</pre></div></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

70
Plugins/FMODStudio/Docs/welcome-whats-new-200.html Normal file
View file

@ -0,0 +1,70 @@
<html>
<head>
<title>Welcome to the FMOD UE4 Integration | New in FMOD UE4 Integration 2.00</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li class="manual-current-chapter manual-inactive-chapter"><a href="welcome.html">Welcome to the FMOD UE4 Integration</a><ul class="subchapters"><li class="manual-current-chapter manual-active-chapter"><a href="welcome-whats-new-200.html">New in FMOD UE4 Integration 2.00</a></li></ul></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li><a href="api-reference.html">API Reference</a></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>1. Welcome to the FMOD UE4 Integration | New in FMOD UE4 Integration 2.00</h1>
<div class="toc">
<ul>
<li><a href="#whats-new-in-200">What's new in 2.00?</a><ul>
<li><a href="#lowlevel-api-renamed-to-core-api">LowLevel API Renamed to Core API</a></li>
<li><a href="#global-parameters">Global Parameters</a></li>
<li><a href="#new-parameter-api">New Parameter API</a></li>
<li><a href="#sample-data-encryption">Sample Data Encryption</a></li>
<li><a href="#occlusion-ambient-changes">Occlusion &amp; Ambient Changes</a></li>
<li><a href="#master-bank-default-name-changed">Master Bank Default Name Changed</a></li>
</ul>
</li>
</ul>
</div>
<h2 id="whats-new-in-200"><a href="#whats-new-in-200">What's new in 2.00?</a></h2>
<p>This section describes the major features introduced in the 2.00 release. See the <a href="https://fmod.com/resources/documentation-api?version=2.0&amp;page=welcome-revision-history.html">Detailed Revision History</a> for information regarding each patch release.</p>
<h3 id="lowlevel-api-renamed-to-core-api"><a href="#lowlevel-api-renamed-to-core-api">LowLevel API Renamed to Core API</a></h3>
<p>The LowLevel API has been renamed to Core API:</p>
<ul>
<li><code>Studio::System::getLowLevelSystem</code> is now <a href="https://fmod.com/resources/documentation-api?version=2.0&amp;page=studio-api-system.html#studio_system_getcoresystem"><code>Studio::System::getCoreSystem</code></a></li>
</ul>
<h3 id="global-parameters"><a href="#global-parameters">Global Parameters</a></h3>
<p>The Studio API now supports global parameters. These parameters are controlled via the System parameter API and have a single value that is shared between all instances. See the <a href="https://fmod.com/resources/documentation-api?version=2.0&amp;page=welcome-whats-new-200.html#global-parameters">Global Parameters</a> chapter of the <a href="https://fmod.com/resources/documentation-api?version=2.0">FMOD API User Manual</a> for more information.</p>
<p>New blueprint nodes can be found for getting and setting Global Parameters:</p>
<p><img alt="GetGlobalParameterByName" src="images/getglobalparameter.png" /> <img alt="SetGlobalParameterByName" src="images/setglobalparameter.png" /></p>
<h3 id="new-parameter-api"><a href="#new-parameter-api">New Parameter API</a></h3>
<p>The Studio parameter API has been updated to support global parameters and provide a more robust fast path for setting parameter values frequently. There are a number of new, removed and renamed APIs, see the <a href="https://fmod.com/resources/documentation-api?version=2.0&amp;page=welcome-whats-new-200.html#new-parameter-api">FMOD API User Manual</a> for more information.</p>
<h3 id="sample-data-encryption"><a href="#sample-data-encryption">Sample Data Encryption</a></h3>
<p>Bank sample data can now be encrypted using FMOD Studio. This implementation is an extension of the Core API FSB encryption feature.</p>
<p>See the <a href="https://fmod.com/resources/documentation-api?version=2.0&amp;page=welcome-whats-new-200.html#sample-data-encryption">Sample Data Encryption</a> chapter of the <a href="https://fmod.com/resources/documentation-api?version=2.0">FMOD API User Manual</a> for more information.</p>
<p>To allow bank loading when used with the Studio API, set the key via <a href="https://fmod.com/resources/documentation-api?version=2.0&amp;page=studio-api-system.html#fmod_studio_advancedsettings"><code>FMOD_STUDIO_ADVANCEDSETTINGS::encryptionkey</code></a>. Then if some banks are unencrypted you can use the <a href="https://fmod.com/resources/documentation-api?version=2.0&amp;page=studio-api-system.html#fmod_studio_load_bank_flags"><code>FMOD_STUDIO_LOAD_BANK_UNENCRYPTED</code></a> load flag to ignore the given key.</p>
<p>The FMOD UE4 Integration settings now have an added field for bank loading, <a href="settings.html#encryption-key">Bank Encryption Key</a>, which will set the <code>FMOD_STUDIO_ADVANCEDSETTINGS::encryptionkey</code> for you.</p>
<p><img alt="Encryption Key" src="images/settings-encryption.png" /></p>
<h3 id="occlusion-ambient-changes"><a href="#occlusion-ambient-changes">Occlusion &amp; Ambient Changes</a></h3>
<p>The integration uses Parameters to pass <a href="file:///D:/Source/release.2.0/docs/ue4/build/user-guide.html#occlusion">Occlusion</a> &amp; <a href="file:///D:/Source/release.2.0/docs/ue4/build/user-guide.html#reverb-zones">Ambient</a> information to Studio. The Parameters can be specified in the FMOD UE4 Integration settings:<br />
- <a href="file:///D:/Source/release.2.0/docs/ue4/build/settings.html#occlusion-parameter">Occlusion Parameter</a><br />
- <a href="file:///D:/Source/release.2.0/docs/ue4/build/settings.html#ambient-volume-parameter">Ambient Volume Parameter</a><br />
- <a href="file:///D:/Source/release.2.0/docs/ue4/build/settings.html#ambient-lpf-parameter">Ambient LPF Parameter</a></p>
<h3 id="master-bank-default-name-changed"><a href="#master-bank-default-name-changed">Master Bank Default Name Changed</a></h3>
<p>The default Master Bank name has changed from "Master Bank.bank" to "Master.bank". If you are upgrading from an older version or you are using a different name, this will need to be updated in the <a href="file:///D:/Source/release.2.0/docs/ue4/build/settings.html#master-bank-name">Master Bank Name</a> field of the <a href="file:///D:/Source/release.2.0/docs/ue4/build/settings.html">FMOD UE4 Settings</a> so that the Integration can find it.</p>
<p><img alt="Master Bank Name" src="images/master-bank-name.png" /></p></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

53
Plugins/FMODStudio/Docs/welcome.html Normal file
View file

@ -0,0 +1,53 @@
<html>
<head>
<title>Welcome to the FMOD UE4 Integration</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>UE4 Integration 2.00</p>
<ul>
<li class="manual-current-chapter manual-active-chapter"><a href="welcome.html">Welcome to the FMOD UE4 Integration</a><ul class="subchapters"><li><a href="welcome-whats-new-200.html">New in FMOD UE4 Integration 2.00</a></li></ul></li>
<li><a href="user-guide.html">User Guide</a></li>
<li><a href="settings.html">Settings</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li><a href="api-reference.html">API Reference</a></li>
<li><a href="blueprint-reference.html">Blueprint Reference</a></li>
<li><a href="platform-specifics.html">Platform Specifics</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>1. Welcome to the FMOD UE4 Integration</h1>
<p>The FMOD UE4 Integration is a plugin that allows you to use the FMOD APIs and projects from FMOD Studio in your UE4 game.</p>
<h2 id="supported-ue4-versions"><a href="#supported-ue4-versions">1.1 Supported UE4 Versions</a></h2>
<p>The integration is compatible with public release versions UE4.20 and newer.</p>
<h2 id="supported-platforms"><a href="#supported-platforms">1.2 Supported platforms</a></h2>
<p>The integration supports:</p>
<ul>
<li>Windows Desktop</li>
<li>Universal Windows Platform</li>
<li>Linux</li>
<li>MacOS</li>
<li>iOS</li>
<li>tvOS</li>
<li>Android</li>
<li>PS4</li>
<li>XBox One</li>
<li>Switch</li>
<li>Stadia</li>
</ul>
<h2 id="licensing"><a href="#licensing">1.3 Licensing</a></h2>
<p>The integration itself is free, but you must have the appropriate FMOD License to release a title using FMOD Studio with UE4. For more information about licensing see the FMOD sales page.</p>
<h2 id="whats-new"><a href="#whats-new">1.4 What's New?</a></h2>
<p>This section describes the major changes introduced in each new release. See the <a href="https://fmod.com/resources/documentation-api?version=2.0&amp;page=welcome-revision-history.html">Detailed Revision History</a> for information regarding each patch release.</p><ul class="docs-body-subchapters"><li><a href="welcome-whats-new-200.html">New in FMOD UE4 Integration 2.00</a></li>
</ul></div>
<p class="manual-footer">UE4 Integration 2.00.10 (2020-07-14). &copy; 2020 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>

Some files were not shown because too many files have changed in this diff Show more