UAtomAudioLinkSettings Class Reference

#include <AtomAudioLinkSettings.h>

Inheritance diagram for UAtomAudioLinkSettings:

Public Attributes
bool	bShouldClearBufferOnReceipt = true
TSoftObjectPtr< UAtomBus >	DestinationBus
EAtomBusSendStage	DestinationBusStage = EAtomBusSendStage::PreEffect
EAtomAudioLinkRoute	DestinationRoute = EAtomAudioLinkRoute::Source
float	InitialSilenceFillRatio = 1.0f
float	ProducerToConsumerBufferRatio = 2.0f

Protected Member Functions
virtual FName	GetFactoryName () const override
int32	GetReceivingBufferSizeInFrames () const
virtual FSharedSettingsProxyPtr	MakeProxy () const override

Protected Attributes
TObjectPtr< UAtomBus >	DestinationBusResolved
TSharedPtr< FStreamableHandle >	LoadingHandle

Friends
class	FAtomAudioLinkSettingsProxy

Member Function Documentation

GetFactoryName()

FName UAtomAudioLinkSettings::GetFactoryName ( ) const

overrideprotectedvirtual

GetReceivingBufferSizeInFrames()

int32 UAtomAudioLinkSettings::GetReceivingBufferSizeInFrames ( ) const

protected

MakeProxy()

UAudioLinkSettingsAbstract::FSharedSettingsProxyPtr UAtomAudioLinkSettings::MakeProxy ( ) const

overrideprotectedvirtual

Friends And Related Symbol Documentation

FAtomAudioLinkSettingsProxy

friend class FAtomAudioLinkSettingsProxy

friend

Member Data Documentation

bShouldClearBufferOnReceipt

bool UAtomAudioLinkSettings::bShouldClearBufferOnReceipt = true

If this is set, the receiving code will clear the buffer after it's read, so it's not rendered by Unreal. Only applies if running both renderers at once.

DestinationBus

TSoftObjectPtr<UAtomBus> UAtomAudioLinkSettings::DestinationBus

The destination DSP bus to send audio.

DestinationBusResolved

TObjectPtr<UAtomBus> UAtomAudioLinkSettings::DestinationBusResolved

protected

Once the SoftObjectReference has been resolved, attach the reference here so it's owned.

DestinationBusStage

EAtomBusSendStage UAtomAudioLinkSettings::DestinationBusStage = EAtomBusSendStage::PreEffect

The stage of the destination DSP bus to send audio.

DestinationRoute

EAtomAudioLinkRoute UAtomAudioLinkSettings::DestinationRoute = EAtomAudioLinkRoute::Source

Whether use link as a sound source or route audio to an Atom DSP bus.

InitialSilenceFillRatio

float UAtomAudioLinkSettings::InitialSilenceFillRatio = 1.0f

Ratio of initial buffer to fill with silence ahead of consumption. Adjusting this can resolve starvation at the cost of added latency.

LoadingHandle

TSharedPtr<FStreamableHandle> UAtomAudioLinkSettings::LoadingHandle

protected

ProducerToConsumerBufferRatio

float UAtomAudioLinkSettings::ProducerToConsumerBufferRatio = 2.0f

This is the ratio of producer to consumer buffer size, 2.0 means its twice as big as the consumer buffer.

---

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

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