unreal.TimeSynthComponent

class unreal.TimeSynthComponent(outer=None, name='None')

Bases: unreal.SynthComponent

Time Synth Component

C++ Source:

  • Plugin: TimeSynth

  • Module: TimeSynth

  • File: TimeSynthComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

  • absolute_location (bool): [Read-Write] If RelativeLocation should be considered relative to the world, rather than the parent

  • absolute_rotation (bool): [Read-Write] If RelativeRotation should be considered relative to the world, rather than the parent

  • absolute_scale (bool): [Read-Write] If RelativeScale3D should be considered relative to the world, rather than the parent

  • allow_spatialization (bool): [Read-Write] Is this audio component allowed to be spatialized?

  • asset_user_data (Array(AssetUserData)): [Read-Write] Array of user data stored with the component

  • attenuation_overrides (SoundAttenuationSettings): [Read-Write] If bOverrideSettings is true, the attenuation properties to use for sounds generated by this component

  • attenuation_settings (SoundAttenuation): [Read-Write] If bOverrideSettings is false, the asset to use to determine attenuation properties for sounds generated by this component

  • auto_activate (bool): [Read-Write] Whether the component is activated at creation or must be explicitly activated.

  • bus_sends (Array(SoundSourceBusSendInfo)): [Read-Write] This sound will send its audio output to this list of buses if there are bus instances playing after source effects are processed.

  • can_ever_affect_navigation (bool): [Read-Write] Whether this component can potentially influence navigation

  • component_tags (Array(Name)): [Read-Write] Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.

  • concurrency_set (Set(SoundConcurrency)): [Read-Write] What sound concurrency to use for sounds generated by this audio component

  • detail_mode (DetailMode): [Read-Write] If detail mode is >= system detail mode, primitive won’t be rendered.

  • editable_when_inherited (bool): [Read-Write] True if this component can be modified when it was inherited from a parent actor class

  • enable_base_submix (bool): [Read-Write] 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 Sends

  • enable_bus_sends (bool): [Read-Write] Whether or not to enable sending this audio’s output to buses.

  • enable_spectral_analysis (bool): [Read-Write] Whether or not we are enabling spectrum analysis on the synth component. Enabling will result in FFT analysis being run.

  • enable_submix_sends (bool): [Read-Write] Whether or not to enable Submix Sends other than the Base Submix.

  • 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 audio component. Only used in audio mixer.

  • 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 audio component. Only used in audio mixer.

  • envelope_follower_settings (TimeSynthEnvelopeFollowerSettings): [Read-Write] The envelope follower settings to use

  • fft_size (TimeSynthFFTSize): [Read-Write] What FFT bin-size to use. Smaller makes it more time-reactive but less accurate in frequency space.

  • filter_a_settings (TimeSynthFilterSettings): [Read-Write] The filter settings to use for filter A

  • filter_b_settings (TimeSynthFilterSettings): [Read-Write] The filter settings to use for filter B

  • frequencies_to_analyze (Array(float)): [Read-Write] What frequencies to report magnitudes for during spectrum analysis

  • hidden_in_game (bool): [Read-Write] Whether to hide the primitive in game, if the primitive is Visible.

  • is_editor_only (bool): [Read-Write] If true, the component will be excluded from non-editor builds

  • is_envelope_follower_enabled (bool): [Read-Write] Whether or not the filter is enabled

  • is_filter_a_enabled (bool): [Read-Write] Whether or not the filter A is enabled

  • is_filter_b_enabled (bool): [Read-Write] Whether or not the filter B is enabled

  • is_ui_sound (bool): [Read-Write] Whether or not this sound plays when the game is paused in the UI

  • max_pool_size (int32): [Read-Write] Set the Max Pool Size

  • mobility (ComponentMobility): [Read-Write] How often this component is allowed to move, used to make various optimizations. Only safe to set in constructor.

  • on_audio_envelope_value (OnSynthEnvelopeValue): [Read-Write] On Audio Envelope Value

  • on_component_activated (ActorComponentActivatedSignature): [Read-Write] Called when the component has been activated, with parameter indicating if it was from a reset

  • on_component_deactivated (ActorComponentDeactivateSignature): [Read-Write] Called when the component has been deactivated

  • on_playback_time (OnTimeSynthPlaybackTime): [Read-Write] Delegate to get continuous playback time in seconds

  • override_attenuation (bool): [Read-Write] Should the Attenuation Settings asset be used (false) or should the properties set directly on the component be used for attenuation properties

  • physics_volume_changed_delegate (PhysicsVolumeChanged): [Read-Write] Delegate that will be called when PhysicsVolume has been changed *

  • pre_effect_bus_sends (Array(SoundSourceBusSendInfo)): [Read-Write] This sound will send its audio output to this list of buses if there are bus instances playing before source effects are processed.

  • primary_component_tick (ActorComponentTickFunction): [Read-Write] Main tick function for the Component

  • quantization_settings (TimeSynthQuantizationSettings): [Read-Write] The default quantizations settings

  • relative_location (Vector): [Read-Write] Location of the component relative to its parent

  • relative_rotation (Rotator): [Read-Write] Rotation of the component relative to its parent

  • relative_scale3d (Vector): [Read-Write] Non-uniform scaling of the component relative to its parent. Note that scaling is always applied in local space (no shearing etc)

  • replicates (bool): [Read-Write] Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!

  • should_update_physics_volume (bool): [Read-Write] Whether or not the cached PhysicsVolume this component overlaps should be updated when the component is moved. see: GetPhysicsVolume()

  • sound_class (SoundClass): [Read-Write] Sound class this sound belongs to

  • sound_submix (SoundSubmixBase): [Read-Write] Submix this sound belongs to

  • sound_submix_sends (Array(SoundSubmixSendInfo)): [Read-Write] An array of submix sends. Audio from this sound will send a portion of its audio to these effects.

  • source_effect_chain (SoundEffectSourcePresetChain): [Read-Write] The source effect chain to use for this sound.

  • use_attach_parent_bound (bool): [Read-Write] If true, this component uses its parents bounds when attached. This can be a significant optimization with many components attached together.

  • visible (bool): [Read-Write] Whether to completely draw the primitive; if false, the primitive is not drawn, does not cast a shadow.

add_quantization_event_delegate(quantization_type, on_quantization_event) → None

Register an event to respond to a specific quantization event

Parameters
property enable_spectral_analysis

[Read-Write] Whether or not we are enabling spectrum analysis on the synth component. Enabling will result in FFT analysis being run.

Type

(bool)

property envelope_follower_settings

[Read-Write] The envelope follower settings to use

Type

(TimeSynthEnvelopeFollowerSettings)

property fft_size

[Read-Write] What FFT bin-size to use. Smaller makes it more time-reactive but less accurate in frequency space.

Type

(TimeSynthFFTSize)

property filter_a_settings

[Read-Write] The filter settings to use for filter A

Type

(TimeSynthFilterSettings)

property filter_b_settings

[Read-Write] The filter settings to use for filter B

Type

(TimeSynthFilterSettings)

property frequencies_to_analyze

[Read-Write] What frequencies to report magnitudes for during spectrum analysis

Type

(Array(float))

get_bpm() → int32

Returns the current BPM of the time synth

Returns

Return type

int32

get_envelope_follower_value() → float

Returns the current envelope follower value. Call at whatever rate desired

Returns

Return type

float

get_max_active_clip_limit() → int32

Get Max Active Clip Limit

Returns

Return type

int32

get_spectral_data()

Returns the spectral data if spectrum analysis is enabled.

Returns

Return type

Array(TimeSynthSpectralData)

has_active_clips() → bool

Check to see if clips are actively generating sound on the TimeSynth

Returns

Return type

bool

property is_envelope_follower_enabled

[Read-Write] Whether or not the filter is enabled

Type

(bool)

property is_filter_a_enabled

[Read-Write] Whether or not the filter A is enabled

Type

(bool)

property is_filter_b_enabled

[Read-Write] Whether or not the filter B is enabled

Type

(bool)

property max_pool_size

[Read-Write] Set the Max Pool Size

Type

(int32)

property on_playback_time

[Read-Write] Delegate to get continuous playback time in seconds

Type

(OnTimeSynthPlaybackTime)

play_clip(clip, volume_group=None) → TimeSynthClipHandle

Plays the given clip using the global quantization setting

Parameters
Returns

Return type

TimeSynthClipHandle

property quantization_settings

[Read-Write] The default quantizations settings

Type

(TimeSynthQuantizationSettings)

reset_seed() → None

Resets the internal seed to it’s current seed (allows repeating same random choices)

set_bpm(beats_per_minute) → None

Sets just the BPM of the time synth on the next bar event.

Parameters

beats_per_minute (float) –

set_envelope_follower_enabled(is_enabled) → None

Enables or disables the envelope follower

Parameters

is_enabled (bool) –

set_envelope_follower_settings(settings) → None

Set the envelope follower settings

Parameters

settings (TimeSynthEnvelopeFollowerSettings) –

set_fft_size(fft_size) → None

Sets the desired FFT Size for the spectrum analyzer

Parameters

fft_size (TimeSynthFFTSize) –

set_filter_enabled(filter, is_enabled) → None

Enables or disables the filter

Parameters
set_filter_settings(filter, settings) → None

Set the filter settings for the filter at the particular index

Parameters
set_quantization_settings(quantization_settings) → None

Sets the quantization settings on the time synth

Parameters

quantization_settings (TimeSynthQuantizationSettings) –

set_seed(seed) → None

Sets the seed of the internal random stream so choices can be repeated or controlled.

Parameters

seed (int32) –

set_volume_group(volume_group, volume_db, fade_time_sec=0.0) → None

Sets the volume (in dB) of the given volume group over the supplied FadeTime

Parameters
stop_clip(clip_handle, event_quantization) → None

Stops the clip on the desired quantization boundary with given fade time. Uses clip’s fade time.

Parameters
stop_clip_with_fade_override(clip_handle, event_quantization, fade_time) → None

Stops the clip on the desired quantization boundary with given fade time. Overrides the clip’s fade time.

Parameters
stop_sounds_on_volume_group(volume_group, event_quantization) → None

Stops clips playing on given volume group. Clips use their fade time.

Parameters
stop_sounds_on_volume_group_with_fade_override(volume_group, event_quantization, fade_time) → None

Stops clips playing on given volume group with the given fade time override.

Parameters