Class SynthComponent

Synth Component

Inheritance
System.Object
UObject
ActorComponent
SceneComponent
SynthComponent
AudioCaptureComponent
MediaSoundComponent
VoipListenerSynthComponent
Inherited Members
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.AudioMixer
Assembly: UE4DotNet.dll
Syntax
public class SynthComponent : SceneComponent

Properties

| Improve this Doc View Source

AttenuationOverrides

If bOverrideSettings is true, the attenuation properties to use for sounds generated by this component

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

AttenuationSettings

If bOverrideSettings is false, the asset to use to determine attenuation properties for sounds generated by this component

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

AudioComponent

Audio Component

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

bAllowSpatialization

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

bAutoDestroy

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

bIsPreviewSound

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

bIsUISound

Declaration
public bool bIsUISound { 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

bOverrideAttenuation

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

bStopWhenOwnerDestroyed

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

ConcurrencySettings

What sound concurrency to use for sounds generated by this audio component

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

DefaultObject

Get UE4 Default Object for this Class

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

EnvelopeFollowerAttackTime

The attack time in milliseconds for the envelope follower. Delegate callbacks can be registered to get the envelope value of sounds played with this audio component. Only used in audio mixer.

Declaration
public int EnvelopeFollowerAttackTime { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

EnvelopeFollowerReleaseTime

The release time in milliseconds for the envelope follower. Delegate callbacks can be registered to get the envelope value of sounds played with this audio component. Only used in audio mixer.

Declaration
public int EnvelopeFollowerReleaseTime { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

SoundClass

Sound class this sound belongs to

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

SoundSubmix

Submix this sound belongs to

Declaration
public SoundSubmix SoundSubmix { get; set; }
Property Value
Type Description
SoundSubmix
| 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

Synth

Synth

Declaration
public SynthSound Synth { get; set; }
Property Value
Type Description
SynthSound

Methods

| Improve this Doc View Source

IsPlaying()

Returns true if this component is currently playing.

Declaration
public bool IsPlaying()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static SynthComponent New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
SynthComponent
| Improve this Doc View Source

SetSubmixSend(SoundSubmix, Single)

Sets how much audio the sound should send to the given submix.

Declaration
public void SetSubmixSend(SoundSubmix Submix, float SendLevel)
Parameters
Type Name Description
SoundSubmix Submix
System.Single SendLevel
| Improve this Doc View Source

SetVolumeMultiplier(Single)

Sets how much audio the sound should send to the given submix.

Declaration
public void SetVolumeMultiplier(float VolumeMultiplier)
Parameters
Type Name Description
System.Single VolumeMultiplier
| Improve this Doc View Source

Start()

Starts the synth generating audio.

Declaration
public void Start()
| Improve this Doc View Source

Stop()

Stops the synth generating audio.

Declaration
public void Stop()

Operators

| Improve this Doc View Source

Implicit(IntPtr to SynthComponent)

Convert from IntPtr to UObject

Declaration
public static implicit operator SynthComponent(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
SynthComponent