unreal.MovieSceneAudioSection

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

Bases: MovieSceneSection

Audio section, for use in the audio track, or by attached audio objects

C++ Source:

  • Module: MovieSceneTracks

  • File: MovieSceneAudioSection.h

Editor Properties: (see get_editor_property/set_editor_property)

  • attenuation_settings (SoundAttenuation): [Read-Write] The attenuation settings to use.

  • color_tint (Color): [Read-Write] The color tint for this section

  • condition_container (MovieSceneConditionContainer): [Read-Write] Optional dynamic condition for whether this section evaluates at runtime.

  • easing (MovieSceneEasingSettings): [Read-Write]

  • eval_options (MovieSceneSectionEvalOptions): [Read-Write]

  • is_active (bool): [Read-Write] Toggle whether this section is active/inactive

  • is_locked (bool): [Read-Write] Toggle whether this section is locked/unlocked

  • looping (bool): [Read-Write] Allow looping if the section length is greater than the sound duration

  • override_attenuation (bool): [Read-Write] Should the attenuation settings on this section be used.

  • post_roll_frames (FrameNumber): [Read-Write] The amount of time to continue ‘postrolling’ this section for after evaluation has ended.

  • pre_roll_frames (FrameNumber): [Read-Write] The amount of time to prepare this section for evaluation before it actually starts.

  • section_range (MovieSceneFrameRange): [Read-Write] The range in which this section is active

  • sound (SoundBase): [Read-Write] The sound cue or wave that this section plays

  • start_frame_offset (FrameNumber): [Read-Write] The offset into the beginning of the audio clip

  • suppress_subtitles (bool): [Read-Write]

  • timecode_source (MovieSceneTimecodeSource): [Read-Write] The timecode at which this movie scene section is based (ie. when it was recorded)

get_attenuation_settings() → SoundAttenuation
Returns:

The attenuation settings

Return type:

SoundAttenuation

get_looping() → bool
Returns:

Whether to allow looping if the section length is greater than the sound duration

Return type:

bool

get_override_attenuation() → bool
Returns:

Whether override settings on this section should be used

Return type:

bool

get_playback_sound() → SoundBase

Gets the sound that this section should use for playback, taking into account localization concerns

Return type:

SoundBase

get_sound() → SoundBase

Gets the sound for this section

Return type:

SoundBase

get_start_offset() → FrameNumber

Get the offset into the beginning of the audio clip

Return type:

FrameNumber

get_suppress_subtitles() → bool
Returns:

Whether subtitles should be suppressed

Return type:

bool

set_attenuation_settings(attenuation_settings) → None

Set the attenuation settings for this audio section

Parameters:

attenuation_settings (SoundAttenuation)

set_looping(looping) → None

Set whether the sound should be looped

Parameters:

looping (bool)

set_override_attenuation(override_attenuation) → None

Set whether the attentuation should be overriden

Parameters:

override_attenuation (bool)

set_sound(sound) → None

Sets this section’s sound

Parameters:

sound (SoundBase)

set_start_offset(start_offset) → None

Set the offset into the beginning of the audio clip

Parameters:

start_offset (FrameNumber)

set_suppress_subtitles(suppress_subtitles) → None

Set whether subtitles should be suppressed

Parameters:

suppress_subtitles (bool)

property sound: SoundBase

[Read-Write] The sound cue or wave that this section plays

Type:

(SoundBase)