unreal.MidiSongPos

class unreal.MidiSongPos(seconds_from_bar_one: float = 0.0, seconds_including_count_in: float = 0.0, time_sig_numerator: int = 0, time_sig_denominator: int = 0, tempo: float = 0.0, bars_including_count_in: float = 0.0, beats_including_count_in: float = 0.0, beat_type: MusicalBeatType = Ellipsis, timestamp: MusicTimestamp = Ellipsis)

Bases: StructBase

Position within a song (midi info)

C++ Source:

  • Plugin: Harmonix

  • Module: HarmonixMidi

  • File: MidiSongPos.h

Editor Properties: (see get_editor_property/set_editor_property)

  • bars_including_count_in (float): [Read-Write] Total bars from the beginning of the song.

  • beat_type (MusicalBeatType): [Read-Write] Whether this beat is a Downbeat (beat 1 of the current bar) or otherwise This value is determined by the authored content Defaults to “Normal”

  • beats_including_count_in (float): [Read-Write] Total beats from the beginning of the song.

  • seconds_from_bar_one (float): [Read-Write] Total seconds from bar 1 beat 1. (negative for count-in and/or pickup bars)

  • seconds_including_count_in (float): [Read-Write] Total seconds from the beginning of the musical content (ie. includes all count-in and pickup bars)

  • tempo (float): [Read-Write] Tempo in Quarter Notes Per Minute (BPM)

  • time_sig_denominator (int32): [Read-Write] Time Signature Numerator (Indicates Subdivision of Bar that counts as 1 beat (4 means Quarter Note = One Beat))

  • time_sig_numerator (int32): [Read-Write] Time Signature Numerator (Indicates Number of Beats Per Bar)

  • timestamp (MusicTimestamp): [Read-Write] The Musical Timestamp: Bar Number and Beat Number within the bar (Bar 1 Beat 1.0f)

property bars_including_count_in: float

[Read-Only] Total bars from the beginning of the song.

Type:

(float)

property beat_type: MusicalBeatType

[Read-Only] Whether this beat is a Downbeat (beat 1 of the current bar) or otherwise This value is determined by the authored content Defaults to “Normal”

Type:

(MusicalBeatType)

property beats_including_count_in: float

[Read-Only] Total beats from the beginning of the song.

Type:

(float)

property seconds_from_bar_one: float

[Read-Only] Total seconds from bar 1 beat 1. (negative for count-in and/or pickup bars)

Type:

(float)

property seconds_including_count_in: float

[Read-Only] Total seconds from the beginning of the musical content (ie. includes all count-in and pickup bars)

Type:

(float)

property tempo: float

[Read-Only] Tempo in Quarter Notes Per Minute (BPM)

Type:

(float)

property time_sig_denominator: int

[Read-Only] Time Signature Numerator (Indicates Subdivision of Bar that counts as 1 beat (4 means Quarter Note = One Beat))

Type:

(int32)

property time_sig_numerator: int

[Read-Only] Time Signature Numerator (Indicates Number of Beats Per Bar)

Type:

(int32)

property timestamp: MusicTimestamp

Bar Number and Beat Number within the bar (Bar 1 Beat 1.0f)

Type:

(MusicTimestamp)

Type:

[Read-Only] The Musical Timestamp