Class SoundSubmix

Sound Submix

Inheritance
System.Object
UObject
SoundSubmix
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.Engine
Assembly: UE4DotNet.dll
Syntax
public class SoundSubmix : UObject

Properties

| Improve this Doc View Source

AmbisonicsPluginSettings

TODO: Hide this unless Channel Format is ambisonics. Also, worry about thread safety.

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

ChildSubmixes

Child submixes to this sound mix

Declaration
public ObjectArrayField<SoundSubmix> ChildSubmixes { get; }
Property Value
Type Description
ObjectArrayField<SoundSubmix>
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static SoundSubmix DefaultObject { get; }
Property Value
Type Description
SoundSubmix
| 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 submix.

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 submix.

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

ParentSubmix

Parent Submix

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

SubmixEffectChain

Submix Effect Chain

Declaration
public ObjectArrayField<SoundEffectSubmixPreset> SubmixEffectChain { get; }
Property Value
Type Description
ObjectArrayField<SoundEffectSubmixPreset>

Methods

| Improve this Doc View Source

AddEnvelopeFollowerDelegate(UObject, Byte)

Add Envelope Follower Delegate

Declaration
public void AddEnvelopeFollowerDelegate(UObject WorldContextObject, byte OnSubmixEnvelopeBP)
Parameters
Type Name Description
UObject WorldContextObject
System.Byte OnSubmixEnvelopeBP
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

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

StartEnvelopeFollowing(UObject)

Start envelope following the submix output. Register with OnSubmixEnvelope to receive envelope follower data in BP.

Declaration
public void StartEnvelopeFollowing(UObject WorldContextObject)
Parameters
Type Name Description
UObject WorldContextObject
| Improve this Doc View Source

StartRecordingOutput(UObject, Single)

Start recording the audio from this submix.

Declaration
public void StartRecordingOutput(UObject WorldContextObject, float ExpectedDuration)
Parameters
Type Name Description
UObject WorldContextObject
System.Single ExpectedDuration
| Improve this Doc View Source

StopEnvelopeFollowing(UObject)

Start envelope following the submix output. Register with OnSubmixEnvelope to receive envelope follower data in BP.

Declaration
public void StopEnvelopeFollowing(UObject WorldContextObject)
Parameters
Type Name Description
UObject WorldContextObject
| Improve this Doc View Source

StopRecordingOutput(UObject, EAudioRecordingExportType, String, String, SoundWave)

Finish recording the audio from this submix and export it as a wav file or a USoundWave.

Declaration
public void StopRecordingOutput(UObject WorldContextObject, EAudioRecordingExportType ExportType, string Name, string Path, SoundWave ExistingSoundWaveToOverwrite)
Parameters
Type Name Description
UObject WorldContextObject
EAudioRecordingExportType ExportType
System.String Name
System.String Path
SoundWave ExistingSoundWaveToOverwrite

Operators

| Improve this Doc View Source

Implicit(IntPtr to SoundSubmix)

Convert from IntPtr to UObject

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