Navigation
API > API/Plugins > API/Plugins/HarmonixMetasound
Base class for Time Sources used by the Runtime Music Clock
| Name | ITimeSource |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Harmonix/Source/HarmonixMetasound/Public/HarmonixMetasound/MusicClock/TimeSource.h |
| Include Path | #include "HarmonixMetasound/MusicClock/TimeSource.h" |
Syntax
class ITimeSource
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ITimeSource() |
HarmonixMetasound/MusicClock/TimeSource.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ESourceState GetCurrentSourceState() |
Get whether the source is Running, Stopped, or Paused | HarmonixMetasound/MusicClock/TimeSource.h | |
double GetCurrentTime() |
Get the current tme of this time source Is updated every frame via Update | HarmonixMetasound/MusicClock/TimeSource.h | |
FString GetDisplayName() |
HarmonixMetasound/MusicClock/TimeSource.h | ||
| Retrieve the latest "Event" from this source Whether it "Advanced", "Stopped", "Continued", etc. | HarmonixMetasound/MusicClock/TimeSource.h | ||
float GetSpeed() |
Get the speed at which time is advancing | HarmonixMetasound/MusicClock/TimeSource.h | |
TOptional< FVector > TryGetAudioSourceLocation() |
HarmonixMetasound/MusicClock/TimeSource.h | ||
void Update () |
Used to update the time source once per frame | HarmonixMetasound/MusicClock/TimeSource.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void RequestContinue() |
HarmonixMetasound/MusicClock/TimeSource.h | ||
virtual void RequestPause() |
HarmonixMetasound/MusicClock/TimeSource.h | ||
virtual void RequestSeek
(
float TimeInSeconds |
Seek to an absolute time position in seconds. Default is no-op. | HarmonixMetasound/MusicClock/TimeSource.h | |
virtual void RequestSetSpeed
(
float InSpeed |
Set the playback speed multiplier. Default is no-op. | HarmonixMetasound/MusicClock/TimeSource.h | |
virtual void RequestStart
(
float StartTime |
- Optional Transport - Default implementations are no-ops. | HarmonixMetasound/MusicClock/TimeSource.h | |
virtual void RequestStop() |
HarmonixMetasound/MusicClock/TimeSource.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static ESourceEvent SourceEventFromStateTransition
(
ESourceState PrevState, |
Determine the source event from a given state transition | HarmonixMetasound/MusicClock/TimeSource.h |