URivermaxTimecodeProvider | Unreal Engine 5.5 Documentation

Unreal Engine C++ API Reference > Plugins > RivermaxMedia

Inheritance Hierarchy

UTimecodeProvider
UGenlockedTimecodeProvider
URivermaxTimecodeProvider

References


Module	RivermaxMedia
Header	/Engine/Plugins/VirtualProduction/Rivermax/RivermaxMedia/Source/RivermaxMedia/Public/RivermaxTimecodeProvider.h
Include	#include "RivermaxTimecodeProvider.h"

Syntax

UCLASS (Blueprintable, EditInlineNew)  
class URivermaxTimecodeProvider : public UGenlockedTimecodeProvider

Remarks

Timecode provider based on time returned by Rivermax GetTime API Rivermax clock is configured using Project Setting. If using multiple interfaces, make sure to configure the interface address you wish to use.

PTP time is returned in International Atomic Time referential (TAI) as opposed to Coordinated Universal Time (UTC) Timecode going out of the clock generator is generally using UTC time reference so to generate an engine timecode that aligns with devices receiving LTC timecode, we need to convert PTP TAI time to UTC time. At the moment, that offset is fixed at 37 seconds.

Clock generators can also output timecode with daylight saving time (DST) offsets which would not be affecting PTP time reference If devices receive timecode with DST offsets, engine timecode will need to be adjusted to correctly align.

Variables

Type	Name	Description
int32	DaylightSavingTimeHourOffset	If timecode generated by the clock generator has daylight saving applied, add offset here in order to match PTP based timecode with devices getting LTC timecode A positive value will be subtracted from the timecode generated from PTP time.
FFrameRate	FrameRate	Frame Rate to provide timecode in
int32	PTPToLTCTimecodeFrameOffset	Frame offset subtracted to converted timecode to match LTC timecode due to transportation of timecode For LTC, it takes a full frame to transport the new value but for PTP, this doesn't happen, time is local.
int32	UTCSecondsOffset	TAI to UTC time offset.

Functions

	Type	Name	Description
	bool	FetchTimecode ( FQualifiedFrameTime& OutFrameTime )
	ETimecodeProviderSynchronizationState	GetSynchronizationState ()
	bool	Initialize ( UEngine* InEngine )
	void	Shutdown ( UEngine* InEngine )
	bool	SupportsAutoDetected ()