Show / Hide Table of Contents

Class SoundBase

Sound Base

Inheritance
System.Object
UObject
SoundBase
DialogueSoundWaveProxy
SoundCue
SoundWave
Inherited Members
UObject.TransientPackage
UObject.CastTo<T>(UObject)
UObject.CastTo(UObject, Type)
UObject.RemoveObject(UObject)
UObject.MakeObjectArrayField<T>(NativeArray*)
UObject.NotImplemented<T>()
UObject.Construct()
UObject.GetHashCode()
UObject.GetName()
UObject.ToString()
UObject.Name
UObject._None
UObject.None
UObject.ObjPointer
UObject.LoadObjectFromClass(Class, UObject, String, String, LoadFlags, PackageMap, Boolean)
UObject.LoadClass(Class, UObject, String, String, LoadFlags, PackageMap)
UObject.GetPropertyFor<T>(Name)
UObject.ExecuteUbergraph
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class SoundBase : UObject

Properties

| Improve this Doc View Source

AttenuationSettings

Attenuation settings package for the sound

Declaration
public SoundAttenuation AttenuationSettings { get; set; }
Property Value
Type Description
SoundAttenuation
| Improve this Doc View Source

bBypassVolumeScaleForPriority

Declaration
public bool bBypassVolumeScaleForPriority { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bDebug

Declaration
public bool bDebug { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bHasConcatenatorNode

Declaration
public bool bHasConcatenatorNode { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bHasDelayNode

Declaration
public bool bHasDelayNode { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bHasVirtualizeWhenSilent

Declaration
public bool bHasVirtualizeWhenSilent { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bOutputToBusOnly

Declaration
public bool bOutputToBusOnly { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bOverrideConcurrency

Declaration
public bool bOverrideConcurrency { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

ConcurrencyOverrides

If Override Concurrency is true, concurrency settings to use.

Declaration
public SoundConcurrencySettings ConcurrencyOverrides { get; set; }
Property Value
Type Description
SoundConcurrencySettings
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static SoundBase DefaultObject { get; }
Property Value
Type Description
SoundBase
| Improve this Doc View Source

Duration

Duration of sound in seconds.

Declaration
public float Duration { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

MaxDistance

The max distance of the asset, as determined by attenuation settings.

Declaration
public float MaxDistance { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

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
| Improve this Doc View Source

SoundClassObject

Sound class this sound belongs to

Declaration
public SoundClass SoundClassObject { get; set; }
Property Value
Type Description
SoundClass
| Improve this Doc View Source

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
| Improve this Doc View Source

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.

| Improve this Doc View Source

SourceEffectChain

The source effect chain to use for this sound.

Declaration
public SoundEffectSourcePresetChain SourceEffectChain { get; set; }
Property Value
Type Description
SoundEffectSourcePresetChain
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class
| Improve this Doc View Source

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 Source

New(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 Source

Implicit(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
  • Improve this Doc
  • View Source
Back to top Generated by DocFX