Version

menu_open
Wwise Unreal Integration Documentation
Spatial Audio Objects Blueprint Functions

AkGeometry Blueprint Functions

  • ConvertMesh: Convert the parent mesh to FAkGeometryData; a structure understandable for Spatial Audio Geometry. For a static mesh type, the indices and vertices of the parent mesh are used. For the simple collision mesh type, the parent's BodySetup is converted to FAkGeometryData. If the simple collision is made up of box, sphere or capsule primitives, a bounding box for each of the primitives is used. If the simple collision has convex hull primitives, its indices and vertices are used.
  • RemoveGeometry: Call AK:SpatialAudio::RemoveGeometry() to remove the geometry in Spatial Audio.
  • UpdateGeometry: Sends the components FAkGeometryData to Spatial Audio.

AkLateReverbComponent Blueprint Functions

  • AssociateAkTextureSetComponent: Set the component that will be used to estimate the HFDamping. For example, in a Blueprint that has a static mesh component with an AkGeometry child component, this function can be called in BeginPlay to associate that AkGeometry component with this reverb component. If this late reverb component has a sibling geometry component (or surface reflector set component), they will be associated automatically, and there is no need to call this function.

AkRoomComponent Blueprint Functions

  • GetPrimitiveParent: Returns the UPrimitiveComponent to which this Ak Room Component is attached.

AkPortalComponent Blueprint Functions

Several Wwise-specific actions can be executed on AkPortalComponent objects; these are available in the Ak Portal Component Category.

  • OpenPortal: Opens the Portal. Emitters positioned in the AkRoomComponent in front of and behind the Portal will emit through it.
  • ClosePortal: Closes the Portal. The Portal opening will act as an obstruction.
  • GetCurrentState: Returns an AkAcousticPortalState, which represents the state of the Portal: Open or Closed.
  • GetPrimitiveParent: Returns the UPrimitiveComponent to which this Ak Portal Component is attached.
  • PortalPlacementValid: Returns true if the portal position and orientation are valid. Portals have a front and a back room. They must have at least one room connected, and the front room must be different than the back room. See AkPortalComponent and AkRoomComponent for more information.

AkSurfaceReflectorSetComponent Blueprint Functions

  • SendSurfaceReflectorSet: Convert the brush's indices and vertices to Spatial Audio Geometry data and send it to Spatial Audio by calling AK:SpatialAudio::SetGeometry().
  • RemoveSurfaceReflectorSet: Call AK:SpatialAudio::RemoveGeometry() to remove the geometry in Spatial Audio.
  • UpdateSurfaceReflectorSet: Sends a new conversion of the brush to Spatial Audio by calling SendSurfaceReflectorSet.
See also

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