unreal.SubtitleAssetData

class unreal.SubtitleAssetData(text: Text = '', subtitle_duration_type: SubtitleDurationType = Ellipsis, duration: float = 0.0, start_offset: float = 0.0, priority: float = 0.0, subtitle_type: SubtitleType = Ellipsis)

Bases: StructBase

Subtitle Asset Data

C++ Source:

  • Module: Engine

  • File: SubtitlesAndClosedCaptionsDelegates.h

Editor Properties: (see get_editor_property/set_editor_property)

  • comment (str): [Read-Write] Author comments, editor-only.

  • duration (float): [Read-Write] Time to display in seconds. Defaulted to 3 seconds so when adding new subtitles it’s not required to enter a placeholder Duration. Duration can be be set by ingestion pipelines when importing Subtitles in bulk

  • priority (float): [Read-Write] The priority of the subtitle. Defaults to 1. Higher values will play instead of lower values.

  • start_offset (float): [Read-Write] Some subtitles have a delay before they’re allowed to be displayed (primarily from the legacy system). StartOffset measures how long in Seconds, after queuing, before the subtitle is allowed to enter the active subtitles queue. ESubtitleTiming::ExternallyTimed does not effect this initial delay.

  • subtitle_duration_type (SubtitleDurationType): [Read-Write] Whether to automatically unqueue the subtitle using an associated Sound, or to use the duration supplied below.

  • subtitle_type (SubtitleType): [Read-Write] Subtitle type for type-specific rendering.

  • text (Text): [Read-Write] The text to appear in the subtitle.

property duration: float

[Read-Write] Time to display in seconds. Defaulted to 3 seconds so when adding new subtitles it’s not required to enter a placeholder Duration. Duration can be be set by ingestion pipelines when importing Subtitles in bulk

Type:

(float)

property priority: float

[Read-Write] The priority of the subtitle. Defaults to 1. Higher values will play instead of lower values.

Type:

(float)

property start_offset: float

[Read-Write] Some subtitles have a delay before they’re allowed to be displayed (primarily from the legacy system). StartOffset measures how long in Seconds, after queuing, before the subtitle is allowed to enter the active subtitles queue. ESubtitleTiming::ExternallyTimed does not effect this initial delay.

Type:

(float)

property subtitle_duration_type: SubtitleDurationType

[Read-Write] Whether to automatically unqueue the subtitle using an associated Sound, or to use the duration supplied below.

Type:

(SubtitleDurationType)

property subtitle_type: SubtitleType

[Read-Write] Subtitle type for type-specific rendering.

Type:

(SubtitleType)

property text: Text

[Read-Write] The text to appear in the subtitle.

Type:

(Text)