Navigation
API > API/Plugins > API/Plugins/HarmonixMetasound
This defines a concrete implementation of the IMusicHandle interface. It is a wrapper around a UAudioComponent and a UMusicClockComponent. Using those two components this class can control the transport of the playing music (play, pause, continue, seek stop, kill) and provide the holder with a source of musical time.
This is the 'flavor' of IMusicHandle returned by the UHarmonixMetasoundMusicAsset class (among others in the future) when it is asked to instantiate itself (play).
| Name | UHarmonixMusicHandle |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Harmonix/Source/HarmonixMetasound/Public/HarmonixMetasound/DataTypes/HarmonixMusicHandle.h |
| Include Path | #include "HarmonixMetasound/DataTypes/HarmonixMusicHandle.h" |
Syntax
UCLASS (MinimalAPI)
class UHarmonixMusicHandle :
public UObject ,
public IMusicHandle
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UHarmonixMusicHandle
Implements Interfaces
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AudioComponent | TObjectPtr< UAudioComponent > | HarmonixMetasound/DataTypes/HarmonixMusicHandle.h |
|
|
| bHasStarted | bool | HarmonixMetasound/DataTypes/HarmonixMusicHandle.h | ||
| MusicClockComponent | TObjectPtr< UMusicClockComponent > | HarmonixMetasound/DataTypes/HarmonixMusicHandle.h |
|
|
| PlayingAsset | TObjectPtr< UHarmonixMusicAsset > | HarmonixMetasound/DataTypes/HarmonixMusicHandle.h |
|
Functions
Public
Overridden from IMusicHandle
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Continue() |
HarmonixMetasound/DataTypes/HarmonixMusicHandle.h | ||
virtual TScriptInterface< IMusicEnvironmentClockSource > GetMusicClockSource() |
HarmonixMetasound/DataTypes/HarmonixMusicHandle.h | ||
virtual bool IsUsingAsset
(
const UObject* Asset |
HarmonixMetasound/DataTypes/HarmonixMusicHandle.h | ||
virtual bool IsValid() |
HarmonixMetasound/DataTypes/HarmonixMusicHandle.h | ||
virtual void Pause() |
HarmonixMetasound/DataTypes/HarmonixMusicHandle.h | ||
virtual bool Play
(
float FromSeconds |
HarmonixMetasound/DataTypes/HarmonixMusicHandle.h | ||
virtual void Tick
(
float DeltaSeconds |
HarmonixMetasound/DataTypes/HarmonixMusicHandle.h |
Protected
Overridden from IMusicHandle
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Kill_Internal() |
HarmonixMetasound/DataTypes/HarmonixMusicHandle.h | ||
virtual void Stop_Internal() |
HarmonixMetasound/DataTypes/HarmonixMusicHandle.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static UHarmonixMusicHandle * Instantiate
(
UHarmonixMusicAsset* Asset, |
HarmonixMetasound/DataTypes/HarmonixMusicHandle.h |