Class MidiInstrument

The <midi-instrument> element.

The midi-instrument type defines MIDI 1.0 instrument playback. The midi-instrument element can be a part of either the score-instrument element at the start of a part, or the sound element within a part. The id attribute refers to the score-instrument affected by the change.

See

https://www.w3.org/2021/06/musicxml40/musicxml-reference/elements/midi-instrument/

Hierarchy

MidiInstrument

Implements

XMLElement<"midi-instrument", MidiInstrumentAttributes, MidiInstrumentContents>

Index

Constructors

constructor

new MidiInstrument(opts?): MidiInstrument
Parameters
- Optional opts: {
  attributes?: Partial<MidiInstrumentAttributes>;
  contents?: MidiInstrumentContents;
  }
  - Optional attributes?: Partial<MidiInstrumentAttributes>
  - Optional contents?: MidiInstrumentContents
Returns MidiInstrument
- Defined in generated/elements.ts:7198

Properties

attributes

attributes: MidiInstrumentAttributes

contents: MidiInstrumentContents

`Readonly` schema

schema: XMLElementSchema<"midi-instrument"> = MidiInstrument.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"midi-instrument"> = schema.MidiInstrument

Methods

getElevation

getElevation(): null | Elevation
Gets

Returns null | Elevation
- Defined in generated/elements.ts:7275

getId

getId(): string
Gets

Returns string
- Defined in generated/elements.ts:7203

getMidiBank

getMidiBank(): null | MidiBank
Gets

Returns null | MidiBank
- Defined in generated/elements.ts:7230

getMidiChannel

getMidiChannel(): null | MidiChannel
Gets

Returns null | MidiChannel
- Defined in generated/elements.ts:7212

getMidiName

getMidiName(): null | MidiName
Gets

Returns null | MidiName
- Defined in generated/elements.ts:7221

getMidiProgram

getMidiProgram(): null | MidiProgram
Gets

Returns null | MidiProgram
- Defined in generated/elements.ts:7239

getMidiUnpitched

getMidiUnpitched(): null | MidiUnpitched
Gets

Returns null | MidiUnpitched
- Defined in generated/elements.ts:7248

getPan

getPan(): null | Pan
Gets

Returns null | Pan
- Defined in generated/elements.ts:7266

getVolume

getVolume(): null | Volume
Gets

Returns null | Volume
- Defined in generated/elements.ts:7257

setElevation

setElevation(elevation): MidiInstrument
Sets
Parameters
- elevation: null | Elevation
Returns MidiInstrument
- Defined in generated/elements.ts:7279

setId

setId(id): MidiInstrument
Sets
Parameters
- id: string
Returns MidiInstrument
- Defined in generated/elements.ts:7207

setMidiBank

setMidiBank(midiBank): MidiInstrument
Sets
Parameters
- midiBank: null | MidiBank
Returns MidiInstrument
- Defined in generated/elements.ts:7234

setMidiChannel

setMidiChannel(midiChannel): MidiInstrument
Sets
Parameters
- midiChannel: null | MidiChannel
Returns MidiInstrument
- Defined in generated/elements.ts:7216

setMidiName

setMidiName(midiName): MidiInstrument
Sets
Parameters
- midiName: null | MidiName
Returns MidiInstrument
- Defined in generated/elements.ts:7225

setMidiProgram

setMidiProgram(midiProgram): MidiInstrument
Sets
Parameters
- midiProgram: null | MidiProgram
Returns MidiInstrument
- Defined in generated/elements.ts:7243

setMidiUnpitched

setMidiUnpitched(midiUnpitched): MidiInstrument
Sets
Parameters
- midiUnpitched: null | MidiUnpitched
Returns MidiInstrument
- Defined in generated/elements.ts:7252

setPan

setPan(pan): MidiInstrument
Sets
Parameters
- pan: null | Pan
Returns MidiInstrument
- Defined in generated/elements.ts:7270

setVolume

setVolume(volume): MidiInstrument
Sets
Parameters
- volume: null | Volume
Returns MidiInstrument
- Defined in generated/elements.ts:7261

Class MidiInstrument

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<MidiInstrumentAttributes>; contents?: MidiInstrumentContents; }

Optional attributes?: Partial<MidiInstrumentAttributes>

Optional contents?: MidiInstrumentContents

Returns MidiInstrument

Properties

attributes

contents

Readonly schema

Static Readonly schema

Methods

getElevation

Returns null | Elevation

getId

Returns string

getMidiBank

Returns null | MidiBank

getMidiChannel

Returns null | MidiChannel

getMidiName

Returns null | MidiName

getMidiProgram

Returns null | MidiProgram

getMidiUnpitched

Returns null | MidiUnpitched

getPan

Returns null | Pan

getVolume

Returns null | Volume

setElevation

Parameters

elevation: null | Elevation

Returns MidiInstrument

setId

Parameters

id: string

Returns MidiInstrument

setMidiBank

Parameters

midiBank: null | MidiBank

Returns MidiInstrument

setMidiChannel

Parameters

midiChannel: null | MidiChannel

Returns MidiInstrument

setMidiName

Parameters

midiName: null | MidiName

Returns MidiInstrument

setMidiProgram

Parameters

midiProgram: null | MidiProgram

Returns MidiInstrument

setMidiUnpitched

Parameters

midiUnpitched: null | MidiUnpitched

Returns MidiInstrument

setPan

Parameters

pan: null | Pan

Returns MidiInstrument

setVolume

Parameters

volume: null | Volume

Returns MidiInstrument

Settings

Theme

On This Page

`Optional` opts: {
attributes?: Partial<MidiInstrumentAttributes>;
contents?: MidiInstrumentContents;
}

`Optional` attributes?: Partial<MidiInstrumentAttributes>

`Optional` contents?: MidiInstrumentContents

`Readonly` schema

`Static` `Readonly` schema