Open 3D Engine LmbrCentral Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Protected Member Functions | Friends | List of all members
LmbrCentral::AudioListenerComponent Class Reference

#include <AudioListenerComponent.h>

Inherits AZ::Component, AZ::TransformNotificationBus::MultiHandler, AZ::EntityBus::MultiHandler, and AudioListenerComponentRequestBus::Handler.

Public Member Functions

 AZ_COMPONENT (AudioListenerComponent, "{00B5358C-3EEE-4012-93FC-6222B0004404}")
 
void Activate () override
 
void Deactivate () override
 
void SetRotationEntity (const AZ::EntityId entityId) override
 
void SetPositionEntity (const AZ::EntityId entityId) override
 
void SetListenerEnabled (bool enabled) override
 
void OnTransformChanged (const AZ::Transform &, const AZ::Transform &) override
 
void OnEntityActivated (const AZ::EntityId &) override
 
void OnEntityDeactivated (const AZ::EntityId &) override
 

Static Protected Member Functions

static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &required)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incompatible)
 
static void Reflect (AZ::ReflectContext *context)
 

Friends

class EditorAudioListenerComponent
 

Detailed Description

AudioListenerComponent A component wrapper for an Audio Listener, which acts as a sink for audio sources. There is only 1 AudioListenerComponent allowed on an Entity, and they are typically paired with a Camera for orientation and position information.

Ideally we'd like the ability to "split" the listener position. That is, to route different positions to different calculations. For example, in a third-person-view game we'd like to have panning be based off the camera's location, but have attenuation curves be based off the player's location. This feature is not yet available in Wwise middleware, but it is on their roadmap (WG-21449).

Member Function Documentation

◆ AZ_COMPONENT()

LmbrCentral::AudioListenerComponent::AZ_COMPONENT ( AudioListenerComponent  ,
"{00B5358C-3EEE-4012-93FC-6222B0004404}"   
)

AZ::Component

◆ OnEntityActivated()

void LmbrCentral::AudioListenerComponent::OnEntityActivated ( const AZ::EntityId &  )
override

AZ::EntityBus::Handler

◆ OnTransformChanged()

void LmbrCentral::AudioListenerComponent::OnTransformChanged ( const AZ::Transform &  ,
const AZ::Transform &   
)
override

AZ::TransformNotificationBus::MultiHandler

◆ SetRotationEntity()

void LmbrCentral::AudioListenerComponent::SetRotationEntity ( const AZ::EntityId  entityId)
override

AudioListenerRequestBus::Handler Required Interface

The documentation for this class was generated from the following file: