1. Epic GamesDeveloper
  3. USoundBase

USoundBase

The base class for a playable sound object

Unreal Engine C++ API Reference > Runtime > Engine > Sound

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Sound/SoundBase.h
Include #include "Sound/SoundBase.h"

Syntax

class USoundBase :  
    public UObject,  
    public IInterface_AssetUserData

Remarks

The base class for a playable sound object

Variables

  Type Name Description
Public variable TArray< TObjectPtr< UAssetUserData > > AssetUserData Array of user data stored with the asset
Public variable TObjectPtr< USoundAttenuation > AttenuationSettings Attenuation settings package for the sound
Public variable uint8: 1 bBypassVolumeScaleForPriority Bypass volume weighting priority upon evaluating whether sound should remain active when max channel count is met (See platform Audio Settings).
Public variable uint8: 1 bDebug When "au.3dVisualize.Attenuation" has been specified, draw this sound's attenuation shape when the sound is audible.
Public variable uint8: 1 bEnableBaseSubmix If enabled, sound will route to the Master Submix by default or to the Base Submix if defined.
Public variable uint8: 1 bEnableBusSends Whether or not to enable sending this audio's output to buses.
Public variable uint8: 1 bEnableSubmixSends Whether or not to enable Submix Sends other than the Base Submix.
Public variable uint8: 1 bHasConcatenatorNode Whether or not this sound has a concatenator node.
Public variable uint8: 1 bHasDelayNode Whether or not this sound has a delay node
Public variable uint8: 1 bOverrideConcurrency Whether or not to override the sound concurrency object with local concurrency settings.
Public variable 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.
Public variable FSoundConcurrencySettings ConcurrencyOverrides If Override Concurrency is true, concurrency settings to use.
Public variable TSet< TObjectPtr< USoundConcurrency > > ConcurrencySet Set of concurrency settings to observe (if override is set to false).
Public variable TMap< Audio::FDeviceId, int32 > CurrentPlayCount Map of device handle to number of times this sound is currently being played using that device(counted if sound is virtualized).
Public variable float Duration Duration of sound in seconds.
Public variable float MaxDistance The max distance of the asset, as determined by attenuation settings.
Public variable 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.
Public variable float 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).
Public variable TObjectPtr< USoundClass > SoundClassObject Sound class this sound belongs to
Public variable TObjectPtr< USoundSubmixBase > SoundSubmixObject Submix to route sound output to.
Public variable TArray< FSoundSubmixSendInfo > SoundSubmixSends Array of submix sends to which a prescribed amount (see 'Send Level') of this sound is sent.
Public variable TObjectPtr< USoundEffectSourcePresetChain > SourceEffectChain The source effect chain to use for this sound.
Public variable float TotalSamples Total number of samples (in the thousands).
Public variable EVirtualizationMode VirtualizationMode Virtualization behavior, determining if a sound may revive and how it continues playing when culled or evicted (limited to looping sounds).

Constructors

  Type Name Description
Public function  

USoundBase ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual Const TSharedPtr< Audio::IParameterTransmitter > Creates a parameter transmitter for communicating with active sound instances.
Public function Virtual ISoundGeneratorPtr Creates a sound generator instance from this sound base.
Public function Virtual ISoundGeneratorPtr

CreateSoundGenerator ( const FSoundGeneratorInitParams& InParams,
TArray< FAudioParameter >&& InDefaultParameters
)

 Creates a sound generator instance from this sound base.
Public function Virtual Const bool Whether or not this sound allows submix sends on preview.
Public function Virtual Const bool Gets all the default parameters for this Asset.
Public function Virtual Const const FSoundAttenuationSettings * Returns a pointer to the attenuation settings that are to be applied for this node
Public function Const void

GetConcurrencyHandles ( TArray< FConcurrencyHandle >& OutConcurrencyHandles
)

 Returns an array of FSoundConcurrencySettings handles.
Public function Virtual Const UCurveTable * Returns curves associated with this sound if it has any.
Public function Virtual Const float Returns the length of the sound
Public function Virtual Const float Returns the farthest distance at which the sound could be heard
Public function Virtual float  
Public function Const float Returns the priority to use when evaluating concurrency.
Public function Virtual Const USoundClass * Returns the SoundClass used for this sound.
Public function Const void

GetSoundSourceBusSends ( EBusSendType BusSendType,
TArray< FSoundSourceBusSendInfo >& OutSends
)

 Returns the sound source sends for this sound.
Public function Virtual Const USoundSubmixBase * Returns the SoundSubmix used for this sound.
Public function Const void Returns the sound submix sends for this sound.
Public function Virtual bool Returns whether the sound has cooked analysis data (e.g. FFT or envelope following data) and returns sound waves which have cooked data.
Public function Virtual Const float Returns the subtitle priority
Public function Const TOptional< FSoundTimecodeOffset >  
Public function Virtual float  
Public function Virtual Const bool Returns whether or not this sound base has an attenuation node.
Public function Const bool Returns whether or not this sound has a sequencer node, which means it's possible for the owning active sound to persist even though it's not generating audio.
Public function Virtual Const bool  
Public function Virtual Const bool Queries if the sound has cooked FFT or envelope data.
Public function Const bool Returns whether or not this sound has a delay node, which means it's possible for the sound to not generate audio for a while.
Public function Virtual Const bool Whether or not the given sound is a generator and implements an interface with the given name.
Public function Virtual void

InitParameters ( TArray< FAudioParameter >& ParametersToInit,
FName InFeatureName
)

 Called from the Game Thread prior to attempting to pass parameters to the ParameterTransmitter.
Public function Virtual void Called from the Game Thread prior to attempting to initialize a sound instance.
Public function Virtual Const bool Only used as an edit condition for AttenuationSettings member, as base classes may choose to provide an attenuation override implementation
Public function Virtual Const bool Returns whether or not this sound is looping.
Public function Virtual Const bool Query if it's one shot. One shot is defined as a sound which is intended to have a fixed duration.
Public function Virtual Const bool

IsParameterValid ( const FAudioParameter& InParameter
)

 Returns whether parameter is valid input for the given sound
Public function Virtual Const bool Returns whether the sound base is set up in a playable manner
Public function Virtual Const bool Returns true if any of the sounds in the sound have "play when silent" enabled.
Public function Virtual void

Parse ( FAudioDevice* AudioDevice,
const UPTRINT NodeWaveInstanceHash,
FActiveSound& ActiveSound,
const FSoundParseParameters& ParseParams,
TArray< FWaveInstance* >& WaveInstances
)

 Parses the Sound to generate the WaveInstances to play.
Public function void

SetTimecodeOffset ( const FSoundTimecodeOffset& InTimecodeOffset
)

  
Public function Virtual bool Returns whether or not any part of this sound wants interior volumes applied to it
Public function Virtual Const bool Returns whether sound supports subtitles.

Overridden from UObject

  Type Name Description
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from UObjectBaseUtility

  Type Name Description
Public function Virtual Const bool Called after load to determine if the object can be a cluster root
Public function Virtual Const bool Called during cluster construction if the object can be added to a cluster

Overridden from IInterface_AssetUserData

  Type Name Description
Public function Virtual void  
Public function Virtual Const const TArray< UAssetUserData * > *  
Public function Virtual UAssetUserData *  
Public function Virtual void  

Deprecated Variables

  Type Name Description
Public variable uint8: 1 bHasVirtualizeWhenSilent_DEPRECATED  
Public variable uint8: 1 bOutputToBusOnly_DEPRECATED Whether or not to only send this audio's output to a bus.
Public variable int32 MaxConcurrentPlayCount_DEPRECATED Maximum number of times this sound can be played concurrently.
Public variable TEnumAsByte< EMaxConcurrentResolutionRule::Type > MaxConcurrentResolutionRule_DEPRECATED  
Public variable TObjectPtr< USoundConcurrency > SoundConcurrencySettings_DEPRECATED If Override Concurrency is false, the sound concurrency settings to use for this sound.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page