58 lines
5.3 KiB
HTML
58 lines
5.3 KiB
HTML
<html>
|
|
<head>
|
|
<title>Welcome to the FMOD Engine</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>FMOD Engine User Manual 2.03</p>
|
|
<ul>
|
|
<li class="manual-current-chapter manual-active-chapter"><a href="welcome.html">Welcome to the FMOD Engine</a><ul class="subchapters"><li><a href="welcome-whats-new-203.html">New in FMOD Engine 2.03</a></li><li><a href="welcome-whats-new-202.html">New in FMOD Engine 2.02</a></li><li><a href="welcome-whats-new-201.html">New in FMOD Engine 2.01</a></li><li><a href="welcome-whats-new-200.html">New in FMOD Engine 2.00</a></li><li><a href="welcome-whats-new-110.html">New in FMOD Engine 1.10</a></li><li><a href="welcome-revision-history.html">Detailed Revision History</a></li></ul></li>
|
|
<li><a href="core-api-concepts.html">Core API Key Concepts</a></li>
|
|
<li><a href="running-the-core-api.html">Core API Getting Started</a></li>
|
|
<li><a href="loading-and-playing-sounds-in-the-core-api.html">Core API Loading and Playing Sounds</a></li>
|
|
<li><a href="spatializing-sounds-in-the-core-api.html">Core API Spatializing Sounds</a></li>
|
|
<li><a href="mixing-and-routing-in-the-core-api.html">Core API Mixing and Routing</a></li>
|
|
<li><a href="using-dsp-effects-in-the-core-api.html">Core API Using DSP Effects</a></li>
|
|
<li><a href="effects-reference.html">Core API Effect Reference</a></li>
|
|
<li><a href="managing-resources-in-the-core-api.html">Core API Managing Resources</a></li>
|
|
<li><a href="advanced-core-api-topics.html">Core API Advanced Topics</a></li>
|
|
<li><a href="core-api.html">Core API Reference</a></li>
|
|
<li><a href="studio-api-getting-started.html">Studio API Getting Started</a></li>
|
|
<li><a href="studio-guide.html">Studio API Guide</a></li>
|
|
<li><a href="studio-api-3d-events.html">Studio API 3D Events</a></li>
|
|
<li><a href="studio-api-threads.html">Studio API Threads</a></li>
|
|
<li><a href="studio-api.html">Studio API Reference</a></li>
|
|
<li><a href="platforms.html">Platform Details</a></li>
|
|
<li><a href="dsp-plugin-api-guide.html">Plug-in DSP API Guide</a></li>
|
|
<li><a href="plugin-api.html">Plug-in API Reference</a></li>
|
|
<li><a href="fsbank-api.html">FSBank API Reference</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 Engine</h1>
|
|
<p>Welcome to the FMOD Engine User Manual. Here you will find information regarding the functionality and use of the FMOD Engine and all of its APIs.</p>
|
|
<p>If you want your team to design sound for your game using a user-friendly DAW-like interface, the best starting point is the <a href="studio-guide.html">Studio API guide</a> used alongside the <a href="studio-api.html">Studio API reference</a>. The <a href="glossary.html#studio-api">Studio API</a> plays back content created in <a href="glossary.html#fmod-studio">FMOD Studio</a>, our adaptive audio content creation tool. Studio's data-driven approach and rich graphical user interface make audio behaviors easily accessible and editable to sound designers.</p>
|
|
<p>If your project has custom requirements that go beyond what the Studio API offers, the <a href="glossary.html#core-api">Core API</a> provides fast and flexible access to low-level audio primitives. To learn more about the Core API, start with the <a href="core-api-concepts.html">Core API: Key Concepts</a> chapter, which introduces the fundamental concepts on which the FMOD Engine is built.</p>
|
|
<p>Whether you're developing with the Studio API or Core API, it's important to consider your target <span class="dead-link" href="glossary.html#platform">platform</span class="dead-link"> and any specific functionality, compatibility and requirements it may have. You can see this information in the <a href="platforms.html">platform details</a> chapter.</p>
|
|
<p>If you are a plug-in developer, read the <a href="plugin-api.html">Plug-in API Reference</a> for the particular type of plug-in you're interested in creating.</p>
|
|
<p>Additionally, to integrate the creation of compressed <a href="glossary.html#asset">assets</a> using the FSB file format into your tools and development pipelines, use the <a href="fsbank-api.html">FSBank API reference</a>.</p>
|
|
<p>If you have used the FMOD Engine before and are migrating to a newer major version of FMOD, make sure to check out the "New in FMOD Engine" sections below for information on new, changed and removed APIs.</p>
|
|
<p>For information on using any FMOD example code from this documentation in your own programs, please visit <a href="https://www.fmod.com/legal">https://www.fmod.com/legal</a>.</p><ul class="docs-body-subchapters"><li><a href="welcome-whats-new-203.html">New in FMOD Engine 2.03</a></li>
|
|
<li><a href="welcome-whats-new-202.html">New in FMOD Engine 2.02</a></li>
|
|
<li><a href="welcome-whats-new-201.html">New in FMOD Engine 2.01</a></li>
|
|
<li><a href="welcome-whats-new-200.html">New in FMOD Engine 2.00</a></li>
|
|
<li><a href="welcome-whats-new-110.html">New in FMOD Engine 1.10</a></li>
|
|
<li><a href="welcome-revision-history.html">Detailed Revision History</a></li>
|
|
</ul></div>
|
|
|
|
<p class="manual-footer">FMOD Engine User Manual 2.03.13 (2026-03-31). © 2026 Firelight Technologies Pty Ltd.</p>
|
|
</div>
|
|
</body>
|
|
</html>
|
|
|