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