IMediaOverlaySample

Interface for media overlay text samples.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IMediaOverlaySample

IElectraSubtitleSample

References

Module

Media

Header

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

Include

#include "IMediaOverlaySample.h"

Syntax

class IMediaOverlaySample

Remarks

Interface for media overlay text samples.

Destructors

Name Description

Public function Virtual

~IMediaOverlaySample()

Virtual destructor.

Functions

Name Description

Public function Const

FTimespan

 

GetDuration()

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

Public function Virtual Const

FGuid

 

GetGUID()

Get the GUID identifying the derived type that may implement additional, type specific methods.

Public function Const

TOptional< F...

 

GetPosition()

Get the position at which to display the text.

Public function Const

FText

 

GetText()

Get the sample's text.

Public function Const

FMediaTimeSt...

 

GetTime()

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

Public function Virtual Const

TOptional< F...

 

GetTimecode()

Get the sample timecode if available.

Public function Const

EMediaOverla...

 

GetType()

Get the sample type.