CriWare Unreal Engine
Plug-ins for CriWare solutions.
Loading...
Searching...
No Matches
UMySound Class Reference

#include <AtomSoundProxy.h>

Inheritance diagram for UMySound:

Public Member Functions

virtual CRIWARECORE_API float GetDuration () const override
virtual CRIWARECORE_API float GetMaxDistance () const override
virtual CRIWARECORE_API bool IsPlayable () const override
virtual CRIWARECORE_API void Parse (FAtomRuntime *AtomRuntime, const UPTRINT PlaybackInstanceHash, FAtomActiveSound &ActiveSound, const FAtomSoundParseParameters &ParseParams, TArray< FAtomPlaybackInstance * > &OutPlaybackInstances) override
Public Member Functions inherited from UAtomSoundBase
CRIWARECORE_API UAtomSoundBase (const FObjectInitializer &ObjectInitializer)
virtual CRIWARECORE_API void AddAssetUserData (UAssetUserData *InUserData) override
CRIWARECORE_API void AddPlayingSource (const FAtomSoundClientPtr &Source)
virtual CRIWARECORE_API void BeginDestroy () override
virtual CRIWARECORE_API bool CanBeClusterRoot () const override
virtual CRIWARECORE_API bool CanBeInCluster () const override
virtual bool GetAllDefaultParameters (TArray< FAtomAisacParameter > &OutParameters) const
virtual CRIWARECORE_API void GetAllSoundResources (TArray< IAtomSoundResource * > &Resources)
virtual CRIWARECORE_API void GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const override
virtual CRIWARECORE_API const TArray< UAssetUserData * > * GetAssetUserDataArray () const override
virtual CRIWARECORE_API UAssetUserData * GetAssetUserDataOfClass (TSubclassOf< UAssetUserData > InUserDataClass) override
virtual CRIWARECORE_API void GetAtomBusSends (TArray< FAtomSoundToBusSend > &OutSends) const
virtual CRIWARECORE_API UAtomRackBase * GetAtomRack () const
virtual CRIWARECORE_API const FAtomAttenuationSettings * GetAttenuationSettingsToApply () const
virtual CRIWARECORE_API void GetConcurrencyHandles (TArray< FAtomConcurrencyHandle > &OutConcurrencyHandles) const
virtual const FAtomSoundModulationRoutingSettings & GetModulationSettings () const
virtual CRIWARECORE_API float GetPitchMultiplier ()
virtual CRIWARECORE_API float GetPriority () const
virtual CRIWARECORE_API UAtomSoundClass * GetSoundClass () const
virtual FString GetSoundName () const
virtual CRIWARECORE_API IAtomSoundResource * GetSoundResource ()
virtual CRIWARECORE_API void GetSoundSourceBusSends (EAtomBusSendStage BusSendStage, TArray< FAtomSoundSourceBusSendInfo > &OutSends) const
virtual CRIWARECORE_API EAtomVirtualizationMode GetVirtualizationMode () const
virtual CRIWARECORE_API float GetVolumeMultiplier ()
virtual CRIWARECORE_API void InitParameters (TArray< FAtomAisacParameter > &ParametersToInit, FName InFeatureName=NAME_None)
bool IsGeneratingAudio () const
virtual CRIWARECORE_API bool IsLooping () const
virtual CRIWARECORE_API bool IsOneShot () const
virtual CRIWARECORE_API bool IsParameterValid (const FAtomAisacParameter &InParameter) const
virtual CRIWARECORE_API bool IsPlayWhenSilent () const
CRIWARECORE_API bool IsProcedurallyGenerated () const
virtual bool IsSeekable () const
virtual bool IsStreaming (const TCHAR *PlatformName=nullptr) const
virtual CRIWARECORE_API void PostInitProperties () override
virtual CRIWARECORE_API void PostLoad () override
CRIWARECORE_API void RemovePlayingSource (const FAtomSoundClientPtr &Source)
virtual CRIWARECORE_API void RemoveUserDataOfClass (TSubclassOf< UAssetUserData > InUserDataClass) override
virtual CRIWARECORE_API void Serialize (FArchive &Ar) override
virtual CRIWARECORE_API bool ShouldApplyInteriorVolumes ()

Public Attributes

TObjectPtr< UAtomSoundCue > Cue
TObjectPtr< UAtomSoundCue > Cue2
Public Attributes inherited from UAtomSoundBase
TArray< TObjectPtr< UAssetUserData > > AssetUserData
TArray< FAtomSoundToBusSend > AtomBusSends
TObjectPtr< UAtomRackWithParentBase > AtomRack
TObjectPtr< UAtomAttenuation > AttenuationSettings
uint8 bDebug: 1
uint8 bEnableBaseRack: 1
uint8 bEnableBusSends: 1
uint8 bEnableSourceBusSends: 1
uint8 bIsSourceBus: 1
uint8 bOverrideConcurrency: 1
uint8 bOverrideVirtualizationMode: 1
uint8 bProcedural: 1
FAtomConcurrencySettings ConcurrencyOverrides
TSet< TObjectPtr< UAtomConcurrency > > ConcurrencySet
TMap< FAtomRuntimeId, int32 > CurrentPlayCount
float Duration
float MaxDistance
FAtomSoundModulationRoutingSettings ModulationSettings
TArray< FAtomSoundSourceBusSendInfo > PreEffectSourceBusSends
float Priority
TObjectPtr< UAtomSoundClass > SoundClassObject
EAtomVirtualizationMode VirtualizationMode
FAtomWaveInfo WaveInfo

Additional Inherited Members

Public Types inherited from UAtomSoundBase
using FAtomSoundClientPtr = IAtomSoundClient*
Protected Member Functions inherited from UAtomSoundBase
virtual CRIWARECORE_API float ComputeMaxDistance () const

Detailed Description

MySound is a user customized example asset. It currently shows how to create your own UAtomSound assets in c++ for your game needs. Note: This asset may change in future versions.

MySound can hold 1 or 2 AtomSoundCue assets. In case two cues are used, when the first cue has ended or stopped whith GetAllPlaybacks()/StopPlayback(), the second cue starts to play. The sound duration is based on the 1st cue.

Member Function Documentation

◆ GetDuration()

float UMySound::GetDuration ( ) const
overridevirtual

Returns the length of the sound

Reimplemented from UAtomSoundBase.

◆ GetMaxDistance()

float UMySound::GetMaxDistance ( ) const
overridevirtual

Returns the farthest distance at which the sound could be heard

Reimplemented from UAtomSoundBase.

◆ IsPlayable()

bool UMySound::IsPlayable ( ) const
overridevirtual

Returns whether the sound base is set up in a playable manner

Reimplemented from UAtomSoundBase.

◆ Parse()

void UMySound::Parse ( FAtomRuntime * AtomRuntime,
const UPTRINT PlaybackInstanceHash,
FAtomActiveSound & ActiveSound,
const FAtomSoundParseParameters & ParseParams,
TArray< FAtomPlaybackInstance * > & PlaybackInstances )
overridevirtual

Parses the Sound to generate and setup the PlaybackInstances to play.

Reimplemented from UAtomSoundBase.

Member Data Documentation

◆ Cue

TObjectPtr<UAtomSoundCue> UMySound::Cue

◆ Cue2

TObjectPtr<UAtomSoundCue> UMySound::Cue2
The documentation for this class was generated from the following files:
  • C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Public/Atom/AtomSoundProxy.h
  • C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Private/Atom/AtomSoundProxy.cpp