Clef

A library of general clef utility functions.

Functions

• get_cell_clef(measure, staff_number)
• get_default_clef(first_measure, last_measure, staff_number)
• set_measure_clef(first_measure, last_measure, staff_number, clef_index)
• restore_default_clef(first_measure, last_measure, staff_number)
• process_clefs(mid_clefs)
• clef_change(clef)

get_cell_clef

clef.get_cell_clef(measure, staff_number)

View source

Gets the clef for any cell.

Input	Type	Description
measure	number	The measure number for the cell
staff_number	number	The staff number for the cell

Return type	Description
number	The clef for the cell

get_default_clef

clef.get_default_clef(first_measure, last_measure, staff_number)

View source

Gets the default clef for any staff for a specific region.

Input	Type	Description
first_measure	number	The first measure of the region
last_measure	number	The last measure of the region
staff_number	number	The staff number for the cell

Return type	Description
number	The default clef for the staff

set_measure_clef

clef.set_measure_clef(first_measure, last_measure, staff_number, clef_index)

View source

Sets the clefs of of a range measures.

Input	Type	Description
first_measure	number	The first measure of the region
last_measure	number	The last measure of the region
staff_number	number	The staff number for the cell
clef_index	number	The clef to set

restore_default_clef

clef.restore_default_clef(first_measure, last_measure, staff_number)

View source

Restores the default clef for any staff for a specific region.

Input	Type	Description
first_measure	number	The first measure of the region
last_measure	number	The last measure of the region
staff_number	number	The staff number for the cell

process_clefs

clef.process_clefs(mid_clefs)

View source

Processes a table of clef changes and returns them in order, without duplicates.

:(FCCellClefChanges)

Input	Type	Description
mid_clefs	FCCellClefChanges

clef_change

clef.clef_change(clef)

View source

Inserts a clef change in the selected region.

@ region FCMusicRegion The region to change.

Input	Type	Description
clef	string	The clef to change to.