FSubtitleManager::QueueSubtitles

Add an array of subtitles to the active list

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/SubtitleManager.h

Include

#include "SubtitleManager.h"

Source

/Engine/Source/Runtime/Engine/Private/SubtitleManager.cpp

Syntax

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

Remarks

Add an array of subtitles to the active list

Parameters

Parameter

Description

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.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss