Misc
Misc
Bases: _FLObject
Used for storing one time events, which don't fall into any other category.
Source code in pyflp/misc.py
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 |
|
artists: str = _StrProperty()
class-attribute
Project info -> Author.
channel_count: int = _UIntProperty()
class-attribute
Number of channels in the rack.
For Patcher presets, the total number of plugins used inside it.
cur_pattern: Optional[int] = _IntProperty()
class-attribute
Currently selected pattern number.
cur_filter: Optional[int] = _IntProperty()
class-attribute
Currently selected filter channel number.
data_path: str = _StrProperty()
class-attribute
Project settings -> Data folder.
comment: str = _StrProperty()
class-attribute
Project info -> Comments.
format: Format = _EnumProperty(Format)
class-attribute
The format of the the file. See Format
.
genre: str = _StrProperty()
class-attribute
Project info -> Genre.
loop_active: bool = _BoolProperty()
class-attribute
Whether a portion of the song is selected.
main_pitch: Optional[int] = _IntProperty()
class-attribute
Master pitch.
main_volume: Optional[int] = _IntProperty()
class-attribute
Master volume.
panning_law: Optional[PanningLaw] = _EnumProperty(PanningLaw)
class-attribute
Project settings -> Advanced -> Panning law.
play_truncated_notes: Optional[bool] = _BoolProperty()
class-attribute
Whether to play truncated notes in pattern clips.
ppq: int = _UIntProperty(_OneOfValidator(VALID_PPQS))
class-attribute
Pulses Per Quarter.
regname: str = _StrProperty()
class-attribute
Jumbled up name of the artist's FL Studio username. Can find it out decoded in Debug log section of FL.
Most pirated versions of FL cause this to be stored empty. IL can then detect projects made from cracked FL easily.
show_info: bool = _BoolProperty()
class-attribute
Project info -> Show info on opening.
shuffle: Optional[int] = _UIntProperty(max_=128)
class-attribute
Global channel swing mix (ig). Min: 0, Max: 128, Default: 64.
song_loop_pos: Optional[int] = _UIntProperty()
class-attribute
If a portion of a song is selected, it is stored as 4 byte integer, 2b for loop start position and 2b for loop end position.
time_sig_beat: Optional[int] = _UIntProperty()
class-attribute
Time signature denominator. Project settings -> Time settings.
time_sig_num: Optional[int] = _UIntProperty()
class-attribute
Time signature numerator. Project settings -> Time settings.
title: str = _StrProperty()
class-attribute
Project info -> Title.
url: str = _StrProperty()
class-attribute
Project info -> Web link.
version_build: Optional[int] = _IntProperty()
class-attribute
FLVersion.build
as an integer.
EventID
Bases: enum.IntEnum
Events used by Misc
.
Source code in pyflp/misc.py
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 |
|
Artists = TEXT + 15
class-attribute
See Misc.artists
.
Comment = TEXT + 3
class-attribute
See Misc.comment
.
CurrentFilterChannelNum = DWORD + 18
class-attribute
See Misc.cur_filter
.
CurrentPatternNum = WORD + 3
class-attribute
See Misc.cur_pattern
.
DataPath = TEXT + 10
class-attribute
See Misc.data_path
.
Genre = TEXT + 14
class-attribute
See Misc.genre
.
LoopActive = 9
class-attribute
See Misc.loop_active
.
MainPitch = WORD + 16
class-attribute
See Misc.main_pitch
.
PanningLaw = 23
class-attribute
See Misc.panning_law
.
PlayTruncatedNotes = 30
class-attribute
See Misc.play_truncated_notes
.
RegName = TEXT + 8
class-attribute
see Misc.regname
. Obsolete.
Registered = 28
class-attribute
See Misc.registered
.
SaveTimestamp = DATA + 29
class-attribute
See Misc.work_time
and Misc.start_date
.
ShowInfo = 10
class-attribute
See Misc.show_info
.
Shuffle = 11
class-attribute
See Misc.shuffle
.
SongLoopPos = DWORD + 24
class-attribute
See Misc.song_loop_pos
.
Tempo = DWORD + 28
class-attribute
See Misc.tempo
.
TimeSigBeat = 18
class-attribute
See Misc.time_sig_beat
.
TimeSigNum = 17
class-attribute
See Misc.time_sig_num
.
Title = TEXT + 2
class-attribute
See Misc.title
.
Url = TEXT + 5
class-attribute
See Misc.url
.
Version = TEXT + 7
class-attribute
First event in all FLPs, stored in ASCII for compatibility with older
FL versions (pre 12.0), so older FL can read this value and show a warning
before continuing to load. See Misc.version
.
VersionBuild = DWORD + 31
class-attribute
See Misc.version_build
.
Format
Bases: enum.IntEnum
File formats used by FL Studio.
Source code in pyflp/misc.py
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 |
|
Automation = 24
class-attribute
FL Studio State file (.fst). Stores controller events and automation channels.
ChannelState = 32
class-attribute
Entire channel (including plugin events). Stores as FST.
FXState = 50
class-attribute
Plugin events of a VST effect. Stored as FST.
GeneratorState = 49
class-attribute
Plugins events of a VST instrument. Stored as FST.
InsertState = 64
class-attribute
Insert and all its slots. Stored as FST.
None_ = -1
class-attribute
Temporary
PluginState = 48
class-attribute
Events of a native plugin on a channel or insert slot. Stored as FST.
Score = 16
class-attribute
FL Studio Score File (.fsc). Stores pattern notes and controller events.
Song = 0
class-attribute
FL Studio Project file (.flp).
start_date()
writable
property
The date when the project was started.
Stored in microseconds since Delphi epoch (31-December-1899).
Source code in pyflp/misc.py
277 278 279 280 281 282 283 |
|
tempo()
writable
property
Initial tempo of the project in BPM.
Source code in pyflp/misc.py
264 265 266 267 |
|
version()
writable
property
FL Studio version which was used to save the FLP. Changing this to a lower version will not make an FLP load magically inside FL Studio, as newer events and/or plugins might have been used.
Returns:
Type | Description |
---|---|
str
|
Optional[str]: A string of the format 'Major.Minor.Revision.Build'. |
Source code in pyflp/misc.py
219 220 221 222 223 224 225 226 227 228 |
|
work_time()
writable
property
The total amount of time the artist(s) worked on the project. Stored in microseconds.
Source code in pyflp/misc.py
292 293 294 295 296 |
|