Table of Contents

AkPlatformInitSettings Struct Reference

List of all members.

Public Attributes

AkThreadProperties  threadLEngine
  Lower engine threading properties.
AkThreadProperties  threadBankManager
  Bank manager threading properties (its default priority is AK_THREAD_PRIORITY_NORMAL).
AkThreadProperties  threadMonitor
  Monitor threading properties (its default priority is AK_THREAD_PRIORITY_ABOVENORMAL). This parameter is not used in Release build.
AkUInt32  uLEngineDefaultPoolSize
  Lower engine default memory pool size.
AkReal32  fLEngineDefaultPoolRatioThreshold
  0.0f to 1.0f value: The percentage of occupied memory where the sound engine should enter in Low memory mode. Defining a Memory Threshold
AkUInt32  uSampleRate
  Sampling Rate. Set to 0 to get the native sample rate. Default value is 0.
AkUInt16  uNumRefillsInVoice
  Number of refill buffers in voice buffer. 2 == double-buffered, defaults to 4.
AkChannelMask  uChannelMask
  use AK_SPEAKER_SETUP_STEREO
SLObjectItf  pSLEngine
  OpenSL engine reference for sharing between various audio components.
JavaVM *  pJavaVM
  Active JavaVM for the app, used for internal system calls. Usually provided through the android_app structure given at startup or the NativeActivity.
jobject  jNativeActivity
AkAudioSessionProperties  audioSession
  iOS audio session properties
AkAudioCallbacks  audioCallbacks
  iOS audio callbacks
AkUInt32  uNumBlocks
  Number of audio port blocks (either CELL_AUDIO_BLOCK_8, CELL_AUDIO_BLOCK_16 or CELL_AUDIO_BLOCK_32).
AkUInt32  uNumEmptyBlocks
  Number of unused blocks in the sink. range between 1 and uNumBlocks. The higher the value, the lower the latency.
struct CellSpurs *  pSpurs
  Pointer to SPURS instance to use (if NULL, the Sound Engine will create and manage its own).
AkJobChainProperties  chainParams
  Parameters of the job chain.
bool  bBGMEnable
  Enable support for BGM auto-muting. This will cause the Sound Engine to take one Sysutil callback slot, specified below.
AkUInt32  uBGMSysutilCallbackSlot
  Sysutil callback slot (range 0-3) used for BGM auto-muting ONLY when bGMEnable==true.
AkUInt32  uLEngineAcpBatchBufferSize
  Lower Engine default memory pool size.
bool  bHwCodecLowLatencyMode
  Use low latency mode for ATRAC9 (default is false). If true, decoding jobs are submitted at the beginning of the Wwise update and it will be necessary to wait for the result.
AkUInt16  uLEngineDecodingRackSizeAt9Mono
  Format specific voice pool (VitaHW only). The total number of reserved voices should not exceede uLEngineDecodingMaxVoices, including voices required to instanciate hardware effects.
AkUInt16  uLEngineDecodingRackSizeAt9Stereo
  Format specific voice pool (VitaHW only). The total number of reserved voices should not exceede uLEngineDecodingMaxVoices, including voices required to instanciate hardware effects.
AkUInt16  uLEngineDecodingRackSizeVagMono
  Format specific voice pool (VitaHW only). The total number of reserved voices should not exceede uLEngineDecodingMaxVoices, including voices required to instanciate hardware effects.
AkUInt16  uLEngineDecodingRackSizeVagStereo
  Format specific voice pool (VitaHW only). The total number of reserved voices should not exceede uLEngineDecodingMaxVoices, including voices required to instanciate hardware effects.
AkUInt16  uLEngineDecodingMaxVoices
  Maximum number of hardware voices.
AkUInt16  uLEngineDecodingMaxRacks
  Maximum number of dsp units.
AXDRCVSModeType  uDRCMode
  AX_DRC_VS_OFF, AX_DRC_VS_ON_NORMAL or AX_DRC_VS_ON_FRONT_BYPASS.
HWND  hWnd
AkSoundQuality  eAudioQuality
  Quality of audio processing, default = AkSoundQuality_High.
bool  bGlobalFocus
IXAudio2 *  pXAudio2
  XAudio2 instance to use for the Wwise sound engine. If NULL (default) Wwise will initialize its own instance. Used only if the sink type is XAudio2 in AkInitSettings.eSinkType.
AkUInt32  idAudioDevice
AkUInt32  uShapeDefaultPoolSize
  SHAPE pool size. When 0 (default), the sound engine estimates the required pool size according to the maximum number of XMA voices (uMaxXMAVoices) below, assuming that sounds are stereo. Note that multichannel sounds take more memory than what this heuristic predicts, especially when they are streamed.
AkUInt16  uMaxXMAVoices
  Maximum number of hardware-accelerated XMA voices used at run-time. Default is 128 voices.

Detailed Description

Platform specific initialization settings

See also:
AK::SoundEngine::Init
AK::SoundEngine::GetDefaultPlatformInitSettings

Platform specific initialization settings

See also:
AK::SoundEngine::Init
AK::SoundEngine::GetDefaultPlatformInitSettings

Definition at line 45 of file Ak3DSSoundEngine.h.


The documentation for this struct was generated from the following files: