Navigation
Unreal Engine C++ API Reference > Runtime > Media
Inheritance Hierarchy
- IMediaOverlaySample
- FMediaIOCoreCaptionSampleBase
- FMediaIOCoreSubtitleSampleBase
- 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
| Type | Name | Description | |
|---|---|---|---|
  |
Virtual destructor. |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
FTimespan | GetDuration () |
Get the amount of time for which the sample should be displayed. |
   |
FGuid | GetGUID () |
Get the GUID identifying the derived type that may implement additional, type specific methods. |
  |
TOptional< FVector2D > | GetPosition () |
Get the position at which to display the text. |
  |
FText | GetText () |
Get the sample's text. |
  |
FMediaTimeStamp | GetTime () |
Get the sample time (in the player's local clock). |
   |
TOptional< FTimecode > | GetTimecode () |
Get the sample timecode if available. |
  |
EMediaOverlaySampleType | GetType () |
Get the sample type. |