Wwise Version

Reporting Wwise Bugs

The Launcher provides a quick and effective way to report Wwise-related bugs to Audiokinetic: the Bug Reporter. We at Audiokinetic appreciate this feedback; however, while we will read all logged bugs and evaluate options to address them, we normally do not directly respond to them. If you wish to have help in resolving a bug, please contact Audiokinetic Support.

To open the Bug Reporter:

  • Select Report a Bug… from the Help menu.

    The Bug Reporter opens to the About You page.

You should then fill out each of the following Bug Reporter pages with the requested information. Feel free to move back and forth between Bug Reporter pages, using the Back and Next buttons at the bottom of the page, without fear of losing any entered information.

About You

  1. If you see the Log in button under "Your Info", you need to click it to log in to your account. Otherwise, you will not be able to specify your registered project or report an issue.

  2. Optionally, from the list of your registered projects, you can select the one for which you wish to report the issue.

  3. Click Next.

    You are brought to the Description page.

Description

  1. Enter a concise, encompassing Bug Summary.

    Ideally, it should be a simple present sentence of the form subject + verb + predicate. For example, "Wwise crashes when opening the Project Explorer." This is not the place to enter a list of details.

  2. From the Product list, select the Wwise-related product with the bug:

    • Wwise Authoring: The authoring application, including its use through WAAPI.

    • Wwise Runtime: The sound engine and anything related to its software development kit, including the running of a Wwise-integrated product.

    • Game Engine Integration: The Unity and Unreal plug-ins allowing the use of Wwise within these popular game engines.

    • Other: Any Wwise-related product from Audiokinetic that is not covered by the preceding options.

  3. From the Issue Type list, select the variety of bug that occurred:

    • Crash or Freeze: The product closes without reason or becomes unresponsive.

    • Malfunction: The product did not respond appropriately to your action. If you click a button, for example, and nothing happens, this could be a malfunction.

    • Performance: The processing and response speed is significantly sub-par. Please try to properly estimate how much time certain actions may take. If you have tens of thousands of source files to convert, for example, it is normal that it would take much longer than converting a few dozen files.

    • Other: Any bug that is not covered by the preceding options.

  4. From the Game Engine list (appears only if you have selected Wwise Runtime or Game Engine Integration for the Product), select the game engine you are using:

    • Unreal Engine: The popular game engine from Epic.

    • Unity: The popular game engine from Unity.

    • Other: Any game engine other than Unreal or Unity.

      [Note] Note

      If you select Other, it is important to specify more details about the game engine—such as its name, whether or not its internal to your organization, and its version—in the Steps To Reproduce.

  5. In the Engine Version field (appears only if you have selected Wwise Runtime or Game Engine Integration for the Product, and is active only if you have selected Unreal Engine or Unity from the Game Engine list), specify the version you are using.

  6. From the Unity/Unreal Engine Integration Version list (appears only if you have selected Unreal Engine or Unity from the Game Engine list), select the applicable version.

  7. From the Wwise/Launcher Version list, populated with all versions currently installed on your computer, select the version of the Wwise-related product with the bug.

    Selecting Other from the list prompts a new field, Specify Wwise Version, where you can type in a version which may not even be installed. If the selected product is the Launcher, its currently installed version will always appear automatically.

  8. In the SDK Platform group box (appears only if you have selected Wwise Runtime or Game Engine Integration for the Product), enable all applicable SDK platforms.

  9. In the Steps To Reproduce text block, specify a list of the steps to reproduce the issue.

  10. In the What Happens text block, specify the problematic result of the entered steps.

  11. In the Expected Behavior text block, specify the desired result of the entered steps.

  12. In the Workaround text block, please specify how the bug can be avoided, if possible.

  13. Click Next.

    [Note] Note

    If the Next button is inactive, verify that you have filled out all the required Description elements.

    You are brought to the Attach Files page.

Attach Files

  1. Enable each of the boxes for the data files you wish to send Audiokinetic, among the following:

    • Include Project Files: Adds most of your project's files, but does not include media files from your project's Originals folder or Profiler Session files.

      • Project Path: Allows the Bug Reporter to find project files, if you type in or use the browse button to navigate to the location of your project's WPROJ file.

      • Include a text file with information about media files: Includes an auto-generated file describing your project's media files.

      • Include Profiler Session Files: Includes any Profiler Session files, normally TXT or PROF files, found in your project.

    • Include Wwise Anonymous Analytics: Adds tab-delimited files of data—organized within folders by Wwise session—detailing performance metrics.

    • Include Wwise Logs: Adds tab-delimited files of data—organized within folders by Wwise session—detailing information, warnings, and errors recorded in the Wwise Logs view.

    • Include Machine Diagnostics: Adds a TXT file detailing your hardware.

    • Include Launcher Logs: Adds Wwise Launcher LOG files.

    [Tip] Tip

    Click the Open File Location icon , to the right of the above include options, to browse to the location from which the files will be included.

  2. Optionally, click the Add Attachment button to browse to other files of potential interest to Audiokinetic for this issue. You could, for example, include WAV and AMB files from your Originals folder. You might also wish to include a small animated GIF to show the problem you encounter.

  3. You must enable I accept logs and attached files may contain sensitive information to proceed.

    While we will keep these files confidential, and sending us more information normally improves our ability to properly address the issue, it is your responsibility to verify the files you have agreed to send to Audiokinetic.

  4. Click Submit.

    The send starts and you are brought to the Send Report page.

Send Report

  1. A small information box displays the status of the send.

    Depending on the size of the attached files and your Internet connection, it may take a few seconds or several minutes to complete the send.

  2. When the send is complete, the information box turns green and displays the title "Issue Successfully Submitted". It also indicates your issue number and lists all the submitted information.

    If the send is not successful, the information box turns red and displays the title "Failed. An error occurred during the process." It lists the steps that succeeded (indicated by a check mark) and the ones that failed.

    The provided error information can guide you on how to correct the situation. For example, maybe your Internet connection dropped momentarily. In such a case, click Retry. In other cases, you may first have to click Back to correct some of the previously entered information.