Navigation
API > API/Plugins > API/Plugins/TechAudioTools
Viewmodel for binding audio component state to widgets.
| Name | UAudioComponentViewModel |
| Type | class |
| Header File | /Engine/Plugins/Experimental/TechAudioTools/Source/TechAudioTools/Public/Viewmodels/AudioComponentViewModel.h |
| Include Path | #include "Viewmodels/AudioComponentViewModel.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType, DisplayName="Audio Component Viewmodel")
class UAudioComponentViewModel : public UMVVMViewModelBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMVVMViewModelBase → UAudioComponentViewModel
Implements Interfaces
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsFadingIn | bool | True if the audio component is fading in. | Viewmodels/AudioComponentViewModel.h |
|
| bIsFadingOut | bool | True if the audio component is fading out. | Viewmodels/AudioComponentViewModel.h |
|
| bIsPlaying | bool | True if the audio component is playing. | Viewmodels/AudioComponentViewModel.h |
|
| bIsStopped | bool | True if the audio component is stopped. | Viewmodels/AudioComponentViewModel.h |
|
| bIsVirtualized | bool | True if the audio component is virtualized. | Viewmodels/AudioComponentViewModel.h |
|
| PlayState | EAudioComponentPlayState | Returns the enumerated play state of the audio component. | Viewmodels/AudioComponentViewModel.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
EAudioComponentPlayState GetPlayState() |
Viewmodels/AudioComponentViewModel.h | ||
bool IsFadingIn() |
Viewmodels/AudioComponentViewModel.h | ||
bool IsFadingOut() |
Viewmodels/AudioComponentViewModel.h | ||
bool IsPlaying() |
Viewmodels/AudioComponentViewModel.h | ||
bool IsStopped() |
Viewmodels/AudioComponentViewModel.h | ||
bool IsVirtualized() |
Viewmodels/AudioComponentViewModel.h | ||
virtual void SetAudioComponent
(
UAudioComponent* InAudioComponent |
Sets the audio component this viewmodel should bind to. | Viewmodels/AudioComponentViewModel.h |
|
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
Viewmodels/AudioComponentViewModel.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BindDelegates() |
Viewmodels/AudioComponentViewModel.h | ||
void OnAudioFinished() |
Viewmodels/AudioComponentViewModel.h | ||
void OnVirtualizationChanged
(
bool bInIsVirtualized |
Viewmodels/AudioComponentViewModel.h | ||
void UnbindDelegates() |
Viewmodels/AudioComponentViewModel.h |