unreal.SoundSubmix
¶
-
class
unreal.
SoundSubmix
(outer=None, name='None')¶ Bases:
unreal.SoundSubmixWithParentBase
Sound Submix class meant for applying an effect to the downmixed sum of multiple audio sources.
C++ Source:
Module: Engine
File: SoundSubmix.h
Editor Properties: (see get_editor_property/set_editor_property)
ambisonics_plugin_settings
(SoundfieldEncodingSettingsBase): [Read-Write] Optional settings used by plugins which support ambisonics file playback.child_submixes
(Array(SoundSubmixBase)): [Read-Only] Child submixes to this sound mixdry_level
(float): [Read-Write] The dry level of the submix. Applied before submix effects and analysis are performed.dry_level_db
(float): [Read-Write] The dry level of the submix (in dB)s. Applied before submix effects and analysis are performed.envelope_follower_attack_time
(int32): [Read-Write] 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.envelope_follower_release_time
(int32): [Read-Write] 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.gain_mode
(GainParamMode): [Read-Write] Whether to treat submix gain levels as linear or decibel values.mute_when_backgrounded
(bool): [Read-Write] Mute this submix when the application is muted or in the background. Used to prevent submix effect tails from continuing when tabbing out of application or if application is muted.on_submix_recorded_file_done
(OnSubmixRecordedFileDone): [Read-Write] Blueprint delegate for when a recorded file is finished exporting.output_volume
(float): [Read-Write] The output volume of the submix. Applied after submix effects and analysis are performed.output_volume_db
(float): [Read-Write] The output volume of the submix (in dB).parent_submix
(SoundSubmixBase): [Read-Only] Parent Submixsubmix_effect_chain
(Array(SoundEffectSubmixPreset)): [Read-Write] Submix Effect Chainwet_level
(float): [Read-Write] The wet level of the submix. Applied after submix effects and analysis are performed.wet_level_db
(float): [Read-Write] The wet level of the submix (in dB). Applied after submix effects and analysis are performed.
-
add_envelope_follower_delegate
(world_context_object, on_submix_envelope_bp) → None¶ Adds an envelope follower delegate to the submix when envelope following is enabled on this submix.
- Parameters
world_context_object (Object) –
on_submix_envelope_bp (OnSubmixEnvelopeBP) – Event to fire when new envelope data is available.
-
add_spectral_analysis_delegate
(world_context_object, band_settings, on_submix_spectral_analysis_bp, update_rate=10.0, decibel_noise_floor=- 40.0, do_normalize=True, do_auto_range=False, auto_range_attack_time=0.1, auto_range_release_time=60.0) → None¶ Adds a spectral analysis delegate to receive notifications when this submix has spectrum analysis enabled.
- Parameters
world_context_object (Object) –
band_settings (Array(SoundSubmixSpectralAnalysisBandSettings)) – The frequency bands to analyze and their envelope-following settings.
on_submix_spectral_analysis_bp (OnSubmixSpectralAnalysisBP) – Event to fire when new spectral data is available.
update_rate (float) – How often to retrieve the data from the spectral analyzer and broadcast the event. Max is 30 times per second.
decibel_noise_floor (float) – Decibel Noise Floor to consider as silence silence when using a Decibel Spectrum Type.
do_normalize (bool) – If true, output band values will be normalized between zero and one.
do_auto_range (bool) – If true, output band values will have their ranges automatically adjusted to the minimum and maximum values in the audio. Output band values will be normalized between zero and one.
auto_range_attack_time (float) – The time (in seconds) it takes for the range to expand to 90% of a larger range.
auto_range_release_time (float) – The time (in seconds) it takes for the range to shrink to 90% of a smaller range.
-
property
ambisonics_plugin_settings
¶ [Read-Write] Optional settings used by plugins which support ambisonics file playback.
-
property
dry_level
¶ [Read-Write] The dry level of the submix. Applied before submix effects and analysis are performed.
- Type
(float)
-
property
dry_level_db
¶ [Read-Write] The dry level of the submix (in dB)s. Applied before submix effects and analysis are performed.
- Type
(float)
-
property
envelope_follower_attack_time
¶ [Read-Write] 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.
- Type
(int32)
-
property
envelope_follower_release_time
¶ [Read-Write] 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.
- Type
(int32)
-
property
mute_when_backgrounded
¶ [Read-Only] Mute this submix when the application is muted or in the background. Used to prevent submix effect tails from continuing when tabbing out of application or if application is muted.
- Type
(bool)
-
property
on_submix_recorded_file_done
¶ [Read-Write] Blueprint delegate for when a recorded file is finished exporting.
- Type
-
property
output_volume
¶ [Read-Write] The output volume of the submix. Applied after submix effects and analysis are performed.
- Type
(float)
-
remove_spectral_analysis_delegate
(world_context_object, on_submix_spectral_analysis_bp) → None¶ Remove a spectral analysis delegate.
- Parameters
world_context_object (Object) –
on_submix_spectral_analysis_bp (OnSubmixSpectralAnalysisBP) – The event delegate to remove.
-
set_submix_output_volume
(world_context_object, output_volume) → None¶ Sets the output volume of the submix. This dynamic volume scales with the OutputVolume property of this submix.
-
start_envelope_following
(world_context_object) → None¶ Start envelope following the submix output. Register with OnSubmixEnvelope to receive envelope follower data in BP.
- Parameters
world_context_object (Object) –
-
start_recording_output
(world_context_object, expected_duration) → None¶ Start recording the audio from this submix.
-
start_spectral_analysis
(world_context_object, fft_size=FFTSize.DEFAULT_SIZE, interpolation_method=FFTPeakInterpolationMethod.LINEAR, window_type=FFTWindowType.HANN, hop_size=0.0, spectrum_type=AudioSpectrumType.MAGNITUDE_SPECTRUM) → None¶ Start spectrum analysis of the audio output.
- Parameters
world_context_object (Object) –
fft_size (FFTSize) –
interpolation_method (FFTPeakInterpolationMethod) –
window_type (FFTWindowType) –
hop_size (float) –
spectrum_type (AudioSpectrumType) –
-
stop_envelope_following
(world_context_object) → None¶ Start envelope following the submix output. Register with OnSubmixEnvelope to receive envelope follower data in BP.
- Parameters
world_context_object (Object) –
-
stop_recording_output
(world_context_object, export_type, name, path, existing_sound_wave_to_overwrite=None) → None¶ Finish recording the audio from this submix and export it as a wav file or a USoundWave.
- Parameters
world_context_object (Object) –
export_type (AudioRecordingExportType) –
name (str) –
path (str) –
existing_sound_wave_to_overwrite (SoundWave) –
-
stop_spectral_analysis
(world_context_object) → None¶ Start spectrum analysis of the audio output.
- Parameters
world_context_object (Object) –
-
property
submix_effect_chain
¶ [Read-Only] Submix Effect Chain
- Type