Skip to content

Score

Access via the module attribute flpianoroll.score.

Represents the current selection of the FL Studio score, or, if there is no selection, the full contents of the current instrument on the piano roll.

PPQ: int property

The PPQN (ticks per quarter note) of the score.

Read-only.

markerCount: int property

The number of markers currently in the score.

noteCount: int property

The number of notes currently in the score.

tsden: int property

The project's overall time signature denominator, as per the project settings. Note that this does not reflect time signature markers.

Read-only.

tsnum: int property

The project's overall time signature numerator, as per the project settings. Note that this does not reflect time signature markers.

Read-only.

addMarker(marker)

Add a marker to the score.

Args

  • marker (Marker): the marker to add

addNote(note)

Add a note to the score.

Args

  • note (Note): the note to add

clear(all=False)

Clear the selected notes and markers on the piano roll, or if there is no selection, clear everything.

Markers are considered to be selected if all notes within them are selected.

Args

  • all (bool, optional): whether to clear all content from the score, regardless of selection status. Defaults to False.

clearMarkers(all=False)

Clear the selected markers on the piano roll, or if there is no selection, clear all markers.

Markers are considered to be selected if all notes within them are selected.

Args

  • all (bool, optional): whether to clear all markers from the score, regardless of selection status. Defaults to False.

clearNotes(all=False)

Clear the selected notes on the piano roll, or if there is no selection, clear all notes.

Args

  • all (bool, optional): whether to clear all notes from the score, regardless of selection status. Defaults to False.

deleteMarker(index)

Remove the marker at position index from within the score.

Args

  • index (int): index of the marker to remove

deleteNote(index)

Remove the note at position index from within the score.

Args

  • index (int): index of the note to remove

getMarker(index)

Return the marker at position index from within the score.

Args

  • index (int): index of marker

Returns

  • Marker: the marker

getNote(index)

Return the note at position index from within the score.

Args

  • index (int): index of note

Returns

  • Note: the note