Navigation
API > API/Runtime > API/Runtime/Media
Interface for media overlay text samples.
| Name | IMediaOverlaySample |
| Type | class |
| Header File | /Engine/Source/Runtime/Media/Public/IMediaOverlaySample.h |
| Include Path | #include "IMediaOverlaySample.h" |
Syntax
class IMediaOverlaySample
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IMediaOverlaySample() |
Virtual destructor. | IMediaOverlaySample.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FTimespan GetDuration() |
Get the amount of time for which the sample should be displayed. | IMediaOverlaySample.h | |
| Get the GUID identifying the derived type that may implement additional, type specific methods. | IMediaOverlaySample.h | ||
TOptional< FVector2D > GetPosition () |
Get the position at which to display the text. | IMediaOverlaySample.h | |
| Get the sample's text. | IMediaOverlaySample.h | ||
| Get the sample time (in the player's local clock). | IMediaOverlaySample.h | ||
virtual TOptional< FTimecode > GetTimecode () |
Get the sample timecode if available. | IMediaOverlaySample.h | |
| Get the sample type. | IMediaOverlaySample.h |