Version
menu_open
Wwise SDK 2023.1.8
Classes | Namespaces
AkQueryParameters.h File Reference
#include <AK/SoundEngine/Common/AkSoundEngineExport.h>
#include <AK/SoundEngine/Common/AkTypes.h>
#include <AK/SoundEngine/Common/AkCommonDefs.h>
#include <AK/Tools/Common/AkArray.h>

Go to the source code of this file.

Classes

struct  AkPositioningInfo
 Positioning information obtained from an object. More...
 
struct  AkObjectInfo
 Object information structure for QueryAudioObjectsIDs. More...
 
struct  AK::SoundEngine::Query::GameObjDst
 

Namespaces

namespace  AK
 Audiokinetic namespace.
 
 AK::SoundEngine
 
 AK::SoundEngine::Query
 

Functions

Game Objects
AKSOUNDENGINE_API AKRESULT AK::SoundEngine::Query::GetPosition (AkGameObjectID in_GameObjectID, AkSoundPosition &out_rPosition)
 
Listeners
AKSOUNDENGINE_API AKRESULT AK::SoundEngine::Query::GetListeners (AkGameObjectID in_GameObjectID, AkGameObjectID *out_ListenerObjectIDs, AkUInt32 &oi_uNumListeners)
 
AKSOUNDENGINE_API AKRESULT AK::SoundEngine::Query::GetListenerPosition (AkGameObjectID in_uListenerID, AkListenerPosition &out_rPosition)
 
AKSOUNDENGINE_API AKRESULT AK::SoundEngine::Query::GetListenerSpatialization (AkGameObjectID in_uListenerID, bool &out_rbSpatialized, AK::SpeakerVolumes::VectorPtr &out_pVolumeOffsets, AkChannelConfig &out_channelConfig)
 

Game Syncs

enum  AK::SoundEngine::Query::RTPCValue_type {
  AK::SoundEngine::Query::RTPCValue_Default, AK::SoundEngine::Query::RTPCValue_Global, AK::SoundEngine::Query::RTPCValue_GameObject, AK::SoundEngine::Query::RTPCValue_PlayingID,
  AK::SoundEngine::Query::RTPCValue_Unavailable
}
 
AKSOUNDENGINE_API AKRESULT AK::SoundEngine::Query::GetRTPCValue (AkRtpcID in_rtpcID, AkGameObjectID in_gameObjectID, AkPlayingID in_playingID, AkRtpcValue &out_rValue, RTPCValue_type &io_rValueType)
 
AKSOUNDENGINE_API AKRESULT AK::SoundEngine::Query::GetRTPCValue (const char *in_pszRtpcName, AkGameObjectID in_gameObjectID, AkPlayingID in_playingID, AkRtpcValue &out_rValue, RTPCValue_type &io_rValueType)
 
AKSOUNDENGINE_API AKRESULT AK::SoundEngine::Query::GetSwitch (AkSwitchGroupID in_switchGroup, AkGameObjectID in_gameObjectID, AkSwitchStateID &out_rSwitchState)
 
AKSOUNDENGINE_API AKRESULT AK::SoundEngine::Query::GetSwitch (const char *in_pstrSwitchGroupName, AkGameObjectID in_GameObj, AkSwitchStateID &out_rSwitchState)
 
AKSOUNDENGINE_API AKRESULT AK::SoundEngine::Query::GetState (AkStateGroupID in_stateGroup, AkStateID &out_rState)
 
AKSOUNDENGINE_API AKRESULT AK::SoundEngine::Query::GetState (const char *in_pstrStateGroupName, AkStateID &out_rState)
 

Environments

typedef AkArray< AkGameObjectID, AkGameObjectID > AK::SoundEngine::Query::AkGameObjectsList
 
typedef AkArray< GameObjDst, const GameObjDst & > AK::SoundEngine::Query::AkRadiusList
 
AKSOUNDENGINE_API AKRESULT AK::SoundEngine::Query::GetGameObjectAuxSendValues (AkGameObjectID in_gameObjectID, AkAuxSendValue *out_paAuxSendValues, AkUInt32 &io_ruNumSendValues)
 
AKSOUNDENGINE_API AKRESULT AK::SoundEngine::Query::GetGameObjectDryLevelValue (AkGameObjectID in_EmitterID, AkGameObjectID in_ListenerID, AkReal32 &out_rfControlValue)
 
AKSOUNDENGINE_API AKRESULT AK::SoundEngine::Query::GetObjectObstructionAndOcclusion (AkGameObjectID in_EmitterID, AkGameObjectID in_ListenerID, AkReal32 &out_rfObstructionLevel, AkReal32 &out_rfOcclusionLevel)
 
AKSOUNDENGINE_API AKRESULT AK::SoundEngine::Query::QueryAudioObjectIDs (AkUniqueID in_eventID, AkUInt32 &io_ruNumItems, AkObjectInfo *out_aObjectInfos)
 
AKSOUNDENGINE_API AKRESULT AK::SoundEngine::Query::QueryAudioObjectIDs (const char *in_pszEventName, AkUInt32 &io_ruNumItems, AkObjectInfo *out_aObjectInfos)
 
AKSOUNDENGINE_API AKRESULT AK::SoundEngine::Query::GetPositioningInfo (AkUniqueID in_ObjectID, AkPositioningInfo &out_rPositioningInfo)
 
AKSOUNDENGINE_API AKRESULT AK::SoundEngine::Query::GetActiveGameObjects (AkGameObjectsList &io_GameObjectList)
 
AKSOUNDENGINE_API bool AK::SoundEngine::Query::GetIsGameObjectActive (AkGameObjectID in_GameObjId)
 
AKSOUNDENGINE_API AKRESULT AK::SoundEngine::Query::GetMaxRadius (AkRadiusList &io_RadiusList)
 
AKSOUNDENGINE_API AkReal32 AK::SoundEngine::Query::GetMaxRadius (AkGameObjectID in_GameObjId)
 
AKSOUNDENGINE_API AkUniqueID AK::SoundEngine::Query::GetEventIDFromPlayingID (AkPlayingID in_playingID)
 
AKSOUNDENGINE_API AkGameObjectID AK::SoundEngine::Query::GetGameObjectFromPlayingID (AkPlayingID in_playingID)
 
AKSOUNDENGINE_API AKRESULT AK::SoundEngine::Query::GetPlayingIDsFromGameObject (AkGameObjectID in_GameObjId, AkUInt32 &io_ruNumIDs, AkPlayingID *out_aPlayingIDs)
 
AKSOUNDENGINE_API AKRESULT AK::SoundEngine::Query::GetCustomPropertyValue (AkUniqueID in_ObjectID, AkUInt32 in_uPropID, AkInt32 &out_iValue)
 
AKSOUNDENGINE_API AKRESULT AK::SoundEngine::Query::GetCustomPropertyValue (AkUniqueID in_ObjectID, AkUInt32 in_uPropID, AkReal32 &out_fValue)
 

Detailed Description

The sound engine parameter query interface.

Definition in file AkQueryParameters.h.

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