UAtomAudioLinkComponent Class Reference

#include <AtomAudioLinkComponent.h>

Inheritance diagram for UAtomAudioLinkComponent:

Public Member Functions
	UAtomAudioLinkComponent (const FObjectInitializer &ObjectInitializer)
virtual IAtomSoundGeneratorPtr	CreateSoundGenerator (const FAtomSoundGeneratorInitParams &InParams) override
virtual void	OnEndGenerate (IAtomSoundGeneratorPtr Generator) override
Public Member Functions inherited from UAtomSynthComponent
CRIWARECORE_API	UAtomSynthComponent (const FObjectInitializer &ObjectInitializer)
virtual CRIWARECORE_API void	Activate (bool bReset=false) override
CRIWARECORE_API void	AdjustVolume (float AdjustVolumeDuration, float AdjustVolumeLevel, const EAtomFaderCurve FadeCurve=EAtomFaderCurve::Linear) const
virtual CRIWARECORE_API void	BeginDestroy () override
CRIWARECORE_API void	CreateAtomComponent ()
virtual CRIWARECORE_API void	Deactivate () override
virtual CRIWARECORE_API void	EndPlay (const EEndPlayReason::Type Reason) override
CRIWARECORE_API void	FadeIn (float FadeInDuration, float FadeVolumeLevel=1.0f, float StartTime=0.0f, const EAtomFaderCurve FadeCurve=EAtomFaderCurve::Linear) const
CRIWARECORE_API void	FadeOut (float FadeOutDuration, float FadeVolumeLevel, const EAtomFaderCurve FadeCurve=EAtomFaderCurve::Linear) const
CRIWARECORE_API UAtomComponent *	GetAtomComponent ()
TScriptInterface< IAtomComponentExtension >	GetAtomComponentExtension () const
virtual CRIWARECORE_API UAtomSoundClass *	GetSoundClass ()
CRIWARECORE_API void	Initialize (int32 SampleRateOverride=-1)
CRIWARECORE_API bool	IsPlaying () const
virtual CRIWARECORE_API bool	IsReadyForOwnerToAutoDestroy () const override
CRIWARECORE_API void	OnAtomComponentEnvelopeValue (const UAtomComponent *AtomComponent, const UAtomSoundBase *Sound, const float EnvelopeValue)
virtual CRIWARECORE_API void	Serialize (FArchive &Ar) override
CRIWARECORE_API void	SetAisacControlValue (const FAtomAisacControl &AisacControl, float Value)
CRIWARECORE_API void	SetAtomBusSend (UAtomBus *Bus, float SendLevel)
CRIWARECORE_API void	SetAtomBusSendPreEffect (UAtomBus *AtomBus, float AtomBusSendLevel)
CRIWARECORE_API void	SetAudioBusSendPreEffect (UAtomAudioBus *AudioBus, float AudioBusSendLevel)
CRIWARECORE_API void	SetLowPassFilterEnabled (bool InLowPassFilterEnabled)
virtual CRIWARECORE_API void	SetLowPassFilterFrequency (float InLowPassFilterFrequency)
CRIWARECORE_API void	SetModulationRouting (const TSet< UAtomModulatorBase * > &Modulators, const EAtomModulationDestination Destination, const EAtomModulationRouting RoutingMethod=EAtomModulationRouting::Inherit)
CRIWARECORE_API void	SetMultiplePositions (TArray< FTransform > Positions, EAtomMultiPositionType MultiPositionType)
CRIWARECORE_API void	SetRackSend (UAtomRackBase *Rack)
CRIWARECORE_API void	SetSourceBusSendPreEffect (UAtomSoundSourceBus *SoundSourceBus, float SourceBusSendLevel)
CRIWARECORE_API void	SetVolumeMultiplier (float VolumeMultiplier)
CRIWARECORE_API void	Start ()
CRIWARECORE_API void	Stop ()
CRIWARECORE_API	UPARAM (DisplayName="Modulators") TSet< UAtomModulatorBase * > GetModulators(const EAtomModulationDestination Destination)

Public Attributes
bool	bAutoPlay = false
TObjectPtr< UAtomAudioLinkSettings >	Settings
TObjectPtr< class USoundBase >	Sound
Public Attributes inherited from UAtomSynthComponent
TArray< FAtomSoundToBusSend >	AtomBusSends
TSubclassOf< UAtomComponent >	AtomComponentClass
TObjectPtr< UAtomRackWithParentBase >	AtomRack
struct FAtomAttenuationSettings	AttenuationOverrides
TObjectPtr< class UAtomAttenuation >	AttenuationSettings
uint8	bAllowSpatialization: 1
uint8	bAlwaysPlay: 1
bool	bApplyExtensionSettings
uint8	bAutoDestroy: 1
uint32	bEnableBaseRack: 1
uint32	bEnableBusSends: 1
uint32	bEnableSourceBusSends: 1
uint8	bIsPreviewSound: 1
uint8	bIsUISound: 1
uint8	bOverrideAttenuation: 1
uint8	bStopWhenOwnerDestroyed: 1
TSet< TObjectPtr< UAtomConcurrency > >	ConcurrencySet
int32	EnvelopeFollowerAttackTime
int32	EnvelopeFollowerReleaseTime
FAtomSoundModulationRoutingSettings	ModulationRouting
FOnAtomSynthEnvelopeValue	OnAtomSoundEnvelopeValue
FOnAtomSynthEnvelopeValueNative	OnAtomSoundEnvelopeValueNative
TArray< FAtomSoundSourceBusSendInfo >	PreEffectSourceBusSends
TObjectPtr< UAtomSoundClass >	SoundClass

Protected Member Functions
void	CreateAudioComponent ()
void	CreateLink ()
virtual bool	IsLinkPlaying () const override
virtual void	OnRegister () override
virtual void	OnUnregister () override
virtual void	PlayLink (float StartTime=0.0f) override
void	ResetLink ()
virtual void	SetLinkSound (USoundBase *NewSound) override
virtual void	StopLink () override
Protected Member Functions inherited from UAtomSynthComponent
CRIWARECORE_API FAtomRuntime *	GetAtomRuntime () const
virtual bool	Init (int32 &SampleRate)

Protected Attributes
TObjectPtr< UAudioComponent >	AudioComponent
TUniquePtr< IAudioLink >	LinkInstance
Protected Attributes inherited from UAtomSynthComponent
int32	NumChannels
int32	PreferredBufferLength

Private Member Functions
void	OnLinkStart (FAtomAudioLinkInputClientPtr InClientSP)
void	OnLinkStop (FAtomAudioLinkInputClientPtr InClientSP, int32 SourceID)

Private Attributes
TSharedPtr< FAtomAudioLinkSoundGenerator, ESPMode::ThreadSafe >	SoundGenerator

Friends
class	FAtomAudioLinkInputClient

Constructor & Destructor Documentation

UAtomAudioLinkComponent()

UAtomAudioLinkComponent::UAtomAudioLinkComponent

(

const FObjectInitializer &

ObjectInitializer

)

Member Function Documentation

CreateAudioComponent()

void UAtomAudioLinkComponent::CreateAudioComponent ( )

protected

CreateLink()

void UAtomAudioLinkComponent::CreateLink ( )

protected

CreateSoundGenerator()

IAtomSoundGeneratorPtr UAtomAudioLinkComponent::CreateSoundGenerator ( const FAtomSoundGeneratorInitParams & InParams )

overridevirtual

Reimplemented from UAtomSynthComponent.

IsLinkPlaying()

bool UAtomAudioLinkComponent::IsLinkPlaying ( ) const

overrideprotectedvirtual

OnEndGenerate()

void UAtomAudioLinkComponent::OnEndGenerate ( IAtomSoundGeneratorPtr Generator )

overridevirtual

Reimplemented from UAtomSynthComponent.

OnLinkStart()

void UAtomAudioLinkComponent::OnLinkStart ( FAtomAudioLinkInputClientPtr InClientSP )

private

OnLinkStop()

void UAtomAudioLinkComponent::OnLinkStop ( FAtomAudioLinkInputClientPtr InClientSP, int32 SourceID )

private

OnRegister()

void UAtomAudioLinkComponent::OnRegister ( )

overrideprotectedvirtual

Reimplemented from UAtomSynthComponent.

OnUnregister()

void UAtomAudioLinkComponent::OnUnregister ( )

overrideprotectedvirtual

Reimplemented from UAtomSynthComponent.

PlayLink()

void UAtomAudioLinkComponent::PlayLink ( float StartTime = 0.0f )

overrideprotectedvirtual

ResetLink()

void UAtomAudioLinkComponent::ResetLink ( )

protected

SetLinkSound()

void UAtomAudioLinkComponent::SetLinkSound ( USoundBase * NewSound )

overrideprotectedvirtual

StopLink()

void UAtomAudioLinkComponent::StopLink ( )

overrideprotectedvirtual

Friends And Related Symbol Documentation

FAtomAudioLinkInputClient

friend class FAtomAudioLinkInputClient

friend

Member Data Documentation

AudioComponent

TObjectPtr<UAudioComponent> UAtomAudioLinkComponent::AudioComponent

protected

bAutoPlay

bool UAtomAudioLinkComponent::bAutoPlay = false

Whether or not to play the Link on start

LinkInstance

TUniquePtr<IAudioLink> UAtomAudioLinkComponent::LinkInstance

protected

Settings

TObjectPtr<UAtomAudioLinkSettings> UAtomAudioLinkComponent::Settings

Sound

TObjectPtr<class USoundBase> UAtomAudioLinkComponent::Sound

The sound to be played

SoundGenerator

TSharedPtr<FAtomAudioLinkSoundGenerator, ESPMode::ThreadSafe> UAtomAudioLinkComponent::SoundGenerator

private

---

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

• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareAudioLink/CriWareAudioLink/Public/AtomAudioLinkComponent.h
• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareAudioLink/CriWareAudioLink/Private/AtomAudioLinkComponent.cpp