unreal.AudioComponentViewModel

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

Bases: MVVMViewModelBase

Viewmodel for binding audio component state to widgets.

C++ Source:

• Plugin: TechAudioTools

• Module: TechAudioTools

• File: AudioComponentViewModel.h

Editor Properties: (see get_editor_property/set_editor_property)

• is_fading_in (bool): [Read-Write] True if the audio component is fading in.

• is_fading_out (bool): [Read-Write] True if the audio component is fading out.

• is_playing (bool): [Read-Write] True if the audio component is playing.

• is_stopped (bool): [Read-Write] True if the audio component is stopped.

• is_virtualized (bool): [Read-Write] True if the audio component is virtualized.

• play_state (AudioComponentPlayState): [Read-Write] Returns the enumerated play state of the audio component.

property is_fading_in: bool

[Read-Only] True if the audio component is fading in.

Type:

(bool)

property is_fading_out: bool

[Read-Only] True if the audio component is fading out.

Type:

(bool)

property is_playing: bool

[Read-Only] True if the audio component is playing.

Type:

(bool)

property is_stopped: bool

[Read-Only] True if the audio component is stopped.

Type:

(bool)

property is_virtualized: bool

[Read-Only] True if the audio component is virtualized.

Type:

(bool)

property play_state: AudioComponentPlayState

[Read-Only] Returns the enumerated play state of the audio component.

Type:

(AudioComponentPlayState)

set_audio_component(audio_component) → None

Sets the audio component this viewmodel should bind to.

Parameters:

audio_component (AudioComponent)