Wwise SDK 2019.1.11
_ak_spatial_audio_types_8h_source
Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2019.1.11.7296 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
link
Wwise SDK 2019.1.11
|
AkSpatialAudioTypes.h
74 typedef AkString<ArrayPoolSpatialAudio, wchar_t> WString; ///< Wide string type for use in Wwise Spatial Audio
75 typedef AkString<ArrayPoolSpatialAudio, AkOSChar> OsString; ///< OS string type for use in Wwise Spatial Audio
76 typedef AkString<ArrayPoolSpatialAudio, char> String; ///< String type for use in Wwise Spatial Audio
123 /// Spatial Audio Room ID type. This ID type exists in the same ID-space as game object ID's. The client is responsible for not choosing room ID's
124 /// that conflict with registered game objects' ID's. Internally, the spatial audio rooms and portals API manages registration and un-registration of game objects that
125 /// represent rooms using AkRoomID's provided by the client; AkRoomID's are convertied to AkGameObjectID's by calling AsGameObjectID().
131 /// A game object ID that is in the reserved range, used for 'outdoor' rooms, ie when not in a room.
144 AkGameObjectID AsGameObjectID() const { return IsValid() ? (AkGameObjectID)id : OutdoorsGameObjID; }
147 ///< Unique ID for portals. This ID type exists in the same ID-space as game object ID's. The client is responsible for not choosing portal ID's
148 /// that conflict with registered game objects' ID's. Internally, the spatial audio rooms and portals API manages registration and un-registration of game objects that
bool operator>(AkSpatialAudioID rhs) const
Definition: AkSpatialAudioTypes.h:108
Definition: AkArray.h:73
AkDbString< ArrayPoolSpatialAudio, char, CAkLock > DbString
Instanced string type.
Definition: AkSpatialAudioTypes.h:77
bool operator==(AkSpatialAudioID rhs) const
Definition: AkSpatialAudioTypes.h:105
bool operator!=(AkSpatialAudioID rhs) const
Definition: AkSpatialAudioTypes.h:106
AkString< ArrayPoolSpatialAudio, AkOSChar > OsString
OS string type for use in Wwise Spatial Audio.
Definition: AkSpatialAudioTypes.h:75
Definition: AkString.h:61
AkSpatialAudioID(const void *ptr)
Conversion from a pointer to a AkSpatialAudioID.
Definition: AkSpatialAudioTypes.h:103
AkString< ArrayPoolSpatialAudio, char > String
String type for use in Wwise Spatial Audio.
Definition: AkSpatialAudioTypes.h:76
AkGameObjectID AsGameObjectID() const
Conversion function used internally to convert AkRoomID's to AkGameObjectIDs.
Definition: AkSpatialAudioTypes.h:144
bool operator>=(AkSpatialAudioID rhs) const
Definition: AkSpatialAudioTypes.h:110
AkGameObjectID AsGameObjectID() const
Conversion function used internally to convert from a AkSpatialAudioID to a AkGameObjectID.
Definition: AkSpatialAudioTypes.h:116
Base type for ID's used by Wwise spatial audio.
Definition: AkSpatialAudioTypes.h:95
bool operator<(AkSpatialAudioID rhs) const
Definition: AkSpatialAudioTypes.h:107
AkRoomID(const void *ptr)
Conversion from a pointer to a AkRoomID.
Definition: AkSpatialAudioTypes.h:141
bool operator<=(AkSpatialAudioID rhs) const
Definition: AkSpatialAudioTypes.h:109
Definition: AkSpatialAudioTypes.h:130
static const AkGameObjectID OutdoorsGameObjID
A game object ID that is in the reserved range, used for 'outdoor' rooms, ie when not in a room.
Definition: AkSpatialAudioTypes.h:132
Definition: AkArray.h:49
Definition: AkString.h:264
AkString< ArrayPoolSpatialAudio, wchar_t > WString
Wide string type for use in Wwise Spatial Audio.
Definition: AkSpatialAudioTypes.h:74
Was this page helpful?
Need Support?
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageTell 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