unreal.AudioSliderBase

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

Bases: unreal.Widget

An audio slider widget.

C++ Source:

  • Plugin: AudioWidgets

  • Module: AudioWidgets

  • File: AudioSlider.h

Editor Properties: (see get_editor_property/set_editor_property)

  • accessible_behavior (SlateAccessibleBehavior): [Read-Write] Accessible Behavior: Whether or not the widget is accessible, and how to describe it. If set to custom, additional customization options will appear.

  • accessible_summary_behavior (SlateAccessibleBehavior): [Read-Write] Accessible Summary Behavior: How to describe this widget when it’s being presented through a summary of a parent widget. If set to custom, additional customization options will appear.

  • accessible_summary_text (Text): [Read-Write] Accessible Summary Text: When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.

  • accessible_text (Text): [Read-Write] Accessible Text: When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.

  • can_children_be_accessible (bool): [Read-Write] Can Children be Accessible: Whether or not children of this widget can appear as distinct accessible widgets.

  • clipping (WidgetClipping): [Read-Write] Clipping: Controls how the clipping behavior of this widget. Normally content that overflows the bounds of the widget continues rendering. Enabling clipping prevents that overflowing content from being seen.

    NOTE: Elements in different clipping spaces can not be batched together, and so there is a performance cost to clipping. Do not enable clipping unless a panel actually needs to prevent content from showing up outside its bounds.

  • cursor (MouseCursor): [Read-Write] Cursor: The cursor to show when the mouse is over the widget

  • flow_direction_preference (FlowDirectionPreference): [Read-Write] Flow Direction Preference: Allows you to set a new flow direction

  • is_enabled (bool): [Read-Write] Is Enabled: Sets whether this widget can be modified interactively by the user

  • is_units_text_read_only (bool): [Read-Write] Is Units Text Read Only: Whether to set the units part of the text label read only.

  • is_value_text_read_only (bool): [Read-Write] Is Value Text Read Only: Whether to set the value part of the text label read only.

  • is_volatile (bool): [Read-Write] Is Volatile: If true prevents the widget or its child’s geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.

  • navigation (WidgetNavigation): [Read-Write] Navigation: The navigation object for this widget is optionally created if the user has configured custom navigation rules for this widget in the widget designer. Those rules determine how navigation transitions can occur between widgets.

  • on_value_changed (OnFloatValueChangedEvent): [Read-Write] On Value Changed: Called when the value is changed by slider or typing.

  • orientation (Orientation): [Read-Write] Orientation: The slider’s orientation.

  • override_accessible_defaults (bool): [Read-Write] Override Accessible Defaults: Override all of the default accessibility behavior and text for this widget.

  • override_cursor (bool): [Read-Write] Override Cursor

  • render_opacity (float): [Read-Write] Render Opacity: The opacity of the widget

  • render_transform (WidgetTransform): [Read-Write] Render Transform: The render transform of the widget allows for arbitrary 2D transforms to be applied to the widget.

  • render_transform_pivot (Vector2D): [Read-Write] Render Transform Pivot: The render transform pivot controls the location about which transforms are applied. This value is a normalized coordinate about which things like rotations will occur.

  • show_label_only_on_hover (bool): [Read-Write] Show Label Only on Hover: If true, show text label only on hover; if false always show label.

  • show_units_text (bool): [Read-Write] Show Units Text: Whether to show the units part of the text label.

  • slider_background_color (LinearColor): [Read-Write] Slider Background Color: The color to draw the slider background.

  • slider_bar_color (LinearColor): [Read-Write] Slider Bar Color: The color to draw the slider bar.

  • slider_thumb_color (LinearColor): [Read-Write] Slider Thumb Color: The color to draw the slider thumb.

  • slot (PanelSlot): [Read-Write] Slot: The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.

  • text_label_background_color (LinearColor): [Read-Write] Text Label Background Color: The color to draw the text label background.

  • tool_tip_text (Text): [Read-Write] Tool Tip Text: Tooltip text to show when the user hovers over the widget with the mouse

  • tool_tip_widget (Widget): [Read-Only] Tool Tip Widget: Tooltip widget to show when the user hovers over the widget with the mouse

  • units_text (Text): [Read-Write] Units Text: The text label units

  • value (float): [Read-Write] Value: The linear value.

  • visibility (SlateVisibility): [Read-Write] Visibility: The visibility of the widget

  • widget_background_color (LinearColor): [Read-Write] Widget Background Color: The color to draw the widget background.

get_lin_value(output_value) → float

Get linear value from output based on internal lin to output mapping.

Parameters

output_value (float) –

Return type

float

get_output_value(lin_value) → float

Get output value from linear based on internal lin to output mapping.

Parameters

lin_value (float) –

Return type

float

property on_value_changed

[Read-Write] On Value Changed: Called when the value is changed by slider or typing.

Type

(OnFloatValueChangedEvent)

property orientation

[Read-Only] Orientation: The slider’s orientation.

Type

(Orientation)

set_show_label_only_on_hover(show_label_only_on_hover) → None

If true, show text label only on hover; if false always show label.

Parameters

show_label_only_on_hover (bool) –

set_show_units_text(show_units_text) → None

Sets whether to show the units text

Parameters

show_units_text (bool) –

set_slider_background_color(value) → None

Sets the slider background color

Parameters

value (LinearColor) –

set_slider_bar_color(value) → None

Sets the slider bar color

Parameters

value (LinearColor) –

set_slider_thumb_color(value) → None

Sets the slider thumb color

Parameters

value (LinearColor) –

set_text_label_background_color(color) → None

Sets the label background color

Parameters

color (SlateColor) –

set_units_text(units) → None

Sets the units text

Parameters

units (Text) –

set_units_text_read_only(is_read_only) → None

Sets whether the units text is read only

Parameters

is_read_only (bool) –

set_value_text_read_only(is_read_only) → None

Sets whether the value text is read only

Parameters

is_read_only (bool) –

set_widget_background_color(value) → None

Sets the widget background color

Parameters

value (LinearColor) –