Version
menu

Wwise SDK 2025.1.0
AkEnums.h File Reference

Go to the source code of this file.

Macros

#define AKCURVEINTERPOLATION_NUM_STORAGE_BIT   5
 Internal storage restriction, for internal use only. More...
 
#define AK_PANNER_NUM_STORAGE_BITS   3
 
#define AK_POSSOURCE_NUM_STORAGE_BITS   3
 
#define AK_SPAT_NUM_STORAGE_BITS   3
 
#define AK_MAX_BITS_METERING_FLAGS   (5)
 

Typedefs

typedef AkUInt32 AKRESULT_t
 
typedef AkUInt8 AkGroupType_t
 
typedef AkUInt8 AkAudioDeviceState_t
 
typedef AkUInt8 AkConnectionType_t
 
typedef AkUInt8 AkAttenuationCurveType_t
 
typedef AkUInt8 AkCurveInterpolation_t
 
typedef AkUInt8 AkBankTypeEnum_t
 
typedef AkUInt8 AkSpeakerPanningType_t
 
typedef AkUInt8 Ak3DPositionType_t
 
typedef AkUInt8 AkPanningRule_t
 
typedef AkUInt8 Ak3DSpatializationMode_t
 
typedef AkUInt8 AkMeteringFlags_t
 
typedef AkUInt8 AkPluginType_t
 
typedef AkUInt8 AkNodeType_t
 
typedef AkUInt8 AkMultiPositionType_t
 
typedef AkUInt8 AkSetPositionFlags_t
 
typedef AkUInt8 AkListenerOp_t
 
typedef AkUInt8 AkActionOnEventType_t
 
typedef AkUInt8 AkDynamicSequenceType_t
 
typedef AkUInt8 AkDynamicSequenceOp_t
 

Enumerations

enum  AKRESULT {
  AK_NotImplemented = 0, AK_Success = 1, AK_Fail = 2, AK_PartialSuccess = 3,
  AK_NotCompatible = 4, AK_AlreadyConnected = 5, AK_InvalidFile = 7, AK_AudioFileHeaderTooLarge = 8,
  AK_MaxReached = 9, AK_InvalidID = 14, AK_IDNotFound = 15, AK_InvalidInstanceID = 16,
  AK_NoMoreData = 17, AK_InvalidStateGroup = 20, AK_ChildAlreadyHasAParent = 21, AK_InvalidLanguage = 22,
  AK_CannotAddItselfAsAChild = 23, AK_InvalidParameter = 31, AK_ElementAlreadyInList = 35, AK_PathNotFound = 36,
  AK_PathNoVertices = 37, AK_PathNotRunning = 38, AK_PathNotPaused = 39, AK_PathNodeAlreadyInList = 40,
  AK_PathNodeNotInList = 41, AK_DataNeeded = 43, AK_NoDataNeeded = 44, AK_DataReady = 45,
  AK_NoDataReady = 46, AK_InsufficientMemory = 52, AK_Cancelled = 53, AK_UnknownBankID = 54,
  AK_BankReadError = 56, AK_InvalidSwitchType = 57, AK_FormatNotReady = 63, AK_WrongBankVersion = 64,
  AK_FileNotFound = 66, AK_DeviceNotReady = 67, AK_BankAlreadyLoaded = 69, AK_RenderedFX = 71,
  AK_ProcessNeeded = 72, AK_ProcessDone = 73, AK_MemManagerNotInitialized = 74, AK_StreamMgrNotInitialized = 75,
  AK_SSEInstructionsNotSupported = 76, AK_Busy = 77, AK_UnsupportedChannelConfig = 78, AK_PluginMediaNotAvailable = 79,
  AK_MustBeVirtualized = 80, AK_CommandTooLarge = 81, AK_RejectedByFilter = 82, AK_InvalidCustomPlatformName = 83,
  AK_DLLCannotLoad = 84, AK_DLLPathNotFound = 85, AK_NoJavaVM = 86, AK_OpenSLError = 87,
  AK_PluginNotRegistered = 88, AK_DataAlignmentError = 89, AK_DeviceNotCompatible = 90, AK_DuplicateUniqueID = 91,
  AK_InitBankNotLoaded = 92, AK_DeviceNotFound = 93, AK_PlayingIDNotFound = 94, AK_InvalidFloatValue = 95,
  AK_FileFormatMismatch = 96, AK_NoDistinctListener = 97, AK_ResourceInUse = 99, AK_InvalidBankType = 100,
  AK_AlreadyInitialized = 101, AK_NotInitialized = 102, AK_FilePermissionError = 103, AK_UnknownFileError = 104,
  AK_TooManyConcurrentOperations = 105, AK_InvalidFileSize = 106, AK_Deferred = 107, AK_FilePathTooLong = 108,
  AK_InvalidState = 109, AKRESULT_Last
}
 
enum  AkGroupType { AkGroupType_Switch = 0, AkGroupType_State = 1 }
 Game sync group type. More...
 
enum  AkAudioDeviceState {
  AkDeviceState_Unknown = 0, AkDeviceState_Active = 1 << 0, AkDeviceState_Disabled = 1 << 1, AkDeviceState_NotPresent = 1 << 2,
  AkDeviceState_Unplugged = 1 << 3, AkDeviceState_Last, AkDeviceState_All = AkDeviceState_Active | AkDeviceState_Disabled | AkDeviceState_NotPresent | AkDeviceState_Unplugged
}
 
enum  AkConnectionType {
  ConnectionType_Direct = 0x0, ConnectionType_GameDefSend = 0x1, ConnectionType_UserDefSend = 0x2, ConnectionType_ReflectionsSend = 0x3,
  ConnectionType_Last
}
 Nature of the connection binding an input to a bus. More...
 
enum  AkAttenuationCurveType {
  AttenuationCurveID_VolumeDry = 0, AttenuationCurveID_VolumeAuxGameDef, AttenuationCurveID_VolumeAuxUserDef, AttenuationCurveID_LowPassFilter,
  AttenuationCurveID_HighPassFilter, AttenuationCurveID_HighShelf, AttenuationCurveID_Spread, AttenuationCurveID_Focus,
  AttenuationCurveID_ObstructionVolume, AttenuationCurveID_ObstructionLPF, AttenuationCurveID_ObstructionHPF, AttenuationCurveID_ObstructionHSF,
  AttenuationCurveID_OcclusionVolume, AttenuationCurveID_OcclusionLPF, AttenuationCurveID_OcclusionHPF, AttenuationCurveID_OcclusionHSF,
  AttenuationCurveID_DiffractionVolume, AttenuationCurveID_DiffractionLPF, AttenuationCurveID_DiffractionHPF, AttenuationCurveID_DiffractionHSF,
  AttenuationCurveID_TransmissionVolume, AttenuationCurveID_TransmissionLPF, AttenuationCurveID_TransmissionHPF, AttenuationCurveID_TransmissionHSF,
  AttenuationCurveID_MaxCount, AttenuationCurveID_Project = 254, AttenuationCurveID_None = 255
}
 Curve types of the Attenuation Editor. More...
 
enum  AkCurveInterpolation {
  AkCurveInterpolation_Log3 = 0, AkCurveInterpolation_Sine = 1, AkCurveInterpolation_Log1 = 2, AkCurveInterpolation_InvSCurve = 3,
  AkCurveInterpolation_Linear = 4, AkCurveInterpolation_SCurve = 5, AkCurveInterpolation_Exp1 = 6, AkCurveInterpolation_SineRecip = 7,
  AkCurveInterpolation_Exp3 = 8, AkCurveInterpolation_LastFadeCurve = 8, AkCurveInterpolation_Constant = 9, AkCurveInterpolation_Last
}
 Curve interpolation types. More...
 
enum  AkBankTypeEnum { AkBankType_User = AKCODECID_BANK, AkBankType_Event = AKCODECID_BANK_EVENT, AkBankType_Bus = AKCODECID_BANK_BUS, AkBankType_Last }
 Bank types. More...
 
enum  AkSpeakerPanningType { AK_DirectSpeakerAssignment = 0, AK_BalanceFadeHeight = 1, AK_SteeringPanner = 2, AkSpeakerPanning_Last }
 Speaker panning type: type of panning logic when object is not 3D spatialized (i.e. when Ak3DSpatializationMode is AK_SpatializationMode_None). More...
 
enum  Ak3DPositionType { AK_3DPositionType_Emitter = 0, AK_3DPositionType_EmitterWithAutomation = 1, AK_3DPositionType_ListenerWithAutomation = 2, AK_3DPositionType_Last }
 3D position type: defines what acts as the emitter position for computing spatialization against the listener. Used when Ak3DSpatializationMode is AK_SpatializationMode_PositionOnly or AK_SpatializationMode_PositionAndOrientation. More...
 
enum  AkPanningRule { AkPanningRule_Speakers = 0, AkPanningRule_Headphones = 1, AkPanningRule_Last }
 Headphone / speakers panning rules. More...
 
enum  Ak3DSpatializationMode { AK_SpatializationMode_None = 0, AK_SpatializationMode_PositionOnly = 1, AK_SpatializationMode_PositionAndOrientation = 2, AK_SpatializationMode_Last }
 3D spatialization mode. More...
 
enum  AkMeteringFlags {
  AK_NoMetering = 0, AK_EnableBusMeter_Peak = 1 << 0, AK_EnableBusMeter_TruePeak = 1 << 1, AK_EnableBusMeter_RMS = 1 << 2,
  AK_EnableBusMeter_KPower = 1 << 4, AK_EnableBusMeter_3DMeter = 1 << 5, AK_EnableBusMeter_Last
}
 Metering flags. Used for specifying bus metering, through AK::SoundEngine::RegisterBusVolumeCallback() or AK::IAkMixerPluginContext::SetMeteringFlags(). More...
 
enum  AkPluginType {
  AkPluginTypeNone = 0, AkPluginTypeCodec = 1, AkPluginTypeSource = 2, AkPluginTypeEffect = 3,
  AkPluginTypeMixer = 6, AkPluginTypeSink = 7, AkPluginTypeGlobalExtension = 8, AkPluginTypeMetadata = 9,
  AkPluginType_Last, AkPluginTypeMask = 0xf
}
 
enum  AkNodeType { AkNodeType_Default, AkNodeType_Bus, AkNodeType_Last }
 
enum  AkMultiPositionType { AkMultiPositionType_SingleSource, AkMultiPositionType_MultiSources, AkMultiPositionType_MultiDirections, AkMultiPositionType_Last }
 
enum  AkSetPositionFlags { AkSetPositionFlags_Emitter = 1 << 0, AkSetPositionFlags_Listener = 1 << 1, AkSetPositionFlags_Default = (AkSetPositionFlags_Emitter | AkSetPositionFlags_Listener) }
 Flags to independently set the position of the emitter or listener component on a game object. More...
 
enum  AkListenerOp { AkListenerOp_Set, AkListenerOp_Add, AkListenerOp_Remove }
 
enum  AkActionOnEventType {
  AkActionOnEventType_Stop = 0, AkActionOnEventType_Pause = 1, AkActionOnEventType_Resume = 2, AkActionOnEventType_Break = 3,
  AkActionOnEventType_ReleaseEnvelope = 4, AkActionOnEventType_Last
}
 
enum  AkDynamicSequenceType { AkDynamicSequenceType_SampleAccurate, AkDynamicSequenceType_NormalTransition, AkDynamicSequenceType_Last }
 
enum  AkDynamicSequenceOp {
  AkDynamicSequenceOp_Play, AkDynamicSequenceOp_Pause, AkDynamicSequenceOp_Resume, AkDynamicSequenceOp_Stop,
  AkDynamicSequenceOp_Break, AkDynamicSequenceOp_Close, AkDynamicSequenceOp_Last
}
 
enum  AkChannelConfigType {
  AK_ChannelConfigType_Anonymous = 0x0, AK_ChannelConfigType_Standard = 0x1, AK_ChannelConfigType_Ambisonic = 0x2, AK_ChannelConfigType_Objects = 0x3,
  AK_ChannelConfigType_Last, AK_ChannelConfigType_UseDeviceMain = 0xE, AK_ChannelConfigType_UseDevicePassthrough = 0xF
}
 Channel configuration type. More...
 

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise