Wwise Version
arrow_right Table of Contents
Wwise SDK 2021.1.5

#include <AkSpatialAudioTypes.h>

Inheritance diagram for AkRoomID:
AkSpatialAudioID

Public Member Functions

  AkRoomID ()
  Default constructor. Creates an invalid ID. More...
 
  AkRoomID (AkUInt64 _id)
  Construct from a 64-bit int. More...
 
  AkRoomID (const void *ptr)
  Conversion from a pointer to a AkRoomID. More...
 
AkGameObjectID  AsGameObjectID () const
  Conversion function used to convert AkRoomID's to AkGameObjectIDs. More...
 
- Public Member Functions inherited from AkSpatialAudioID
  AkSpatialAudioID ()
  Default constructor. Creates an invalid ID. More...
 
  AkSpatialAudioID (AkUInt64 _id)
  Construct from a 64-bit int. More...
 
  AkSpatialAudioID (const void *ptr)
  Conversion from a pointer to a AkSpatialAudioID. More...
 
bool  operator== (AkSpatialAudioID rhs) const
 
bool  operator!= (AkSpatialAudioID rhs) const
 
bool  operator< (AkSpatialAudioID rhs) const
 
bool  operator> (AkSpatialAudioID rhs) const
 
bool  operator<= (AkSpatialAudioID rhs) const
 
bool  operator>= (AkSpatialAudioID rhs) const
 
bool  IsValid () const
  Determine if this ID is valid. More...
 
AkGameObjectID  AsGameObjectID () const
  Conversion function used internally to convert from a AkSpatialAudioID to a AkGameObjectID. More...
 
  operator AkUInt64 ()
 

Static Public Member Functions

static AkRoomID  FromGameObjectID (AkGameObjectID in_fromGameObject)
  Conversion function used to convert to AkGameObjectIDs to AkRoomID. More...
 

Additional Inherited Members

- Public Attributes inherited from AkSpatialAudioID
AkUInt64  id
 

Detailed Description

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 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 represent rooms using AkRoomID's provided by the client; AkRoomID's are converted to AkGameObjectID's by calling AsGameObjectID().

See also

Definition at line 135 of file AkSpatialAudioTypes.h.