MuseScore Plugins  3.5
Plugins API for MuseScore
Public Member Functions | Properties | List of all members
Part Class Reference
Inheritance diagram for Part:
Inheritance graph
[legend]
Collaboration diagram for Part:
Collaboration graph
[legend]

Public Member Functions

Q_INVOKABLE Ms::PluginAPI::InstrumentinstrumentAtTick (int tick)
 Finds an instrument that is active in this part at the given tick. More...
 
- Public Member Functions inherited from ScoreElement
Q_INVOKABLE QString userName () const
 Human-readable element type name. More...
 
Q_INVOKABLE bool is (Ms::PluginAPI::ScoreElement *other)
 Checks whether two variables represent the same object. More...
 

Properties

int startTrack
 
int endTrack
 
QString instrumentId
 The string identifier (MusicXML Sound ID) for the first instrument in this part. More...
 
int harmonyCount
 The number of Chord Symbols. More...
 
bool hasDrumStaff
 Whether it is a percussion staff. More...
 
bool hasPitchedStaff
 Whether it is a 'normal' staff with notes. More...
 
bool hasTabStaff
 Whether it is a tablature staff. More...
 
int lyricCount
 The number of lyrics syllables. More...
 
int midiChannel
 One of 16 music channels that can be assigned an instrument. More...
 
int midiProgram
 One of the 128 different instruments in General MIDI. More...
 
QString longName
 The long name for the current instrument. More...
 
QString shortName
 The short name for the current instrument. More...
 
QString partName
 The name of the current part of music. More...
 
bool show
 Whether part is shown or hidden. More...
 
QQmlListProperty< Ms::PluginAPI::Instrumentinstruments
 List of instruments in this part. More...
 
- Properties inherited from ScoreElement
int type
 Type of this element. More...
 
QString name
 Name of this element's type, not localized. More...
 

Member Function Documentation

◆ instrumentAtTick()

Instrument * instrumentAtTick ( int  tick)

Finds an instrument that is active in this part at the given tick.

Since
MuseScore 3.5

Property Documentation

◆ harmonyCount

int harmonyCount
read

The number of Chord Symbols.

Since
MuseScore 3.2.1

◆ hasDrumStaff

bool hasDrumStaff
read

Whether it is a percussion staff.

Since
MuseScore 3.2.1

◆ hasPitchedStaff

bool hasPitchedStaff
read

Whether it is a 'normal' staff with notes.

Since
MuseScore 3.2.1

◆ hasTabStaff

bool hasTabStaff
read

Whether it is a tablature staff.

Since
MuseScore 3.2.1

◆ instrumentId

QString instrumentId
read

The string identifier (MusicXML Sound ID) for the first instrument in this part.

See also
Instrument.instrumentId
Since
MuseScore 3.2

◆ instruments

InstrumentListProperty instruments
read

List of instruments in this part.

Since
MuseScore 3.5

◆ longName

QString longName
read

The long name for the current instrument.

Note that this property was writeable in MuseScore v2.x

Since
MuseScore 3.2.1

◆ lyricCount

int lyricCount
read

The number of lyrics syllables.

Since
MuseScore 3.2.1

◆ midiChannel

int midiChannel
read

One of 16 music channels that can be assigned an instrument.

Since
MuseScore 3.2.1

◆ midiProgram

int midiProgram
read

One of the 128 different instruments in General MIDI.

Since
MuseScore 3.2.1

◆ partName

QString partName
read

The name of the current part of music.

It is shown in Mixer.

Note that this property was writeable in MuseScore v2.x

Since
MuseScore 3.2.1

◆ shortName

QString shortName
read

The short name for the current instrument.

Note that this property was writeable in MuseScore v2.x

Since
MuseScore 3.2.1

◆ show

bool show
readwrite

Whether part is shown or hidden.

This property is writeable since MuseScore 3.6 (and was writable in MuseScore 2.x)

Since
MuseScore 3.2.1

The documentation for this class was generated from the following files: