Table of Contents

AKRESULT __cdecl AK::SoundEngine::Init ( AkInitSettings in_pSettings,
AkPlatformInitSettings in_pPlatformSettings  
)

Initialize the sound engine.

Warning:
This function is not thread-safe.
Remarks:
The initial settings should be initialized using AK::SoundEngine::GetDefaultInitSettings() and AK::SoundEngine::GetDefaultPlatformInitSettings() to fill the structures with their default settings. This is not mandatory, but it helps avoid backward compatibility problems.
Returns:
  • AK_Success if the initialization was successful
  • AK_MemManagerNotInitialized if the memory manager is not available or not properly initialized
  • AK_StreamMgrNotInitialized if the stream manager is not available or not properly initialized
  • AK_SSEInstructionsNotSupported if the machine does not support SSE instruction (only on the PC)
  • AK_InsufficientMemory or AK_Fail if there is not enough memory available to initialize the sound engine properly
  • AK_InvalidParameter if some parameters are invalid
  • AK_Fail if the sound engine is already initialized, or if the provided settings result in insufficient resources for the initialization.
See also:
Parameters:
in_pSettings  Initialization settings (can be NULL, to use the default values)
in_pPlatformSettings  Platform-specific settings (can be NULL, to use the default values)