Navigation
API > API/Plugins > API/Plugins/SubtitlesAndClosedCaptions
SubtitlesAudioSubsystem - AudioEngineSubsystem for automatically queueing subtitles on audio classes.
Separated from SubtitlesSubsystem, which is a UWorldSubsystem, to avoid issues with lifecycle management as some parts need access to the world and others to the audio device.
| Name | USubtitlesAudioSubsystem |
| Type | class |
| Header File | /Engine/Plugins/SubtitlesAndClosedCaptions/Source/SubtitlesAndClosedCaptions/Public/SubtitlesAudioSubsystem.h |
| Include Path | #include "SubtitlesAudioSubsystem.h" |
Syntax
UCLASS (MinimalAPI, Config=Game, defaultconfig)
class USubtitlesAudioSubsystem :
public UAudioEngineSubsystem ,
public IActiveSoundUpdateInterface
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USubsystem → UDynamicSubsystem → UAudioEngineSubsystem → USubtitlesAudioSubsystem
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
USubtitlesAudioSubsystem() |
SubtitlesAudioSubsystem.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| QueuedSubtitlesByPlayOrder | TMap< uint32, TArray< FSubtitleAssetData > > | Tracks which subtitle data is queued for each active sound. | SubtitlesAudioSubsystem.h |
Functions
Public
Public Virtual
Overridden from USubsystem
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Deinitialize() |
SubtitlesAudioSubsystem.h | ||
virtual void Initialize
(
FSubsystemCollectionBase& Collection |
SubtitlesAudioSubsystem.h |
Overridden from IActiveSoundUpdateInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void NotifyActiveSoundCreated
(
FActiveSound& ActiveSound |
SubtitlesAudioSubsystem.h | ||
virtual void NotifyActiveSoundDeleting
(
const FActiveSound& ActiveSound |
SubtitlesAudioSubsystem.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void QueueSubtitleFromDialogueWaveProxy
(
const UDialogueSoundWaveProxy* DialogueWaveProxy, |
SubtitlesAudioSubsystem.h | ||
static void StopSubtitleFromDialogueWaveProxy
(
const UDialogueSoundWaveProxy* DialogueWaveProxy, |
SubtitlesAudioSubsystem.h |