IMediaOverlaySample Class Reference

#include <IMediaOverlaySample.h>

Public Member Functions
virtual FTimespan	GetDuration () const =0
virtual TOptional< FVector2D >	GetPosition () const =0
virtual FText	GetText () const =0
virtual FMediaTimeStamp	GetTime () const =0
virtual TOptional< FTimecode >	GetTimecode () const
virtual EMediaOverlaySampleType	GetType () const =0
virtual FGuid	GetGUID () const
virtual	~IMediaOverlaySample ()

Detailed Description

Interface for media overlay text samples.

Constructor & Destructor Documentation

~IMediaOverlaySample()

virtual IMediaOverlaySample::~IMediaOverlaySample ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

GetDuration()

virtual FTimespan IMediaOverlaySample::GetDuration ( ) const

pure virtual

Get the amount of time for which the sample should be displayed.

Returns

Sample duration.

GetGUID()

virtual FGuid IMediaOverlaySample::GetGUID ( ) const

inlinevirtual

Get the GUID identifying the derived type that may implement additional, type specific methods. If the GUID matches a type known type it is safe to static cast this class to the derived type.

GetPosition()

virtual TOptional< FVector2D > IMediaOverlaySample::GetPosition ( ) const

pure virtual

Get the position at which to display the text.

Returns

Display position (relative to top-left corner, in pixels).

See also

GetText

GetText()

virtual FText IMediaOverlaySample::GetText ( ) const

pure virtual

Get the sample's text.

Returns

The overlay text.

See also

GetPosition, GetType

GetTime()

virtual FMediaTimeStamp IMediaOverlaySample::GetTime ( ) const

pure virtual

Get the sample time (in the player's local clock).

This value is used primarily for debugging purposes.

Returns

Sample time.

GetTimecode()

virtual TOptional< FTimecode > IMediaOverlaySample::GetTimecode ( ) const

inlinevirtual

Get the sample timecode if available.

Returns

Sample timecode.

See also

GetTime

GetType()

virtual EMediaOverlaySampleType IMediaOverlaySample::GetType ( ) const

pure virtual

Get the sample type.

Returns

Sample type.

See also

GetText

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/Media/Public/IMediaOverlaySample.h