unreal.MusicalSyncPointCaptureMode

class unreal.MusicalSyncPointCaptureMode

Bases: EnumBase

EMusical Sync Point Capture Mode

C++ Source:

  • Plugin: MusicEnvironment

  • Module: MusicEnvironment

  • File: MusicalEnums.h

DIRECT_MAPPED: MusicalSyncPointCaptureMode = Ellipsis

Bar 1 | Beat 1 of the level sequence is mapped directly to Bar 1 | Beat 1 of the driving music clock. If needed the sequence is ‘seeked’ to match the current time of the music clock.

Type:

0

IMMEDIATE: MusicalSyncPointCaptureMode = Ellipsis

Bar 1 | Beat 1 of the level sequence will be mapped to the current position of the music clock. Now quantization is done. While the sequence will advance in a locked-step, tempo matched way, its offset will be maintained. CAREFUL! You probably want to use some sort of qunatized capture.

Type:

1

NEAREST_QUANTIZED_POSITION: MusicalSyncPointCaptureMode = Ellipsis

Bar 1 | Beat 1 of the level sequence is mapped to the NEAREST specified quantized musical subdivision. May be before or after the current musical time. Playback will start right away if the nearest subdivision is in the past, otherwise playback will start when the next subdivision arrives.

Type:

2

NEXT_QUANTIZED_POSITION: MusicalSyncPointCaptureMode = Ellipsis

Bar 1 | Beat 1 of the level sequence is mapped to the NEXT specified quantized musical subdivision. Will be on or after the current musical time. Playback will start when that subdivision arrives.

Type:

3

PREVIOUS_QUANTIZED_POSITION: MusicalSyncPointCaptureMode = Ellipsis

Bar 1 | Beat 1 of the level sequence is mapped to the Previous specified quantized musical subdivision. Will be on or before the current musical time. Playback will start right away.

Type:

4