`unreal.AudioMeter`¶

class unreal.AudioMeter(outer=None, name='None')¶

Bases: unreal.Widget

An audio meter widget.

Supports displaying a slower moving peak-hold value as well as the current meter value.

A clipping value is also displayed which shows a customizable color to indicate clipping.

Internal values are stored and interacted with as linear volume values.

C++ Source:

Plugin: AudioWidgets
Module: AudioWidgets
File: AudioMeter.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.
background_color (LinearColor): [Read-Write] Background Color: The color to draw the background.
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_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.
meter_background_color (LinearColor): [Read-Write] Meter Background Color: The color to draw the meter background.
meter_channel_info (Array(MeterChannelInfo)): [Read-Write] Meter Channel Info: The current meter value to display.
meter_clipping_color (LinearColor): [Read-Write] Meter Clipping Color: The color to draw the meter clipping value.
meter_peak_color (LinearColor): [Read-Write] Meter Peak Color: The color to draw the meter peak value.
meter_scale_color (LinearColor): [Read-Write] Meter Scale Color: The color to draw the meter scale hashes.
meter_scale_label_color (LinearColor): [Read-Write] Meter Scale Label Color: The color to draw the meter scale label.
meter_value_color (LinearColor): [Read-Write] Meter Value Color: The color to draw the meter value.
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.
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.
slot (PanelSlot): [Read-Write] Slot: The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.
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
visibility (SlateVisibility): [Read-Write] Visibility: The visibility of the widget
widget_style (AudioMeterStyle): [Read-Write] Widget Style: The audio meter style