G1R AngelScript
Scripting reference for the Gothic 1 Remake
Loading...
Searching...
No Matches
USoundWaveRuntimeLoaded Class Reference

Static Public Member Functions

Static Functions
static UClass StaticClass ()
Static Public Member Functions inherited from USoundWave
static UClass StaticClass ()
Static Public Member Functions inherited from USoundBase
static UClass StaticClass ()
Static Public Member Functions inherited from UObject
static UClass StaticClass ()

Additional Inherited Members

Public Member Functions inherited from USoundWave
void SetTreatFileAsLoopingForAnalysis (bool Value)
 Whether or not we should treat the sound wave used for analysis (this or the override) as looping while performing analysis. A looping sound may include the end of the file for inclusion in analysis for envelope and FFT analysis.
void SetbEnableBakedFFTAnalysis (bool Value)
 Whether or not to enable cook-time baked FFT analysis.
void SetbEnableAmplitudeEnvelopeAnalysis (bool Value)
 Whether or not to enable cook-time amplitude envelope analysis.
void SetbLooping (bool Value)
 If set, when played directly (not through a sound cue) the wave will be played looping.
bool GetbMature () const
 If set to true if this sound is considered to contain mature/adult content.
void SetbMature (bool Value)
 If set to true if this sound is considered to contain mature/adult content.
bool GetbManualWordWrap () const
 If set to true will disable automatic generation of line breaks - use if the subtitles have been split manually.
void SetbManualWordWrap (bool Value)
 If set to true will disable automatic generation of line breaks - use if the subtitles have been split manually.
bool GetbSingleLine () const
 If set to true the subtitles display as a sequence of single lines as opposed to multiline.
void SetbSingleLine (bool Value)
 If set to true the subtitles display as a sequence of single lines as opposed to multiline.
void SetbIsAmbisonics (bool Value)
 Whether or not this source is ambisonics file format. If set, sound always uses the 'Master Ambisonics Submix' as set in the 'Audio' category of Project Settings' and ignores submix if provided locally or in the referenced SoundClass.
void SetbEnableCloudStreaming (bool Value)
 If enabled, this wave may be streamed from the cloud using the Opus format. Loading behavior must NOT be Force Inline. Requires a suitable support plugin to be installed.
TArray< FSoundWaveCuePoint > GetLoopRegions () const
 Filters for the cue points that are loop regions and returns those as a new array.
ESoundAssetCompressionType GetSoundAssetCompressionType () const
 Returns the sound's asset compression type.
void SetSoundAssetCompressionType (ESoundAssetCompressionType InSoundAssetCompressionType, bool bMarkDirty=true)
 Procedurally set the compression type.
TArray< FSoundWaveCuePoint > GetCuePoints () const
 Filters for the cue points that are not loop regions and returns those as a new array.
Public Member Functions inherited from USoundBase
void SetbEnableBaseSubmix (bool Value)
 If enabled, sound will route to the Master Submix by default or to the Base Submix if defined. If disabled, sound will route ONLY to the Submix Sends and/or Bus Sends.
bool GetbOverrideConcurrency () const
 Whether or not to override the sound concurrency object with local concurrency settings.
void SetbOverrideConcurrency (bool Value)
 Whether or not to override the sound concurrency object with local concurrency settings.
bool GetbEnableBusSends () const
 Whether or not to enable sending this audio's output to buses.
void SetbEnableBusSends (bool Value)
 Whether or not to enable sending this audio's output to buses.
void SetbDebug (bool Value)
 When "au.3dVisualize.Attenuation" has been specified, draw this sound's attenuation shape when the sound is audible. For debugging purposes only.
void SetbEnableSubmixSends (bool Value)
 Whether or not to enable Submix Sends other than the Base Submix.
bool GetbBypassVolumeScaleForPriority () const
 Bypass volume weighting priority upon evaluating whether sound should remain active when max channel count is met (See platform Audio Settings).
void SetbBypassVolumeScaleForPriority (bool Value)
 Bypass volume weighting priority upon evaluating whether sound should remain active when max channel count is met (See platform Audio Settings).
Public Member Functions inherited from UObject
bool MarkPackageDirty () const
void RemoveFromRoot ()
bool GetIsRooted () const
bool IsTransient () const
bool Modify (bool bAlwaysMarkDirty=true)
void SetTransactional (bool bTransactional)
bool IsSupportedForNetworking () const
UClass GetClass () const
UObject GetOuter () const
UObject GetTypedOuter (TSubclassOf< UObject > Target) const
 Traverses the outer chain searching for the next object of a certain type.
UPackage GetOutermost () const
UPackage GetPackage () const
void AddToRoot ()
UWorld GetWorld () const
FName GetName () const
FString GetFullName (const UObject StopOuter=nullptr) const
FString GetPathName (const UObject StopOuter=nullptr) const
bool IsA (const UClass Class) const
 Returns true if this object is of the specified type, or a child of that type.
void SaveConfig ()
void LoadConfig ()
void ReloadConfig ()
void CopyScriptPropertiesFrom (const UObject OtherObject)
void opCast (?&Address) const
FString ToString () const
Public Attributes inherited from USoundWave
USoundWave OverrideSoundToUseForAnalysis
 Specify a sound to use for the baked analysis. Will default to this USoundWave if not set.
int EnvelopeFollowerAttackTime
 The attack time in milliseconds. Describes how quickly the envelope analyzer responds to increasing amplitudes.
int EnvelopeFollowerReleaseTime
 The release time in milliseconds. Describes how quickly the envelope analyzer responds to decreasing amplitudes.
int EnvelopeFollowerFrameSize
 How many audio frames to average a new envelope value. Larger values use less memory for audio envelope data but will result in lower envelope accuracy.
int FFTAnalysisFrameSize
 How many audio frames analyze at a time.
int FFTAnalysisAttackTime
 Attack time in milliseconds of the spectral envelope follower.
int FFTAnalysisReleaseTime
 Release time in milliseconds of the spectral envelope follower.
ESoundWaveFFTSize FFTSize
 The FFT window size to use for fft analysis.
TArray< float32 > FrequenciesToAnalyze
 The frequencies (in hz) to analyze when doing baked FFT analysis.
const ESoundAssetCompressionType SoundAssetCompressionType
 The compression type to use for the sound wave asset.
ESoundwaveSampleRateSettings SampleRateQuality
 Determines the max sample rate to use if the platform enables "Resampling For Device" in project settings. For example, if the platform enables Resampling For Device and specifies 32000 for High, then setting High here will force the sound wave to be at most 32000. Does nothing if Resampling For Device is disabled.
int CompressionQuality
 Platform agnostic compression quality. 1..100 with 1 being best compression and 100 being best quality. ADPCM and PCM sound asset compression types ignore this parameter.
UAssetImportData AssetImportData
const TArray< FSoundWaveCuePoint > CuePoints
 Cue point data parsed fro the .wav file. Contains "Loop Regions" as cue points as well!
FPerPlatformFloat SizeOfFirstAudioChunkInSeconds
 How much audio to add to First Audio Chunk (in seconds).
ESoundWaveLoadingBehavior LoadingBehavior
 Specifies how and when compressed audio data is loaded for asset if stream caching is enabled.
FSoundModulationDefaultRoutingSettings ModulationSettings
 Modulation Settings.
TMap< FGuid, FSoundWaveCloudStreamingPlatformSettings > PlatformSettings
 Optionally disables cloud streaming per platform.
ESoundGroup SoundGroup
float32 Volume
 Playback volume of sound 0 to 1 - Default is 1.0.
float32 Pitch
 Playback pitch for sound.
UCurveTable Curves
 Curves associated with this sound wave.
TArray< FSubtitleCue > Subtitles
 Subtitle cues.
FString Comment
 Provides contextual information for the sound to the translator.
float32 SubtitlePriority
 The priority of the subtitle.
bool bMature
 If set to true if this sound is considered to contain mature/adult content.
bool bManualWordWrap
 If set to true will disable automatic generation of line breaks - use if the subtitles have been split manually.
bool bSingleLine
 If set to true the subtitles display as a sequence of single lines as opposed to multiline.
TArray< TObjectPtr< UWaveformTransformationBase > > Transformations
 Waveform edits to be applied to this SoundWave on cook (editing transformations will trigger a cook).
const TArray< FSoundWaveCuePoint > LoopRegions
 Filters for the cue points that are loop regions and returns those as a new array.
Public Attributes inherited from USoundBase
TArray< TObjectPtr< UAssetUserData > > AssetUserData
 Array of user data stored with the asset.
USoundAttenuation AttenuationSettings
 Attenuation settings package for the sound.
UAudioPropertiesSheetAssetBase AudioPropertiesSheet
UAudioPropertiesBindings AudioPropertiesBindings
float32 MaxDistance
 The max distance of the asset, as determined by attenuation settings.
float32 Duration
 Duration of sound in seconds.
float32 TotalSamples
 Total number of samples (in the thousands). Useful as a metric to analyze the relative size of a given sound asset in content browser.
bool bEnableBusSends
 Whether or not to enable sending this audio's output to buses.
USoundEffectSourcePresetChain SourceEffectChain
 The source effect chain to use for this sound.
TArray< FSoundSourceBusSendInfo > PreEffectBusSends
 This sound will send its audio output to this list of buses if there are bus instances playing before source effects are processed.
TArray< FSoundSourceBusSendInfo > BusSends
 This sound will send its audio output to this list of buses if there are bus instances playing after source effects are processed.
USoundSubmixBase SoundSubmixObject
 Submix to route sound output to. If unset, falls back to referenced SoundClass submix. If SoundClass submix is unset, sends to the 'Master Submix' as set in the 'Audio' category of Project Settings'.
TArray< FSoundSubmixSendInfo > SoundSubmixSends
 Array of submix sends to which a prescribed amount (see 'Send Level') of this sound is sent.
USoundClass SoundClassObject
 Sound class this sound belongs to.
EVirtualizationMode VirtualizationMode
 Virtualization behavior, determining if a sound may revive and how it continues playing when culled or evicted (limited to looping sounds).
TSet< TObjectPtr< USoundConcurrency > > ConcurrencySet
 Set of concurrency settings to observe (if override is set to false). Sound must pass all concurrency settings to play.
bool bOverrideConcurrency
 Whether or not to override the sound concurrency object with local concurrency settings.
FSoundConcurrencySettings ConcurrencyOverrides
 If Override Concurrency is true, concurrency settings to use.
bool bBypassVolumeScaleForPriority
 Bypass volume weighting priority upon evaluating whether sound should remain active when max channel count is met (See platform Audio Settings).
float32 Priority
 Used to determine whether sound can play or remain active if channel limit is met, where higher value is higher priority (see platform's Audio Settings 'Max Channels' property). Unless bypassed, value is weighted with the final volume of the sound to produce final runtime priority value.
Public Attributes inherited from UObject
const UClass Class
const UObject Outer
const UPackage Outermost
const UPackage Package
const UWorld World
const FName Name
const bool IsRooted

Member Function Documentation

◆ StaticClass()

UClass StaticClass ( )
static