Class SoundBase
Sound Base
Inherited Members
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class SoundBase : UObject
Properties
| Improve this Doc View SourceAttenuationSettings
Attenuation settings package for the sound
Declaration
public SoundAttenuation AttenuationSettings { get; set; }
Property Value
Type | Description |
---|---|
SoundAttenuation |
bBypassVolumeScaleForPriority
Declaration
public bool bBypassVolumeScaleForPriority { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
bDebug
Declaration
public bool bDebug { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
bHasConcatenatorNode
Declaration
public bool bHasConcatenatorNode { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
bHasDelayNode
Declaration
public bool bHasDelayNode { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
bHasVirtualizeWhenSilent
Declaration
public bool bHasVirtualizeWhenSilent { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
bOutputToBusOnly
Declaration
public bool bOutputToBusOnly { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
bOverrideConcurrency
Declaration
public bool bOverrideConcurrency { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ConcurrencyOverrides
If Override Concurrency is true, concurrency settings to use.
Declaration
public SoundConcurrencySettings ConcurrencyOverrides { get; set; }
Property Value
Type | Description |
---|---|
SoundConcurrencySettings |
DefaultObject
Get UE4 Default Object for this Class
Declaration
public static SoundBase DefaultObject { get; }
Property Value
Type | Description |
---|---|
SoundBase |
Duration
Duration of sound in seconds.
Declaration
public float Duration { get; }
Property Value
Type | Description |
---|---|
System.Single |
MaxDistance
The max distance of the asset, as determined by attenuation settings.
Declaration
public float MaxDistance { get; }
Property Value
Type | Description |
---|---|
System.Single |
Priority
Sound priority (higher value is higher priority) used for concurrency resolution. This priority value is weighted against the final volume of the sound.
Declaration
public float Priority { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
SoundClassObject
Sound class this sound belongs to
Declaration
public SoundClass SoundClassObject { get; set; }
Property Value
Type | Description |
---|---|
SoundClass |
SoundConcurrencySettings
If Override Concurrency is false, the sound concurrency settings to use for this sound.
Declaration
public SoundConcurrency SoundConcurrencySettings { get; set; }
Property Value
Type | Description |
---|---|
SoundConcurrency |
SoundSubmixObject
Sound submix this sound belongs to.
Declaration
public SoundSubmix SoundSubmixObject { get; set; }
Property Value
Type | Description |
---|---|
SoundSubmix |
Remarks
Audio will play here and traverse through the submix graph. A null entry will make the sound obey the default master effects graph.
SourceEffectChain
The source effect chain to use for this sound.
Declaration
public SoundEffectSourcePresetChain SourceEffectChain { get; set; }
Property Value
Type | Description |
---|---|
SoundEffectSourcePresetChain |
StaticClass
Get UE4 Class
Declaration
public static Class StaticClass { get; }
Property Value
Type | Description |
---|---|
Class |
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.
Declaration
public float TotalSamples { get; }
Property Value
Type | Description |
---|---|
System.Single |
Methods
| Improve this Doc View SourceNew(UObject, Name)
Spawn an object of this class
Declaration
public static SoundBase New(UObject obj = null, Name name = default(Name))
Parameters
Type | Name | Description |
---|---|---|
UObject | obj | |
Name | name |
Returns
Type | Description |
---|---|
SoundBase |
Operators
| Improve this Doc View SourceImplicit(IntPtr to SoundBase)
Convert from IntPtr to UObject
Declaration
public static implicit operator SoundBase(IntPtr p)
Parameters
Type | Name | Description |
---|---|---|
System.IntPtr | p |
Returns
Type | Description |
---|---|
SoundBase |