Navigation
API > API/Plugins > API/Plugins/HarmonixMetasound
| Name | FMusicClockDriverBase |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Harmonix/Source/HarmonixMetasound/Public/HarmonixMetasound/Components/MusicClockDriverBase.h |
| Include Path | #include "HarmonixMetasound/Components/MusicClockDriverBase.h" |
Syntax
class FMusicClockDriverBase : public TSharedFromThis< FMusicClockDriverBase >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FMusicClockDriverBase
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMusicClockDriverBase
(
UObject* WorldContextObject, |
HarmonixMetasound/Components/MusicClockDriverBase.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FMusicClockDriverBase() |
HarmonixMetasound/Components/MusicClockDriverBase.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CurrentBarsPerSecond | float | HarmonixMetasound/Components/MusicClockDriverBase.h | ||
| CurrentBeatsPerSecond | float | HarmonixMetasound/Components/MusicClockDriverBase.h | ||
| CurrentClockAdvanceRate | float | HarmonixMetasound/Components/MusicClockDriverBase.h | ||
| CurrentSongPos | FMidiSongPos | HarmonixMetasound/Components/MusicClockDriverBase.h | ||
| DefaultMaps | FSongMaps | HarmonixMetasound/Components/MusicClockDriverBase.h | ||
| DeltaBarF | float | TODO shouldn't these deltas be rolled into the MidiSongPos? | HarmonixMetasound/Components/MusicClockDriverBase.h | |
| DeltaBeatF | float | HarmonixMetasound/Components/MusicClockDriverBase.h | ||
| PrevSongPos | FMidiSongPos | HarmonixMetasound/Components/MusicClockDriverBase.h | ||
| Tempo | float | Note that tempo is MidiTempo, quarter notes per minute. | HarmonixMetasound/Components/MusicClockDriverBase.h | |
| TimeSignatureDenom | int | HarmonixMetasound/Components/MusicClockDriverBase.h | ||
| TimeSignatureNum | int | HarmonixMetasound/Components/MusicClockDriverBase.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ContextObj | TWeakObjectPtr< UObject > | HarmonixMetasound/Components/MusicClockDriverBase.h | ||
| LastUpdateFrame | uint64 | HarmonixMetasound/Components/MusicClockDriverBase.h | ||
| MusicClockState | EMusicClockState | HarmonixMetasound/Components/MusicClockDriverBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CalculateSongPosWithOffset
(
float MsOffset, |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
void Continue() |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
void Disconnect() |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
void EnsureClockIsValidForGameFrame() |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
float GetBeatsPerMinute() |
This returns our BeatsPerMinute which is our true beats, not quarter notes. | HarmonixMetasound/Components/MusicClockDriverBase.h | |
const FMidiSongPos & GetCurrentPlayerExperiencedSongPos() |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
const FMidiSongPos & GetCurrentRawAudioRenderSongPos() |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
const FMidiSongPos & GetCurrentSmoothedAudioRenderSongPos() |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
const ISongMapEvaluator * GetCurrentSongMapEvaluator() |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
const FMidiSongPos & GetCurrentSongPos
(
ECalibratedMusicTimebase Timebase |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
const FMidiSongPos & GetCurrentVideoRenderSongPos() |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
float GetDeltaBarF
(
ECalibratedMusicTimebase Timebase |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
float GetDeltaBeatF
(
ECalibratedMusicTimebase Timebase |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
const FMidiSongPos & GetPreviousSongPos
(
ECalibratedMusicTimebase Timebase |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
EMusicClockState GetState() |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
double GetWallClockTime() |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
bool LoopedThisFrame
(
ECalibratedMusicTimebase Timebase |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
void Pause() |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
bool SeekedThisFrame
(
ECalibratedMusicTimebase Timebase |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
void Start() |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
void Stop() |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
void UpdateMusicPlaybackRate
(
float InTempo, |
HarmonixMetasound/Components/MusicClockDriverBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 GetArrayIndexForTimebase
(
ECalibratedMusicTimebase Timebase |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
void OnContinue() |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
void OnPause() |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
void OnStart() |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
void OnStop() |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
void SetCurrentSongPos
(
ECalibratedMusicTimebase Timebase, |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
void SetCurrentSongPosByTick
(
ECalibratedMusicTimebase Timebase, |
HarmonixMetasound/Components/MusicClockDriverBase.h | ||
void SetCurrentSongPosByTime
(
ECalibratedMusicTimebase Timebase, |
HarmonixMetasound/Components/MusicClockDriverBase.h |