Table of Contents

Directory Structure

Here is a short description of the various folders that compose this SDK:

  • SDK
    Main SDK folder. Note that the Wwise SDK installer creates an environment variable named WWISESDK that points to this folder. It can be used in scripts or C++ projects instead of hardcoding the path to include files, libraries, and so on. Refer to SDK Input Libraries and Distributed Binaries and Include Files for more information.
    • include
      Main include files folder.
      • AK
        Audiokinetic include files.
        • Comm
          Communication-related include files.
        • DSP
          .
          • Generic
            .
        • MusicEngine
          • Common
            Interactive Music-related include files common to all platforms.
        • Plugin
          Plug-in header files (plug-in IDs and factory functions, used when registering them).
          • PluginServices
            Helpers used by sample plug-ins.
        • SoundEngine
          Main sound engine header files.
          • Common
            Sound engine header files that are common to all platforms.
          • Platforms
            Platform-specific sound engine header files.
            • Generic
              .
        • SoundFrame
          SoundFrame header files.
        • SpatialAudio
          Spatial Audio header files.
          • Common
            Spatial Audio header files that are common to all platforms.
        • Tools
          Header files for various helper functions and types.
        • Wwise
          Header files used by Wwise Authoring Application plug-ins.
          • SourceControl
            Interfaces used or implemented by Wwise Authoring Application source control plug-ins.
        • WwiseAuthoringAPI
          Refer to Using the Wwise Authoring API (WAAPI) for more information.
    • samples
      Sample code. Refer to Samples for details.
      • Common
        Files shared between several samples.
      • DSP
        .
      • DynamicLibraries
        .
        • AkSoundEngineDLL
      • IntegrationDemo
        Sound engine integration demo. Refer to Integration Demo Sample for more information.
        • Common
          Common code for the Integration Demo sample.
        • WwiseProject
          Wwise project for the Integration Demo sample, including SoundBanks in the GeneratedSoundBanks subfolder.
      • Motion
        Motion-related sample code.
      • Plugins
        Sample plug-ins. Refer to Sample Source Plug-ins and Sample Effect Plug-in for more details.
        • AkAudioInput
          Audio input source plug-in. Refer to Audio Input Source Plug-in for details about this sample plug-in, and Audio Plug-ins for information about creating your own source plug-ins.
          • Sources
            • AudioEngineFX
              Source code for the sound engine plug-in library.
            • WwisePlugin
              Source code and help file for the Authoring Application plug-in DLL.
        • AkDelay
          Delay sample effect plug-in. Refer to Audio Plug-ins for information about creating your own effect plug-ins.
          • Sources
            • AudioEngineFX
              Source code for the sound engine plug-in library.
            • WwisePlugin
              Source code and help file for the Authoring Application plug-in DLL.
        • AkSineTone
          Sine sample source plug-in. Refer to Audio Plug-ins for information about creating your own source plug-ins.
          • Sources
            • AudioEngineFX
              Source code for the sound engine plug-in library.
            • WwisePlugin
              Source code and help file for the Authoring Application plug-in DLL.
        • AkSink
          • Sources
            • AudioEngineFX
              Source code for the sound engine plug-in library.
            • WwisePlugin
              Source code and help file for the Authoring Application plug-in DLL.
        • AkToneGenerator
          Tone Generator sample source plug-in. Refer to Audio Plug-ins for information about creating your own source plug-ins.
          • Sources
            • AudioEngineFX
              Source code for the sound engine plug-in library.
            • WwisePlugin
              Source code and help file for the Authoring Application plug-in DLL.
      • SoundEngine
      • SoundFrame
        SoundFrame samples. Refer to SoundFrame Sample Code (deprecated) for more information.
      • SourceControl
        Source Control sample plug-ins. Refer to Source Control Sample Code for more information.
      • Tools
        Sample tools.
        • Common
          Code shared by several sample tools.
        • FilePackager
          Refer to Managing File Packages for more information.
      • WwiseAuthoringAPI
        Refer to Using the Wwise Authoring API (WAAPI) for more information.
    • source
      • Build
      • StreamManager
        Source code for the default Streaming Manager implementation. Can be used to debug or customize streaming. Refer to Streaming / Stream Manager for more information.

SDK Input Libraries and Distributed Binaries

The input libraries required to integrate the Wwise Sound Engine are available for each build configuration in their respective platform folders contained in the root of the SDK installation directory. The library directory structure is defined as follows:

  • {Wwise SDK Dir}/{Platform name}/{Configuration name}/lib where
    • {Wwise SDK Dir} is the SDK installation directory
    • {Platform name} is one of the available platform names (x64, Mac, iOS, ...). A suffix may further refine the CPU architecture or compiler targeted.
    • {Configuration name} is one of the three build configurations (Debug, Profile, Release).

For example, Profile libraries for the Windows platform using Visual Studio 2015 can be found in {Wwise SDK Dir}\x64_vc140\Profile\lib.

Refer to Build Configuration for a description of the various libraries contained in this SDK.

Tip.gif
Tip: The SDK installer creates an environment variable named WWISESDK that points to the SDK's installation folder. You can use this environment variable in scripts and C++ projects to refer to include, library or binary directories from the SDK. Refer to Source and Effect Plug-ins for more details. Note: WWISESDK variable is not set on the MAC.