Navigation
API > API/Plugins > API/Plugins/SubtitlesAndClosedCaptions
SUBTITLES_PRD - Requirement: Ability to allow designers to “script” subtitle location for sequences and scenes to avoid subtitles overlapping important scenes or characters Use a UEngineSubsystem for blueprints
Game configuration for font customization per game
| Name | USubtitlesSubsystem |
| Type | class |
| Header File | /Engine/Plugins/Experimental/SubtitlesAndClosedCaptions/Source/SubtitlesAndClosedCaptions/Public/SubtitlesSubsystem.h |
| Include Path | #include "SubtitlesSubsystem.h" |
Syntax
UCLASS (MinimalAPI, Config=Game, defaultconfig)
class USubtitlesSubsystem : public UWorldSubsystem
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USubsystem → UWorldSubsystem → USubtitlesSubsystem
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
USubtitlesSubsystem() |
SubtitlesSubsystem.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bInitializedWidget | bool | SubtitlesSubsystem.h | ||
| SubtitleWidget | TObjectPtr< USubtitleWidget > | SubtitlesSubsystem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool IsSubtitleActive
(
const FSubtitleAssetData& Data |
Returns true if the given subtitle asset is being displayed. | SubtitlesSubsystem.h | |
virtual void QueueSubtitle
(
const FQueueSubtitleParameters& Params, |
Adds a subtitle to the queue: Params contains the subtitle asset and an optional duration. | SubtitlesSubsystem.h | |
virtual void ReplaceWidget
(
const TSubclassOf< USubtitleWidget >& NewWidgetAsset |
SubtitlesSubsystem.h | ||
virtual void StopAllSubtitles() |
Stops all queued subtitles from being displayed. This includes subtitles not yet being displayed due to their StartOffset. | SubtitlesSubsystem.h | |
virtual void StopSubtitle
(
const FSubtitleAssetData& Data |
Stops the given subtitle asset being displayed. This includes subtitles not yet being displayed due to their StartOffset. | SubtitlesSubsystem.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddActiveSubtitle
(
const FSubtitleAssetData& Subtitle, |
SubtitlesSubsystem.h | ||
virtual void BindDelegates() |
SubtitlesSubsystem.h | ||
virtual void MakeDelayedSubtitleActive
(
const FSubtitleAssetData& Subtitle, |
These need to be UFUNCTIONs for the Timer Delegate bindings. | SubtitlesSubsystem.h | |
virtual void RemoveActiveSubtitle
(
const FSubtitleAssetData& Subtitle |
SubtitlesSubsystem.h |
Overridden from USubsystem
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Initialize
(
FSubsystemCollectionBase& Collection |
SubtitlesSubsystem.h |