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 Types | Public Member Functions | Static Public Member Functions | List of all members
LmbrCentral::AudioPreloadComponent Class Reference

#include <AudioPreloadComponent.h>

Inherits AZ::Component, AudioPreloadComponentRequestBus::Handler, and Audio::AudioPreloadNotificationBus::MultiHandler.

Public Types

enum class  LoadType : AZ::u32 { Auto , Manual }
 

Public Member Functions

 AZ_COMPONENT (AudioPreloadComponent, "{CBBB1234-4DCA-427E-80FF-E2BB0866EEB1}")
 
void Activate () override
 
void Deactivate () override
 
 AudioPreloadComponent (AudioPreloadComponent::LoadType loadType, const AZStd::string &preloadName)
 
void Load () override
 
void Unload () override
 
void LoadPreload (const char *preloadName) override
 
void UnloadPreload (const char *preloadName) override
 
bool IsLoaded (const char *preloadName) override
 
void OnAudioPreloadCached () override
 
void OnAudioPreloadUncached () override
 

Static Public Member Functions

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

Detailed Description

AudioPreloadComponent Allows loading and unloading ATL Preloads (Soundbanks). A Preload name can be serialized with the component, or it can be manually specified at runtime for use in scripting.

Member Function Documentation

◆ AZ_COMPONENT()

LmbrCentral::AudioPreloadComponent::AZ_COMPONENT ( AudioPreloadComponent  ,
"{CBBB1234-4DCA-427E-80FF-E2BB0866EEB1}"   
)

AZ::Component

◆ Load()

void LmbrCentral::AudioPreloadComponent::Load ( )
override

AudioPreloadComponentRequestBus::Handler Required Interface

◆ OnAudioPreloadCached()

void LmbrCentral::AudioPreloadComponent::OnAudioPreloadCached ( )
override

Audio::AudioPreloadNotificationBus::Handler interface

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