unreal.SubtitlesLibrary

class unreal.SubtitlesLibrary(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

Subtitles Blueprint Function Library

C++ Source:

  • Plugin: SubtitlesAndClosedCaptions

  • Module: SubtitlesAndClosedCaptions

  • File: SubtitlesBlueprintFunctionLibrary.h

classmethod is_subtitle_active(subtitle) → bool

Is Subtitle Active

Parameters:

subtitle (SubtitleAssetData)

Return type:

bool

classmethod queue_single_subtitle(text, duration, start_offset, priority, subtitle_type, timing=SubtitleTiming.INTERNALLY_TIMED) → None

Queues an individual subtitle. Parameters form an FSubtitleAssetData (see SubtitlesAndClosedCaptionsDelegates.h), but the Duration Type is removed as it is irrelevant for queueing this way.

Parameters:
classmethod queue_subtitle(subtitle, timing=SubtitleTiming.INTERNALLY_TIMED) → None

Queue Subtitle

Parameters:
classmethod queue_subtitles_from_asset(subtitle_asset) → None

Queues all of the subtitles in a Subtitle asset, accounting for any delayed start offsets set for each. Subtitles queued through this function are internally-timed.

Parameters:

subtitle_asset (SubtitleAssetUserData)

classmethod replace_subtitle_widget(new_widget_asset) → None

Replace Subtitle Widget

Parameters:

new_widget_asset (Class)

classmethod stop_all_subtitles() → None

Stop All Subtitles

classmethod stop_subtitle(subtitle) → None

Stop Subtitle

Parameters:

subtitle (SubtitleAssetData)

classmethod stop_subtitles_in_asset(subtitle_asset) → None

Stops all subtitles in a subtitle asset, regardless of whether they’re already queued or if they have a delayed start.

Parameters:

subtitle_asset (SubtitleAssetUserData)