FSubtitleManager Class Reference

#include <SubtitleManager.h>

Public Member Functions
void	KillAllSubtitles (void)
void	KillSubtitles (PTRINT SubtitleID)
void	TrimRegionToSafeZone (FCanvas *Canvas, FIntRect &InOutSubtitleRegion)
void	SplitLinesToSafeZone (FCanvas *Canvas, FIntRect &SubtitleRegion)
PTRINT	FindHighestPrioritySubtitle (float CurrentTime)
ENGINE_API void	QueueSubtitles (PTRINT SubtitleID, float Priority, bool bManualWordWrap, bool bSingleLine, float SoundDuration, const TArray< FSubtitleCue > &Subtitles, float InStartTime, float InCurrentTime)
void	DisplaySubtitle (FCanvas *Canvas, FActiveSubtitle *Subtitle, FIntRect &Parms, const FLinearColor &Color)
ENGINE_API void	DisplaySubtitles (FCanvas *InCanvas, FIntRect &SubtitleRegion, float InAudioTimeSeconds)
bool	HasSubtitles ()
float	GetCurrentSubtitlesHeight ()
FSubtitleManagerSetSubtitleText &	OnSetSubtitleText ()
void ENGINE_API	SetMovieSubtitle (UObject *SubtitleOwner, const TArray< FString > &Subtitles)

Static Public Member Functions
static void	QueueSubtitles (const FQueueSubtitleParams &QueueSubtitlesParams)
static ENGINE_API FSubtitleManager *	GetSubtitleManager ()

Detailed Description

Subtitle manager. Handles prioritization and rendering of subtitles.

Member Function Documentation

DisplaySubtitle()

void FSubtitleManager::DisplaySubtitle	(	FCanvas *	Canvas,
		FActiveSubtitle *	Subtitle,
		FIntRect &	Parms,
		const FLinearColor &	Color
	)

Draws a subtitle at the specified pixel location.

DisplaySubtitles()

void FSubtitleManager::DisplaySubtitles	(	FCanvas *	InCanvas,
		FIntRect &	SubtitleRegion,
		float	InAudioTimeSeconds
	)

Display the currently queued subtitles and cleanup after they have finished rendering.

Parameters

Canvas	Where to render the subtitles.
CurrentTime	Current world time.

FindHighestPrioritySubtitle()

PTRINT FSubtitleManager::FindHighestPrioritySubtitle

(

float

CurrentTime

)

Find the highest priority subtitle from the list of currently active ones.

Parameters

CurrentTime

The time at which to find the subtitle.

Returns

Found subtitle identifier.

GetCurrentSubtitlesHeight()

float FSubtitleManager::GetCurrentSubtitlesHeight ( )

inline

Get the height of currently rendered subtitles.

Returns

Subtitle height (in pixels), or 0 if none are rendering.

GetSubtitleManager()

FSubtitleManager * FSubtitleManager::GetSubtitleManager ( )

static

Get the subtitle manager singleton instance.

Returns

Subtitle manager.

HasSubtitles()

bool FSubtitleManager::HasSubtitles ( )

inline

Whether there are any active subtitles.

Returns

true if there are any active subtitles, false otherwise.

KillAllSubtitles()

void FSubtitleManager::KillAllSubtitles

(

void

)

Kill all the subtitles.

KillSubtitles()

void FSubtitleManager::KillSubtitles

(

PTRINT

SubtitleID

)

Kill specified subtitles.

Parameters

SubtitleId

Identifier of the subtitles to kill.

OnSetSubtitleText()

FSubtitleManagerSetSubtitleText & FSubtitleManager::OnSetSubtitleText ( )

inline

HACK: Returns the delegate for setting subtitle text

QueueSubtitles() [1/2]

void FSubtitleManager::QueueSubtitles ( const FQueueSubtitleParams &  QueueSubtitlesParams )

static

QueueSubtitles() [2/2]

void FSubtitleManager::QueueSubtitles	(	PTRINT	SubtitleID,
		float	Priority,
		bool	bManualWordWrap,
		bool	bSingleLine,
		float	SoundDuration,
		const TArray< FSubtitleCue > &	Subtitles,
		float	InStartTime,
		float	InCurrentTime
	)

Add an array of subtitles to the active list

Parameters

SubTitleID	The controlling id that groups sets of subtitles together.
Priority	Used to prioritize subtitles; higher values have higher priority. Subtitles with a priority 0.0f are not displayed.
StartTime	Time at which the subtitles start (in seconds).
SoundDuration	Time after which the subtitles do not display (in seconds).
Subtitles	Collection of lines of subtitle and time offset to play them.

SetMovieSubtitle()

void FSubtitleManager::SetMovieSubtitle	(	UObject *	SubtitleOwner,
		const TArray< FString > &	Subtitles
	)

HACK: Accept a movie subtitle and display it to all currently registered displays. This will not work with the old Canvas drawing system.

Parameters

SubtitleOwner	The owner of the movie subtitle. If this is null, the subtitle will not be set
MovieSubtitles	The subtitle text to display to all currently active displays

SplitLinesToSafeZone()

void FSubtitleManager::SplitLinesToSafeZone	(	FCanvas *	Canvas,
		FIntRect &	SubtitleRegion
	)

If any of the active subtitles need to be split into multiple lines, do so now.

Note: This assumes the width of the subtitle region does not change while the subtitle is active.

TrimRegionToSafeZone()

void FSubtitleManager::TrimRegionToSafeZone	(	FCanvas *	Canvas,
		FIntRect &	InOutSubtitleRegion
	)

Trim the SubtitleRegion to the safe 80% of the canvas.

Parameters

Canvas	The canvas to trim to.
InOutSubtitleRegion	The trim region.

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Engine/Public/SubtitleManager.h
• Engine/Source/Runtime/Engine/Private/SubtitleManager.cpp