1. Epic GamesDeveloper
  3. FMediaTimeStamp

FMediaTimeStamp

Timestamp value for media playback

Unreal Engine C++ API Reference > Runtime > Media

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

  Type Name Description
Public variable int64 SequenceIndex  
Public variable FTimespan Time  

Constructors

  Type Name Description
Public function    
Public function  

FMediaTimeStamp ( const FTimespan& InTime
)

  
Public function  

FMediaTimeStamp ( const FTimespan& InTime,
int64 InSequenceIndex
)

  

Functions

  Type Name Description
Public function Static int64

AdjustPrimaryIndex ( int64 InSequenceIndex,
int32 Add
)

  
Public function Static int64

AdjustSecondaryIndex ( int64 InSequenceIndex,
int32 Add
)

  
Public function Static int32

GetPrimaryIndex ( int64 InSequenceIndex
)

  
Public function Static int32

GetSecondaryIndex ( int64 InSequenceIndex
)

  
Public function void  
Public function Const bool  
Public function Const bool

IsValid ()

  
Public function Static int64

MakeSequenceIndex ( int32 PrimaryIndex,
int32 SecondaryIndex
)

  

Operators

  Type Name Description
Public function Const FMediaTimeStamp

operator- ( const FMediaTimeStamp& Other
)

  
Public function Const FMediaTimeStamp

operator- ( const FTimespan& Other
)

  
Public function Const FMediaTimeStamp

operator+ ( const FTimespan& Other
)

  
Public function FMediaTimeStamp &

operator+= ( const FTimespan& Other
)

  
Public function Const bool

operator< ( const FMediaTimeStamp& Other
)

  
Public function Const bool

operator<= ( const FMediaTimeStamp& Other
)

  
Public function FMediaTimeStamp &

operator-= ( const FTimespan& Other
)

  
Public function FMediaTimeStamp &

operator-= ( const FMediaTimeStamp& Other
)

  
Public function Const bool

operator== ( const FMediaTimeStamp& Other
)

  
Public function Const bool

operator> ( const FMediaTimeStamp& Other
)

  
Public function Const bool

operator>= ( const FMediaTimeStamp& Other
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page