Navigation
API > API/Runtime > API/Runtime/Engine
References
| Module | Engine |
| Header | /Engine/Source/Runtime/Engine/Public/SubtitleManager.h |
| Include | #include "SubtitleManager.h" |
Syntax
class FSubtitleManager
Remarks
Subtitle manager. Handles prioritization and rendering of subtitles.
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | DisplaySubtitle
(
FCanvas* Canvas, |
Draws a subtitle at the specified pixel location. |
 |
void | DisplaySubtitles
(
FCanvas* InCanvas, |
Display the currently queued subtitles and cleanup after they have finished rendering. |
 |
PTRINT | FindHighestPrioritySubtitle
(
float CurrentTime |
Find the highest priority subtitle from the list of currently active ones. |
 |
float | Get the height of currently rendered subtitles. | |
  |
FSubtitleManager * | Get the subtitle manager singleton instance. | |
 |
bool | HasSubtitles () |
Whether there are any active subtitles. |
 |
void | Kill all the subtitles. | |
 |
void | KillSubtitles
(
PTRINT SubtitleID |
Kill specified subtitles. |
 |
FSubtitleManagerSetSubtitleText & | HACK: Returns the delegate for setting subtitle text | |
  |
void | QueueSubtitles
(
const FQueueSubtitleParams& QueueSubtitlesParams |
|
 |
void | QueueSubtitles
(
PTRINT SubtitleID, |
Add an array of subtitles to the active list |
 |
void | SetMovieSubtitle
(
UObject* SubtitleOwner, |
HACK: Accept a movie subtitle and display it to all currently registered displays. |
 |
void | SplitLinesToSafeZone
(
FCanvas* Canvas, |
If any of the active subtitles need to be split into multiple lines, do so now. |
 |
void | TrimRegionToSafeZone
(
FCanvas* Canvas, |
Trim the SubtitleRegion to the safe 80% of the canvas. |