Navigation
API > API/Plugins > API/Plugins/HarmonixMetasound
UMusicTempometerComponent provides playback properties of a UMusicClockComponent on its actor and optionally updates a UMaterialParameterCollection.
| Name | UMusicTempometerComponent |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Harmonix/Source/HarmonixMetasound/Public/HarmonixMetasound/Components/MusicTempometerComponent.h |
| Include Path | #include "HarmonixMetasound/Components/MusicTempometerComponent.h" |
Syntax
UCLASS (MinimalAPI, ClassGroup=(MetaSoundMusic), prioritizeCategories="MusicClock",
Meta=(BlueprintSpawnableComponent, DisplayName="Music Tempometer", ScriptName=MusicTempometerComponent))
class UMusicTempometerComponent : public UActorComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → UMusicTempometerComponent
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMusicTempometerComponent() |
HarmonixMetasound/Components/MusicTempometerComponent.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| MPCParameters | FMusicTempometerMPCParameters | Deprecated, has moved into structure within MPCParameters | HarmonixMetasound/Components/MusicTempometerComponent.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| LastFrameCounter | uint64 | HarmonixMetasound/Components/MusicTempometerComponent.h | ||
| MaterialParameterCollection | TObjectPtr< UMaterialParameterCollection > | HarmonixMetasound/Components/MusicTempometerComponent.h |
|
|
| MaterialParameterCollectionInstance | TWeakObjectPtr< UMaterialParameterCollectionInstance > | Pinned material parameter collection instance | HarmonixMetasound/Components/MusicTempometerComponent.h |
|
| MusicClock | TObjectPtr< UMusicClockComponent > | Music whose tempo to detect. | HarmonixMetasound/Components/MusicTempometerComponent.h |
|
| SongPos | FMidiSongPos | HarmonixMetasound/Components/MusicTempometerComponent.h |
|
|
| SongPosUpdateMutex | FCriticalSection | HarmonixMetasound/Components/MusicTempometerComponent.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float GetBarProgress() |
Progress of the current bar [0, 1). | HarmonixMetasound/Components/MusicTempometerComponent.h |
|
float GetBarsIncludingCountIn () |
Bars from the beginning of the music. | HarmonixMetasound/Components/MusicTempometerComponent.h |
|
float GetBeatProgress() |
Progress of the current beat [0, 1). | HarmonixMetasound/Components/MusicTempometerComponent.h |
|
float GetBeatsIncludingCountIn () |
Beats from the beginning of the music. | HarmonixMetasound/Components/MusicTempometerComponent.h |
|
const UMusicClockComponent * GetClock() |
HarmonixMetasound/Components/MusicTempometerComponent.h |
|
|
UMaterialParameterCollection * GetMaterialParameterCollection() |
HarmonixMetasound/Components/MusicTempometerComponent.h |
|
|
float GetSecondsFromBarOne () |
Seconds from Bar 1 Beat 1 of the music. | HarmonixMetasound/Components/MusicTempometerComponent.h |
|
float GetSecondsIncludingCountIn () |
Seconds from the beginning of the entire music authoring. | HarmonixMetasound/Components/MusicTempometerComponent.h |
|
const FMidiSongPos & GetSongPos() |
The FSongPos for which the game thread is currently issuing graphics rendering commands, according to calibration data. | HarmonixMetasound/Components/MusicTempometerComponent.h |
|
float GetTempo() |
Current tempo (beats per minute). | HarmonixMetasound/Components/MusicTempometerComponent.h |
|
float GetTimeSignatureDenominator() |
Current time signature denominator (scale from note duration to beat fraction for a simple meter). | HarmonixMetasound/Components/MusicTempometerComponent.h |
|
float GetTimeSignatureNumerator() |
Current time signature numerator (beats per bar for a simple meter). | HarmonixMetasound/Components/MusicTempometerComponent.h |
|
| Current bar & beat in the traditional format, where... | HarmonixMetasound/Components/MusicTempometerComponent.h |
|
|
void SetClock
(
UMusicClockComponent* InClockComponent |
SetSongPosInterface allows setting any UObject implementing the ISongPosInterface as the attribute source. | HarmonixMetasound/Components/MusicTempometerComponent.h |
|
void SetClockFromActor
(
AActor* Actor |
SetSongPosInterfaceFromActor sets the actor or the first of its owned components that implements ISongPosInterface as the attribute source. | HarmonixMetasound/Components/MusicTempometerComponent.h |
|
void SetMaterialParameterCollection
(
UMaterialParameterCollection* InMaterialParameterCollection |
Set the MaterialParameterCollection whose parameters will be updated. | HarmonixMetasound/Components/MusicTempometerComponent.h |
|
Overridden from UActorComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void TickComponent
(
float DeltaTime, |
HarmonixMetasound/Components/MusicTempometerComponent.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
HarmonixMetasound/Components/MusicTempometerComponent.h | ||
virtual void PostLoad() |
HarmonixMetasound/Components/MusicTempometerComponent.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BarProgressParameterName_DEPRECATED | FName | Deprecated, has moved into structure within MPCParameters | HarmonixMetasound/Components/MusicTempometerComponent.h | |
| BarsIncludingCountInParameterName_DEPRECATED | FName | Deprecated, has moved into structure within MPCParameters | HarmonixMetasound/Components/MusicTempometerComponent.h | |
| BeatProgressParameterName_DEPRECATED | FName | Deprecated, has moved into structure within MPCParameters | HarmonixMetasound/Components/MusicTempometerComponent.h | |
| BeatsIncludingCountInParameterName_DEPRECATED | FName | Deprecated, has moved into structure within MPCParameters | HarmonixMetasound/Components/MusicTempometerComponent.h | |
| SecondsFromBarOneParameterName_DEPRECATED | FName | Deprecated, has moved into structure within MPCParameters | HarmonixMetasound/Components/MusicTempometerComponent.h | |
| SecondsIncludingCountInParameterName_DEPRECATED | FName | Deprecated, has moved into structure within MPCParameters | HarmonixMetasound/Components/MusicTempometerComponent.h | |
| TempoParameterName_DEPRECATED | FName | Deprecated, has moved into structure within MPCParameters | HarmonixMetasound/Components/MusicTempometerComponent.h | |
| TimeSignatureDenominatorParameterName_DEPRECATED | FName | Deprecated, has moved into structure within MPCParameters | HarmonixMetasound/Components/MusicTempometerComponent.h | |
| TimeSignatureNumeratorParameterName_DEPRECATED | FName | Deprecated, has moved into structure within MPCParameters | HarmonixMetasound/Components/MusicTempometerComponent.h | |
| TimestampBarParameterName_DEPRECATED | FName | Deprecated, has moved into structure within MPCParameters | HarmonixMetasound/Components/MusicTempometerComponent.h | |
| TimestampBeatInBarParameterName_DEPRECATED | FName | Deprecated, has moved into structure within MPCParameters | HarmonixMetasound/Components/MusicTempometerComponent.h |