|
Module |
|
|
Header |
/Engine/Source/Runtime/Engine/Classes/Sound/SoundCue.h |
|
Include |
#include "Sound/SoundCue.h" |
class USoundCue : public USoundBase
The behavior of audio playback is defined within Sound Cues.
| Name | Description | ||
|---|---|---|---|
|
|
AllNodes |
||
|
|
AttenuationOverrides |
Attenuation settings to use if Override Attenuation is set to true |
|
|
|
uint8: 1 |
bExcludeFromRandomNodeBranchCulling |
Ignore per-platform random node culling for memory purposes |
|
|
uint8: 1 |
bOverrideAttenuation |
Indicates whether attenuation should use the Attenuation Overrides or the Attenuation Settings asset |
|
|
uint32: 1 |
bPrimeOnLoad |
Makes this sound cue automatically load any sound waves it can play into the cache when it is loaded. |
|
|
USoundNode *... |
FirstNode |
|
|
|
float |
PitchMultiplier |
Base pitch multiplier |
|
|
UEdGraph * |
SoundCueGraph |
|
|
|
float |
SubtitlePriority |
|
|
|
float |
VolumeMultiplier |
Base volume multiplier |
| Name | Description | |
|---|---|---|
|
|
USoundCue ( |
| Name | Description | ||
|---|---|---|---|
|
|
AddReferencedObjects ( |
||
|
|
CacheAggregateValues() |
Call to cache any values which need to be computed from the sound cue graph. |
|
|
|
CacheLoadingBehavior ( |
Call this when stream caching is enabled to update sound waves of loading behavior they are inheriting via SoundCue |
|
|
|
CacheQualityLevel() |
This is used to cache the quality level if it has not been cached yet. |
|
|
|
ClearGraph() |
Clears all nodes from the graph (for old editor's buffer soundcue) |
|
|
|
CompileSoundNodesFromGraphNodes() |
Use the EdGraph representation to compile the SoundCue |
|
|
|
T * |
ConstructSoundNode ( |
Construct and initialize a node within this Cue |
|
|
CreateGraph() |
Create the basic sound graph |
|
|
|
FindPathToNode ( |
Find the path through the sound cue to a node identified by its hash |
|
|
|
GetCachedQualityLevel() |
||
|
|
GetCookedQualityIndex() |
Set the Quality level that the Cue was cooked at, called by the SoundQualityNodes |
|
|
|
UEdGraph ... |
GetGraph() |
Get the EdGraph of SoundNodes |
|
|
GetResourceSizeForFormat ( |
||
|
|
TSharedPtr< ... |
GetSoundCueAudioEditor() |
Gets the sound cue graph editor implementation. |
|
|
LinkGraphNodesFromSoundNodes() |
Use the SoundCue's children to link EdGraph Nodes together |
|
|
|
PrimeSoundCue() |
Call this when stream caching is enabled to prime all SoundWave assets referenced by this Sound Cue. |
|
|
|
RecursiveFindAllNodes ( |
Recursively finds all Nodes in the Tree |
|
|
|
RecursiveFindAttenuation ( |
Instantiate certain functions to work around a linker issue |
|
|
|
RecursiveFindNode ( |
Recursively finds sound nodes of type T |
|
|
|
RecursiveFindNode ( |
||
|
|
RecursiveFindPathToNode ( |
||
|
|
ReleaseRetainedAudio() |
||
|
|
ResetGraph() |
Resets all graph data and nodes |
|
|
|
RetainSoundCue() |
Call this when stream caching is enabled to retain all soundwave assets referenced by this sound cue. |
|
|
|
SetSoundCueAudioEditor ( |
Sets the sound cue graph editor implementation.* |
|
|
|
SetupSoundNode ( |
Set up EdGraph parts of a SoundNode |
|
|
|
StaticAudioQualityChanged ( |
Call when the audio quality has been changed |
| Name | Description | ||
|---|---|---|---|
|
|
const FSound... |
GetAttenuationSettingsToApply() |
Returns a pointer to the attenuation settings that are to be applied for this node |
|
|
float |
GetDuration() |
Returns the length of the sound |
|
|
float |
GetMaxDistance() |
Returns the farthest distance at which the sound could be heard |
|
|
float |
GetPitchMultiplier() |
|
|
|
GetSoundWavesWithCookedAnalysisData ( |
Returns whether the sound has cooked analysis data (e.g. FFT or envelope following data) and returns sound waves which have cooked data. |
|
|
|
float |
GetSubtitlePriority() |
Returns the subtitle priority |
|
|
float |
GetVolumeMultiplier() |
|
|
|
HasCookedAmplitudeEnvelopeData() |
||
|
|
HasCookedFFTData() |
Queries if the sound has cooked FFT or envelope data. |
|
|
|
IsPlayable() |
Returns whether the sound base is set up in a playable manner |
|
|
|
IsPlayWhenSilent() |
Returns true if any of the sounds in the sound have "play when silent" enabled. |
|
|
|
Parse ( |
Parses the Sound to generate the WaveInstances to play. |
|
|
|
ShouldApplyInteriorVolumes() |
Returns whether or not any part of this sound wants interior volumes applied to it |
| Name | Description | ||
|---|---|---|---|
|
|
BeginDestroy() |
Called before destroying the object. |
|
|
|
GetDesc() |
Return a one line description of an object for viewing in the thumbnail view of the generic browser |
|
|
|
PostEditChangeProperty ( |
Called when a property on this object has been modified externally |
|
|
|
PostInitProperties() |
Called after the C++ constructor and after the properties have been initialized, including those loaded from config. |
|
|
|
PostLoad() |
Do any object-specific cleanup required immediately after loading an object. |
|
|
|
Serialize ( |
Handles reading, writing, and reference collecting using FArchive. |
| Name | Description | ||
|---|---|---|---|
|
|
CanBeClusterRoot() |
Called after load to determine if the object can be a cluster root |
|
|
|
CanBeInCluster() |
Called during cluster construction if the object can be added to a cluster |
|
Name |
Description |
|---|---|
|
CachedQualityLevel |
|
|
SoundCueAudioEditor |
Ptr to interface to sound cue editor operations. |