Navigation
API > API/Plugins > API/Plugins/HarmonixMetasound
A time source driven by UWorld delta time.
Provides a simple wall-clock time stream suitable for non-audio-driven use cases. Supports transport control (Start/Stop/Pause/Continue/Seek) and variable speed playback. Time advances by the world's delta time each frame, scaled by the speed multiplier and time dilation.
| Name | FWorldTimeSourceController |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Harmonix/Source/HarmonixMetasound/Public/HarmonixMetasound/MusicClock/WorldTimeSourceController.h |
| Include Path | #include "HarmonixMetasound/MusicClock/WorldTimeSourceController.h" |
Syntax
class FWorldTimeSourceController : public Harmonix::ITimeSource
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FWorldTimeSourceController
(
UObject* InContextObj |
HarmonixMetasound/MusicClock/WorldTimeSourceController.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ContextObj | FWeakObjectPtr | HarmonixMetasound/MusicClock/WorldTimeSourceController.h | ||
| CurrentSourceState | ESourceState | HarmonixMetasound/MusicClock/WorldTimeSourceController.h | ||
| LatestSourceEvent | ESourceEvent | HarmonixMetasound/MusicClock/WorldTimeSourceController.h | ||
| RunTimeSeconds | double | HarmonixMetasound/MusicClock/WorldTimeSourceController.h | ||
| SeekRequestTime | double | HarmonixMetasound/MusicClock/WorldTimeSourceController.h | ||
| Speed | float | HarmonixMetasound/MusicClock/WorldTimeSourceController.h | ||
| TransportRequest | ETransportRequest | HarmonixMetasound/MusicClock/WorldTimeSourceController.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Continue() |
HarmonixMetasound/MusicClock/WorldTimeSourceController.h | ||
void Pause() |
HarmonixMetasound/MusicClock/WorldTimeSourceController.h | ||
void Seek
(
float InSeekTime |
Seek to an absolute time position in seconds. | HarmonixMetasound/MusicClock/WorldTimeSourceController.h | |
void SetSpeed
(
float InSpeed |
Set the playback speed multiplier. Clamped to [0.01, 10.0]. | HarmonixMetasound/MusicClock/WorldTimeSourceController.h | |
void Start
(
float StartTime |
Start playback from the given time in seconds. | HarmonixMetasound/MusicClock/WorldTimeSourceController.h | |
void Stop() |
HarmonixMetasound/MusicClock/WorldTimeSourceController.h |
Public Virtual
Overridden from ITimeSource
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ESourceState GetCurrentSourceState() |
Get whether the source is Running, Stopped, or Paused | HarmonixMetasound/MusicClock/WorldTimeSourceController.h | |
virtual double GetCurrentTime() |
Get the current tme of this time source Is updated every frame via Update | HarmonixMetasound/MusicClock/WorldTimeSourceController.h | |
virtual FString GetDisplayName() |
HarmonixMetasound/MusicClock/WorldTimeSourceController.h | ||
virtual ESourceEvent GetLatestSourceEvent () |
Retrieve the latest "Event" from this source Whether it "Advanced", "Stopped", "Continued", etc. | HarmonixMetasound/MusicClock/WorldTimeSourceController.h | |
virtual float GetSpeed() |
Get the speed at which time is advancing | HarmonixMetasound/MusicClock/WorldTimeSourceController.h | |
virtual void RequestContinue() |
HarmonixMetasound/MusicClock/WorldTimeSourceController.h | ||
virtual void RequestPause() |
HarmonixMetasound/MusicClock/WorldTimeSourceController.h | ||
virtual void RequestSeek
(
float TimeInSeconds |
Seek to an absolute time position in seconds. Default is no-op. | HarmonixMetasound/MusicClock/WorldTimeSourceController.h | |
virtual void RequestSetSpeed
(
float InSpeed |
Set the playback speed multiplier. Default is no-op. | HarmonixMetasound/MusicClock/WorldTimeSourceController.h | |
virtual void RequestStart
(
float StartTime |
ITimeSource optional transport. | HarmonixMetasound/MusicClock/WorldTimeSourceController.h | |
virtual void RequestStop() |
HarmonixMetasound/MusicClock/WorldTimeSourceController.h | ||
virtual TOptional< FVector > TryGetAudioSourceLocation() |
HarmonixMetasound/MusicClock/WorldTimeSourceController.h | ||
virtual void Update () |
Used to update the time source once per frame | HarmonixMetasound/MusicClock/WorldTimeSourceController.h |