unreal.SubtitleAssetUserData

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

Bases: AssetUserData

Base class for subtitle data being attached to assets

C++ Source:

  • Module: Engine

  • File: SubtitlesAndClosedCaptionsDelegates.h

Editor Properties: (see get_editor_property/set_editor_property)

  • duration (float): [Read-Write] #SUBTITLES_PRD: carried over from FSubtitleCue, still required

    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

  • esrb (SRB): [Read-Write] ESRB rating category.

  • priority (float): [Read-Write] #SUBTITLES_PRD: Priority comes from USoundBase::GetSubtitlePriority, USoundCue::GetSubtitlePriority and USoundWave::GetSubtitlePriority Consolidate various subtitle properties throughout sound/audio code into this new subtitles plugin. Kept the 10000 default in case that’s what users are already used to.

    The priority of the subtitle. Defaults to 10000. 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_type (SubtitleType): [Read-Write] Subtitle type for type-specific rendering.

  • text (Text): [Read-Write] #SUBTITLES_PRD: carried over from FSubtitleCue, still required

    The text to appear in the subtitle.

property duration: float

carried over from FSubtitleCue, still required

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)

Type:

[Read-Write] #SUBTITLES_PRD

property esrb: SRB

[Read-Write] ESRB rating category.

Type:

(SRB)

property priority: float

Priority comes from USoundBase::GetSubtitlePriority, USoundCue::GetSubtitlePriority and USoundWave::GetSubtitlePriority Consolidate various subtitle properties throughout sound/audio code into this new subtitles plugin. Kept the 10000 default in case that’s what users are already used to.

The priority of the subtitle. Defaults to 10000. Higher values will play instead of lower values.

Type:

(float)

Type:

[Read-Write] #SUBTITLES_PRD

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_type: SubtitleType

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

Type:

(SubtitleType)

property text: Text

carried over from FSubtitleCue, still required

The text to appear in the subtitle.

Type:

(Text)

Type:

[Read-Write] #SUBTITLES_PRD