Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Media > FMediaTimeStamp

Light Theme

Dark Theme

FMediaTimeStamp

Timestamp value for media playback

Windows

MacOS

Linux

References

Module	Media
Header	/Engine/Source/Runtime/Media/Public/IMediaTimeSource.h
Include	#include "IMediaTimeSource.h"

Syntax

class FMediaTimeStamp

Remarks

Timestamp value for media playback

Time: Time value
SequenceIndex Sequence that is current for this time value

Within a single sequence time values will increase or decrease monotonically. A new sequence index is generated on each event that causes the time to no longer be monotonic. (e.g. seek or loop) A sequence index does not offer any information about the ordering of the time stamps on the timeline. Time values are comparable between all timestamps from a single playback, though, one needs to be careful to consider non-monotonic behavior if the sequence indices are not identical.

Sequence indices can very much offer ordering information as far as playback progression is concerned. Higher indices are also later in playback. (even if time values may be smaller: e.g. looping)

All comparison operators of this class will operate to indicate ordering relative to playback, not position on the timeline!

Variables

		Name	Description
	int64	SequenceIndex
	FTimespan	Time

Constructors

	Name	Description
	FMediaTimeStamp()
	FMediaTimeStamp ( const FTimespan& InTime )
	FMediaTimeStamp ( const FTimespan& InTime, int64 InSequenceIndex )

Functions

		Name	Description
	void	Invalidate()
	bool	IsRelative()
	bool	IsValid()

Operators

		Name	Description
	FMediaTimeSt...	operator- ( const FMediaTimeStamp& Other )
	FMediaTimeSt...	operator- ( const FTimespan& Other )
	FMediaTimeSt...	operator+ ( const FTimespan& Other )
	FMediaTimeSt...	operator+= ( const FTimespan& Other )
	bool	operator< ( const FMediaTimeStamp& Other )
	bool	operator<= ( const FMediaTimeStamp& Other )
	FMediaTimeSt...	operator-= ( const FMediaTimeStamp& Other )
	FMediaTimeSt...	operator-= ( const FTimespan& Other )
	bool	operator== ( const FMediaTimeStamp& Other )
	bool	operator> ( const FMediaTimeStamp& Other )
	bool	operator>= ( const FMediaTimeStamp& Other )

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss