#include <AtomExternalComponent.h>

UAtomExternalComponent の継承関係図

公開メンバ関数
CRIWARECORE_API	UAtomExternalComponent (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 ()
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	OnRegister () override
virtual CRIWARECORE_API void	OnUnregister () override
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)

公開変数類
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
FOnAtomExternalEnvelopeValue	OnAtomSoundEnvelopeValue
FOnAtomExternalEnvelopeValueNative	OnAtomSoundEnvelopeValueNative
TArray< FAtomSoundSourceBusSendInfo >	PreEffectSourceBusSends
TObjectPtr< UAtomSoundClass >	SoundClass

限定公開メンバ関数
CRIWARECORE_API FAtomRuntime *	GetAtomRuntime () const
virtual bool	Init (FAtomExternalSoundParameters &OutExternalSoundParams)

非公開変数類
TObjectPtr< UAtomComponent >	AtomComponent
bool	bIsExternalPlaying
bool	bIsInitialized
TObjectPtr< UAtomComponentExtensionSettings >	ExtensionSettings
TObjectPtr< UAtomExternalSound >	ExternalSound

フレンド
class	UAtomExternalSound

詳解

An Atom compomennet that use externally created player and voices.

Used for source access to sound created externally by CriWare libraries using their own AtomVoicePools and AtomExPlayers.

構築子と解体子

◆ UAtomExternalComponent()

UAtomExternalComponent::UAtomExternalComponent ( const FObjectInitializer & ObjectInitializer )

関数詳解

◆ Activate()

void UAtomExternalComponent::Activate ( bool bReset = false )

overridevirtual

◆ AdjustVolume()

void UAtomExternalComponent::AdjustVolume	(	float	AdjustVolumeDuration,
		float	AdjustVolumeLevel,
		const EAtomFaderCurve	FadeCurve = EAtomFaderCurve::Linear ) const

This function allows designers to trigger an adjustment to the sound instance's playback Volume with options for smoothly applying a curve over time.

引数

AdjustVolumeDuration	The length of time in which to interpolate between the initial volume and the new volume.
AdjustVolumeLevel	The new volume to set the Audio Component to.
FadeCurve	The curve used when interpolating between the old and new volume.

◆ BeginDestroy()

void UAtomExternalComponent::BeginDestroy ( )

overridevirtual

◆ CreateAtomComponent()

void UAtomExternalComponent::CreateAtomComponent ( )

Creates the Atom component if it hasn't already been created yet. This should only be used when trying to assign explicit settings to the AtomComponent before calling Start().

◆ Deactivate()

void UAtomExternalComponent::Deactivate ( )

overridevirtual

◆ EndPlay()

void UAtomExternalComponent::EndPlay ( const EEndPlayReason::Type Reason )

overridevirtual

◆ FadeIn()

void UAtomExternalComponent::FadeIn	(	float	FadeInDuration,
		float	FadeVolumeLevel = 1.0f,
		float	StartTime = 0.0f,
		const EAtomFaderCurve	FadeCurve = EAtomFaderCurve::Linear ) const

This function allows designers to call Play on an Audio Component instance while applying a volume curve over time. Parameters allow designers to indicate the duration of the fade, the curve shape, and the start time if seeking into the sound.

引数

FadeInDuration	How long it should take to reach the FadeVolumeLevel
FadeVolumeLevel	The percentage of the AudioComponents's calculated volume to fade to
FadeCurve	The curve to use when interpolating between the old and new volume

◆ FadeOut()

void UAtomExternalComponent::FadeOut	(	float	FadeOutDuration,
		float	FadeVolumeLevel,
		const EAtomFaderCurve	FadeCurve = EAtomFaderCurve::Linear ) const

This function allows designers to call a delayed Stop on an Audio Component instance while applying a volume curve over time. Parameters allow designers to indicate the duration of the fade and the curve shape.

引数

FadeOutDuration	how long it should take to reach the FadeVolumeLevel
FadeVolumeLevel	the percentage of the AudioComponents's calculated volume in which to fade to
FadeCurve	The curve to use when interpolating between the old and new volume

◆ GetAtomComponent()

UAtomComponent * UAtomExternalComponent::GetAtomComponent ( )

Retrieves this synth component's Atom component.

◆ GetAtomComponentExtension()

TScriptInterface< IAtomComponentExtension > UAtomExternalComponent::GetAtomComponentExtension ( ) const

inline

Gets an interface that exposes extended functionnalities of the owned AtomComponent.

◆ GetAtomRuntime()

FAtomRuntime * UAtomExternalComponent::GetAtomRuntime ( ) const

protected

◆ GetSoundClass()

UAtomSoundClass * UAtomExternalComponent::GetSoundClass ( )

virtual

◆ Init()

virtual bool UAtomExternalComponent::Init ( FAtomExternalSoundParameters & OutExternalSoundParams )

inlineprotectedvirtual

◆ Initialize()

void UAtomExternalComponent::Initialize ( )

Call for creating this external component from code or some other location.

◆ IsPlaying()

bool UAtomExternalComponent::IsPlaying ( ) const

Returns true if this component is currently playing.

◆ IsReadyForOwnerToAutoDestroy()

bool UAtomExternalComponent::IsReadyForOwnerToAutoDestroy ( ) const

overridevirtual

◆ OnAtomComponentEnvelopeValue()

void UAtomExternalComponent::OnAtomComponentEnvelopeValue	(	const UAtomComponent *	AtomComponent,
		const UAtomSoundBase *	Sound,
		const float	EnvelopeValue )

◆ OnRegister()

void UAtomExternalComponent::OnRegister ( )

overridevirtual

◆ OnUnregister()

void UAtomExternalComponent::OnUnregister ( )

overridevirtual

◆ Serialize()

void UAtomExternalComponent::Serialize ( FArchive & Ar )

overridevirtual

◆ SetAisacControlValue()

void UAtomExternalComponent::SetAisacControlValue	(	const FAtomAisacControl &	AisacControl,
		float	Value )

Modulates in realtime the desired AISAC control value. This multiply with the base control value and with any routed modulation.

引数

AisacControl	The AISAC control to modulate.
Value	The value used to modulate the base value.

◆ SetAtomBusSend()

void UAtomExternalComponent::SetAtomBusSend	(	UAtomBus *	Bus,
		float	SendLevel )

Sets how much audio the sound should send to the given AudioBus (pre effect).

◆ SetAtomBusSendPreEffect()

CRIWARECORE_API void UAtomExternalComponent::SetAtomBusSendPreEffect	(	UAtomBus *	AtomBus,
		float	AtomBusSendLevel )

inline

◆ SetAudioBusSendPreEffect()

void UAtomExternalComponent::SetAudioBusSendPreEffect	(	UAtomAudioBus *	AudioBus,
		float	AudioBusSendLevel )

Sets how much audio the sound should send to the given SourceBus (post effect). Sets how much audio the sound should send to the given AudioBus (pre effect).

◆ SetLowPassFilterEnabled()

void UAtomExternalComponent::SetLowPassFilterEnabled ( bool InLowPassFilterEnabled )

Sets how much audio the sound should send to the given AudioBus (post effect). Sets whether or not the low pass filter is enabled on the audio component.

◆ SetLowPassFilterFrequency()

void UAtomExternalComponent::SetLowPassFilterFrequency ( float InLowPassFilterFrequency )

virtual

Sets lowpass filter frequency of the audio component.

◆ SetModulationRouting()

void UAtomExternalComponent::SetModulationRouting	(	const TSet< UAtomModulatorBase * > &	Modulators,
		const EAtomModulationDestination	Destination,
		const EAtomModulationRouting	RoutingMethod = EAtomModulationRouting::Inherit )

Sets the routing for one of the given Synth component's Modulation Destinations.

引数

Modulators	The set of modulators to apply to the given destination on the component.
Destination	The destination to assign the modulators to.
RoutingMethod	The routing method to use for the given modulator.

◆ SetMultiplePositions()

void UAtomExternalComponent::SetMultiplePositions	(	TArray< FTransform >	Positions,
		EAtomMultiPositionType	MultiPositionType )

Sets multiple source attenuation positions if spatialization is enabled.

◆ SetRackSend()

void UAtomExternalComponent::SetRackSend ( UAtomRackBase * Rack )

Sets sound send to the given Rack.

◆ SetSourceBusSendPreEffect()

void UAtomExternalComponent::SetSourceBusSendPreEffect	(	UAtomSoundSourceBus *	SoundSourceBus,
		float	SourceBusSendLevel )

Sets how much audio the sound should send to the given SourceBus (pre effect).

◆ SetVolumeMultiplier()

void UAtomExternalComponent::SetVolumeMultiplier ( float VolumeMultiplier )

Set a new volume multiplier

◆ Start()

void UAtomExternalComponent::Start ( )

◆ Stop()

void UAtomExternalComponent::Stop ( )

◆ UPARAM()

CRIWARECORE_API UAtomExternalComponent::UPARAM ( DisplayName = "Modulators" ) const

Gets the set of currently active modulators for a given Modulation Destination.

引数

Destination The Destination to retrieve the Modulators from.

戻り値: The set of of Modulators applied to this component for the given Destination.

◆ UAtomExternalSound

friend class UAtomExternalSound

friend

メンバ詳解

◆ AtomBusSends

TArray<FAtomSoundToBusSend> UAtomExternalComponent::AtomBusSends

An array of submix sends. Audio from this sound will send a portion of its audio to these effects.

◆ AtomComponent

TObjectPtr<UAtomComponent> UAtomExternalComponent::AtomComponent

private

◆ AtomComponentClass

TSubclassOf<UAtomComponent> UAtomExternalComponent::AtomComponentClass

The AtomComponent sub-class to use (MultiPositions, Lips...)

◆ AtomRack

TObjectPtr<UAtomRackWithParentBase> UAtomExternalComponent::AtomRack

Rack this sound belongs to

◆ AttenuationOverrides

struct FAtomAttenuationSettings UAtomExternalComponent::AttenuationOverrides

If bOverrideSettings is true, the attenuation properties to use for sounds generated by this component

◆ AttenuationSettings

TObjectPtr<class UAtomAttenuation> UAtomExternalComponent::AttenuationSettings

If bOverrideSettings is false, the asset to use to determine attenuation properties for sounds generated by this component

◆ bAllowSpatialization

uint8 UAtomExternalComponent::bAllowSpatialization

Is this audio component allowed to be spatialized?

◆ bAlwaysPlay

uint8 UAtomExternalComponent::bAlwaysPlay

Whether to artificially prioritize the component to play

◆ bApplyExtensionSettings

bool UAtomExternalComponent::bApplyExtensionSettings

Whether to use the Atom component extension settings if available.

◆ bAutoDestroy

uint8 UAtomExternalComponent::bAutoDestroy

Auto destroy this component on completion

◆ bEnableBaseRack

uint32 UAtomExternalComponent::bEnableBaseRack

If enabled, sound will route to the Master Rack by default or to the Base Rack if defined. If disabled, sound will route ONLY to the Bus Sends

◆ bEnableBusSends

uint32 UAtomExternalComponent::bEnableBusSends

Whether or not to enable Bus Sends other than the Base Rack.

◆ bEnableSourceBusSends

uint32 UAtomExternalComponent::bEnableSourceBusSends

Whether or not to enable sending this audio's output to buses.

◆ bIsExternalPlaying

bool UAtomExternalComponent::bIsExternalPlaying

private

◆ bIsInitialized

bool UAtomExternalComponent::bIsInitialized

private

◆ bIsPreviewSound

uint8 UAtomExternalComponent::bIsPreviewSound

Whether or not this synth is playing as a preview sound

◆ bIsUISound

uint8 UAtomExternalComponent::bIsUISound

Whether or not this sound plays when the game is paused in the UI

◆ bOverrideAttenuation

uint8 UAtomExternalComponent::bOverrideAttenuation

Should the Attenuation Settings asset be used (false) or should the properties set directly on the component be used for attenuation properties

◆ bStopWhenOwnerDestroyed

uint8 UAtomExternalComponent::bStopWhenOwnerDestroyed

Stop sound when owner is destroyed

◆ ConcurrencySet

TSet<TObjectPtr<UAtomConcurrency> > UAtomExternalComponent::ConcurrencySet

What sound concurrency to use for sounds generated by this Atom component

◆ EnvelopeFollowerAttackTime

int32 UAtomExternalComponent::EnvelopeFollowerAttackTime

The attack time in milliseconds for the envelope follower. Delegate callbacks can be registered to get the envelope value of sounds played with this Atom component.

◆ EnvelopeFollowerReleaseTime

int32 UAtomExternalComponent::EnvelopeFollowerReleaseTime

The release time in milliseconds for the envelope follower. Delegate callbacks can be registered to get the envelope value of sounds played with this Atom component.

◆ ExtensionSettings

TObjectPtr<UAtomComponentExtensionSettings> UAtomExternalComponent::ExtensionSettings

private

◆ ExternalSound

TObjectPtr<UAtomExternalSound> UAtomExternalComponent::ExternalSound

private

◆ ModulationRouting

FAtomSoundModulationRoutingSettings UAtomExternalComponent::ModulationRouting

◆ OnAtomSoundEnvelopeValue

FOnAtomExternalEnvelopeValue UAtomExternalComponent::OnAtomSoundEnvelopeValue

◆ OnAtomSoundEnvelopeValueNative

FOnAtomExternalEnvelopeValueNative UAtomExternalComponent::OnAtomSoundEnvelopeValueNative

Shadow delegate for non UObject subscribers

◆ PreEffectSourceBusSends

TArray<FAtomSoundSourceBusSendInfo> UAtomExternalComponent::PreEffectSourceBusSends

The source effect chain to use for this sound. This sound will send its audio output to this list of buses if there are bus instances playing after source effects are processed. This sound will send its audio output to this list of buses if there are bus instances playing before source effects are processed.

◆ SoundClass

TObjectPtr<UAtomSoundClass> UAtomExternalComponent::SoundClass

Sound class this sound belongs to

このクラス詳解は次のファイルから抽出されました:

C:/git/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Public/Atom/Components/AtomExternalComponent.h
C:/git/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Private/Atom/Components/AtomExternalComponent.cpp

公開メンバ関数

公開変数類

限定公開メンバ関数

非公開変数類

フレンド

詳解

構築子と解体子

◆ UAtomExternalComponent()

関数詳解

◆ Activate()

◆ AdjustVolume()

◆ BeginDestroy()

◆ CreateAtomComponent()

◆ Deactivate()

◆ EndPlay()

◆ FadeIn()

◆ FadeOut()

◆ GetAtomComponent()

◆ GetAtomComponentExtension()

◆ GetAtomRuntime()

◆ GetSoundClass()

◆ Init()

◆ Initialize()

◆ IsPlaying()

◆ IsReadyForOwnerToAutoDestroy()

◆ OnAtomComponentEnvelopeValue()

◆ OnRegister()

◆ OnUnregister()

◆ Serialize()

◆ SetAisacControlValue()

◆ SetAtomBusSend()

◆ SetAtomBusSendPreEffect()

◆ SetAudioBusSendPreEffect()

◆ SetLowPassFilterEnabled()

◆ SetLowPassFilterFrequency()

◆ SetModulationRouting()

◆ SetMultiplePositions()

◆ SetRackSend()

◆ SetSourceBusSendPreEffect()

◆ SetVolumeMultiplier()

◆ Start()

◆ Stop()

◆ UPARAM()

フレンドと関連関数の詳解

◆ UAtomExternalSound

メンバ詳解

◆ AtomBusSends

◆ AtomComponent

◆ AtomComponentClass

◆ AtomRack

◆ AttenuationOverrides

◆ AttenuationSettings

◆ bAllowSpatialization

◆ bAlwaysPlay

◆ bApplyExtensionSettings

◆ bAutoDestroy

◆ bEnableBaseRack

◆ bEnableBusSends

◆ bEnableSourceBusSends

◆ bIsExternalPlaying

◆ bIsInitialized

◆ bIsPreviewSound

◆ bIsUISound

◆ bOverrideAttenuation

◆ bStopWhenOwnerDestroyed

◆ ConcurrencySet

◆ EnvelopeFollowerAttackTime

◆ EnvelopeFollowerReleaseTime

◆ ExtensionSettings

◆ ExternalSound

◆ ModulationRouting

◆ OnAtomSoundEnvelopeValue

◆ OnAtomSoundEnvelopeValueNative

◆ PreEffectSourceBusSends

◆ SoundClass