unreal.SoundWave
¶
- class unreal.SoundWave(outer: Optional[Object] = None, name: Union[Name, str] = 'None')¶
Bases:
SoundBase
Sound Wave
C++ Source:
Module: Engine
File: SoundWave.h
Editor Properties: (see get_editor_property/set_editor_property)
asset_import_data
(AssetImportData): [Read-Only] Asset Import Dataasset_user_data
(Array[AssetUserData]): [Read-Write] Asset User Data: Array of user data stored with the assetattenuation_settings
(SoundAttenuation): [Read-Write] Attenuation Settings: Attenuation settings package for the soundbus_sends
(Array[SoundSourceBusSendInfo]): [Read-Write] Bus Sends: This sound will send its audio output to this list of buses if there are bus instances playing after source effects are processed.bypass_volume_scale_for_priority
(bool): [Read-Write] Bypass Volume Scale for Priority: Bypass volume weighting priority upon evaluating whether sound should remain active when max channel count is met (See platform Audio Settings).comment
(str): [Read-Write] Comment: Provides contextual information for the sound to the translator.compression_quality
(int32): [Read-Write] Compression Quality: Platform agnostic compression quality. 1..100 with 1 being best compression and 100 being best quality. ADPCM and PCM sound asset compression types ignore this parameter.concurrency_overrides
(SoundConcurrencySettings): [Read-Write] Concurrency Overrides: If Override Concurrency is true, concurrency settings to use.concurrency_set
(Set[SoundConcurrency]): [Read-Write] Concurrency Set: Set of concurrency settings to observe (if override is set to false). Sound must pass all concurrency settings to play.cue_points
(Array[SoundWaveCuePoint]): [Read-Only] Cue Points: Cue point datacurves
(CurveTable): [Read-Write] Curves: Curves associated with this sound wavedebug
(bool): [Read-Write] Debug: When “au.3dVisualize.Attenuation” has been specified, draw this sound’s attenuation shape when the sound is audible. For debugging purposes only.duration
(float): [Read-Only] Duration: Duration of sound in seconds.enable_amplitude_envelope_analysis
(bool): [Read-Write] Enable Amplitude Envelope Analysis: Whether or not to enable cook-time amplitude envelope analysis.enable_baked_fft_analysis
(bool): [Read-Write] Enable Baked FFTAnalysis: Whether or not to enable cook-time baked FFT analysis.enable_base_submix
(bool): [Read-Write] Enable Base Submix: If enabled, sound will route to the Master Submix by default or to the Base Submix if defined. If disabled, sound will route ONLY to the Submix Sends and/or Bus Sendsenable_bus_sends
(bool): [Read-Write] Enable Bus Sends: Whether or not to enable sending this audio’s output to buses.enable_submix_sends
(bool): [Read-Write] Enable Submix Sends: Whether or not to enable Submix Sends other than the Base Submix.envelope_follower_attack_time
(int32): [Read-Write] Envelope Follower Attack Time: The attack time in milliseconds. Describes how quickly the envelope analyzer responds to increasing amplitudes.envelope_follower_frame_size
(int32): [Read-Write] Envelope Follower Frame Size: How many audio frames to average a new envelope value. Larger values use less memory for audio envelope data but will result in lower envelope accuracy.envelope_follower_release_time
(int32): [Read-Write] Envelope Follower Release Time: The release time in milliseconds. Describes how quickly the envelope analyzer responds to decreasing amplitudes.fft_analysis_attack_time
(int32): [Read-Write] FFTAnalysis Attack Time: Attack time in milliseconds of the spectral envelope follower.fft_analysis_frame_size
(int32): [Read-Write] FFTAnalysis Frame Size: How many audio frames analyze at a time.fft_analysis_release_time
(int32): [Read-Write] FFTAnalysis Release Time: Release time in milliseconds of the spectral envelope follower.fft_size
(SoundWaveFFTSize): [Read-Write] FFTSize: The FFT window size to use for fft analysis.frequencies_to_analyze
(Array[float]): [Read-Write] Frequencies to Analyze: The frequencies (in hz) to analyze when doing baked FFT analysis.imported_sample_rate
(int32): [Read-Only] Imported Sample Rate: Sample rate of the imported sound wave.initial_chunk_size
(int32): [Read-Write] Initial Chunk Size: Use this to override how much audio data is loaded when this USoundWave is loaded.is_ambisonics
(bool): [Read-Write] Is Ambisonics: Whether or not this source is ambisonics file format. If set, sound always uses the ‘Master Ambisonics Submix’ as set in the ‘Audio’ category of Project Settings’ and ignores submix if provided locally or in the referenced SoundClass.loading_behavior
(SoundWaveLoadingBehavior): [Read-Write] Loading Behavior: Specifies how and when compressed audio data is loaded for asset if stream caching is enabled.looping
(bool): [Read-Write] Looping: If set, when played directly (not through a sound cue) the wave will be played looping.manual_word_wrap
(bool): [Read-Write] Manual Word Wrap: If set to true will disable automatic generation of line breaks - use if the subtitles have been split manually.mature
(bool): [Read-Write] Mature: If set to true if this sound is considered to contain mature/adult content.max_distance
(float): [Read-Only] Max Distance: The max distance of the asset, as determined by attenuation settings.modulation_settings
(SoundModulationDefaultRoutingSettings): [Read-Write] Modulation Settings: Modulation Settingsnum_channels
(int32): [Read-Only] Num Channels: Number of channels of multichannel data; 1 or 2 for regular mono and stereo filesoverride_concurrency
(bool): [Read-Write] Override Concurrency: Whether or not to override the sound concurrency object with local concurrency settings.override_sound_to_use_for_analysis
(SoundWave): [Read-Write] Override Sound to Use for Analysis: Specify a sound to use for the baked analysis. Will default to this USoundWave if not set.pitch
(float): [Read-Write] Pitch: Playback pitch for sound.pre_effect_bus_sends
(Array[SoundSourceBusSendInfo]): [Read-Write] Pre Effect Bus Sends: This sound will send its audio output to this list of buses if there are bus instances playing before source effects are processed.priority
(float): [Read-Write] Priority: Used to determine whether sound can play or remain active if channel limit is met, where higher value is higher priority (see platform’s Audio Settings ‘Max Channels’ property). Unless bypassed, value is weighted with the final volume of the sound to produce final runtime priority value.sample_rate
(int32): [Read-Only] Sample Rate: Cooked sample rate of the asset. Can be modified by sample rate override.sample_rate_quality
(SoundwaveSampleRateSettings): [Read-Write] Sample Rate Quality: Quality of sample rate conversion for platforms that opt into resampling during cook. The sample rate for each enumeration is definable per platform in platform target settings.seekable_streaming
(bool): [Read-Write] Seekable Streaming: Deprecated compression type properties deprecated: 5.0 - Property is deprecated. bSeekableStreaming now means ADPCM codec in SoundAssetCompressionType.single_line
(bool): [Read-Write] Single Line: If set to true the subtitles display as a sequence of single lines as opposed to multiline.sound_asset_compression_type
(SoundAssetCompressionType): [Read-Write] Sound Asset Compression Type: The compression type to use for the sound wave asset.sound_class_object
(SoundClass): [Read-Write] Sound Class Object: Sound class this sound belongs tosound_group
(SoundGroup): [Read-Write] Sound Groupsound_submix_object
(SoundSubmixBase): [Read-Write] Sound Submix Object: Submix to route sound output to. If unset, falls back to referenced SoundClass submix. If SoundClass submix is unset, sends to the ‘Master Submix’ as set in the ‘Audio’ category of Project Settings’.sound_submix_sends
(Array[SoundSubmixSendInfo]): [Read-Write] Sound Submix Sends: Array of submix sends to which a prescribed amount (see ‘Send Level’) of this sound is sent.source_effect_chain
(SoundEffectSourcePresetChain): [Read-Write] Source Effect Chain: The source effect chain to use for this sound.spoken_text
(str): [Read-Write] Spoken Text: A localized version of the text that is actually spoken phonetically in the audio. deprecated: Use Subtitles instead.streaming_priority
(int32): [Read-Write] Streaming Priority deprecated: 5.0 - Property is deprecated. Streaming priority has no effect with stream caching enabled.subtitle_priority
(float): [Read-Write] Subtitle Priority: The priority of the subtitle.subtitles
(Array[SubtitleCue]): [Read-Write] Subtitles: Subtitle cues.timecode_info
(SoundWaveTimecodeInfo): [Read-Only] Timecode Info: Information about the time-code from import, if available.total_samples
(float): [Read-Only] Total Samples: Total number of samples (in the thousands). Useful as a metric to analyze the relative size of a given sound asset in content browser.transformations
(Array[WaveformTransformationBase]): [Read-Write] Transformations: Waveform edits to be applied to this SoundWave on cook (editing transformations will trigger a cook)treat_file_as_looping_for_analysis
(bool): [Read-Write] Treat File as Looping for Analysis: Whether or not we should treat the sound wave used for analysis (this or the override) as looping while performing analysis. A looping sound may include the end of the file for inclusion in analysis for envelope and FFT analysis.use_bink_audio
(bool): [Read-Write] Use Bink Audio deprecated: 5.0 - Property is deprecated. bUseBinkAudio now means Bink codec in SoundAssetCompressionType.virtualization_mode
(VirtualizationMode): [Read-Write] Virtualization Mode: Virtualization behavior, determining if a sound may revive and how it continues playing when culled or evicted (limited to looping sounds).volume
(float): [Read-Write] Volume: Playback volume of sound 0 to 1 - Default is 1.0.
- property cue_points: Array[SoundWaveCuePoint]¶
[Read-Only] Cue Points: Cue point data
- Type:
- get_sound_asset_compression_type() SoundAssetCompressionType ¶
Returns the sound’s asset compression type.
- Return type:
- property manual_word_wrap: bool¶
[Read-Only] Manual Word Wrap: If set to true will disable automatic generation of line breaks - use if the subtitles have been split manually.
- Type:
(bool)
- property mature: bool¶
[Read-Only] Mature: If set to true if this sound is considered to contain mature/adult content.
- Type:
(bool)
- property modulation_settings: SoundModulationDefaultRoutingSettings¶
[Read-Write] Modulation Settings: Modulation Settings
- property seekable_streaming: bool¶
[Read-Write] Seekable Streaming: Deprecated compression type properties deprecated: 5.0 - Property is deprecated. bSeekableStreaming now means ADPCM codec in SoundAssetCompressionType.
- Type:
(bool)
- set_sound_asset_compression_type(sound_asset_compression_type, mark_dirty=True) None ¶
Procedurally set the compression type.
- Parameters:
sound_asset_compression_type (SoundAssetCompressionType) –
mark_dirty (bool) –
- property single_line: bool¶
[Read-Only] Single Line: If set to true the subtitles display as a sequence of single lines as opposed to multiline.
- Type:
(bool)
- property spoken_text: str¶
[Read-Write] Spoken Text: A localized version of the text that is actually spoken phonetically in the audio. deprecated: Use Subtitles instead.
- Type:
(str)
- property streaming_priority: int¶
[Read-Write] Streaming Priority deprecated: 5.0 - Property is deprecated. Streaming priority has no effect with stream caching enabled.
- Type:
(int32)
- property subtitle_priority: float¶
[Read-Only] Subtitle Priority: The priority of the subtitle.
- Type:
(float)
- property subtitles: Array[SubtitleCue]¶
[Read-Only] Subtitles: Subtitle cues.
- Type:
(Array[SubtitleCue])