1. Epic GamesDeveloper
  3. FMediaTimeStamp

FMediaTimeStamp

Timestamp value for media playback

API > API/Runtime > API/Runtime/Media

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!

   
Name FMediaTimeStamp
Type class
Header File /Engine/Source/Runtime/Media/Public/IMediaTimeSource.h
Include Path #include "IMediaTimeSource.h"

Syntax

class FMediaTimeStamp

Constructors

Name Remarks Include Path Unreal Specifiers
  IMediaTimeSource.h  

FMediaTimeStamp ( const FTimespan& InTime,
int32 InSequenceIndex,
int32 InLoopIndex
)

   IMediaTimeSource.h  

FMediaTimeStamp ( const FTimespan& InTime
)

   IMediaTimeSource.h  

FMediaTimeStamp ( const FTimespan& InTime,
int64 InSequenceValue
)

   IMediaTimeSource.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Time FTimespan   IMediaTimeSource.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
LoopIndex int32   IMediaTimeSource.h  
SequenceIndex int32   IMediaTimeSource.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FMediaTimeStamp & AdjustLoopIndex ( int32 Add
)

   IMediaTimeSource.h  

int64 GetIndexValue()

   IMediaTimeSource.h  

int32 GetLoopIndex ()

   IMediaTimeSource.h  

int32 GetSequenceIndex ()

   IMediaTimeSource.h  

const FTimespan & GetTime()

   IMediaTimeSource.h  

void Invalidate()

   IMediaTimeSource.h  

bool IsValid()

   IMediaTimeSource.h  

FMediaTimeStamp & SetLoopIndex ( int32 InLoopIndex
)

   IMediaTimeSource.h  

FMediaTimeStamp & SetSequenceIndex ( int32 InSequenceIndex
)

   IMediaTimeSource.h  

FMediaTimeStamp & SetTime ( const FTimespan& InTime
)

   IMediaTimeSource.h  

FMediaTimeStamp & SetTimeAndIndexValue ( const FTimespan& InTime,
int64 InIndexValue
)

   IMediaTimeSource.h  

Static

Name Remarks Include Path Unreal Specifiers

static int32 GetLoopIndex ( int64 InSequenceIndex
)

   IMediaTimeSource.h  

static int32 GetSequenceIndex ( int64 InSequenceIndex
)

   IMediaTimeSource.h  

static int64 MakeIndexValue ( int32 InSequenceIndex,
int32 InLoopIndex
)

   IMediaTimeSource.h  

Operators

Name Remarks Include Path Unreal Specifiers

FMediaTimeStamp operator- ( const FTimespan& Other
) const

   IMediaTimeSource.h  

FMediaTimeStamp operator- ( const FMediaTimeStamp& Other
) const

   IMediaTimeSource.h  

bool operator!= ( const FMediaTimeStamp& Other
) const

   IMediaTimeSource.h  

FMediaTimeStamp operator+ ( const FTimespan& Other
) const

   IMediaTimeSource.h  

FMediaTimeStamp & operator+= ( const FTimespan& Other
)

   IMediaTimeSource.h  
  IMediaTimeSource.h  

FMediaTimeStamp & operator-= ( const FTimespan& Other
)

   IMediaTimeSource.h  

bool operator== ( const FMediaTimeStamp& Other
) const

   IMediaTimeSource.h  

bool operator> ( const FMediaTimeStamp& Other
) const

   IMediaTimeSource.h  

bool operator>= ( const FMediaTimeStamp& Other
) const

   IMediaTimeSource.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page