unreal.TechAudioToolsFloatMapping

class unreal.TechAudioToolsFloatMapping(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

Base class for any float value mapping that translates between two domains: - Source domain: range used by an internal system (e.g. a MetaSound that uses linear gain or frequency multiplier). - Display domain: how that value is shown or edited in the UI (e.g. sliders or knobs that use decibels or semitones).

C++ Source:

  • Plugin: TechAudioTools

  • Module: TechAudioTools

  • File: TechAudioToolsFloatMapping.h

Editor Properties: (see get_editor_property/set_editor_property)

  • display_pitch_units (TechAudioToolsPitchUnit): [Read-Write] Units to show pitch in a user interface.

  • display_range (FloatInterval): [Read-Write] Range displayed in a user interface.

  • display_range_decibels (FloatInterval): [Read-Write] Range in decibels to display in a user interface.

  • display_range_frequency_multiplier (FloatInterval): [Read-Write] Range in frequency multiplier to display in a user interface.

  • display_range_linear_gain (FloatInterval): [Read-Write] Range in linear gain to display in a user interface.

  • display_range_semitones (FloatInterval): [Read-Write] Range in semitones to display in a user interface.

  • display_units (TechAudioToolsFloatUnit): [Read-Write] Units used to label the display range.

  • display_volume_units (TechAudioToolsVolumeUnit): [Read-Write] Units to show volume in a user interface.

  • mapping_type (TechAudioToolsFloatMappingType): [Read-Write] Selects the mapping mode.

  • range (FloatInterval): [Read-Write] Default min/max values.

  • source_pitch_units (TechAudioToolsPitchUnit): [Read-Write] Units of the internal pitch value.

  • source_range (FloatInterval): [Read-Write] Range used by an internal system.

  • source_volume_units (TechAudioToolsVolumeUnit): [Read-Write] Units of the internal volume value.

property display_units: TechAudioToolsFloatUnit

[Read-Write] Units used to label the display range.

Type:

(TechAudioToolsFloatUnit)

get_display_max() → float

Returns the range maximum of the display range.

Return type:

float

get_display_min() → float

Returns the range minimum of the display range.

Return type:

float

get_source_max() → float

Returns the range maximum of the source range.

Return type:

float

get_source_min() → float

Returns the range minimum of the source range.

Return type:

float

get_units(endpoint) → TechAudioToolsFloatUnit

Returns the units used by the Source or Display endpoints.

Parameters:

endpoint (TechAudioToolsMappingEndpoint)

Return type:

TechAudioToolsFloatUnit