Class MidiInstrument

The <midi-instrument> element

Parent elements: <score-part>, <sound>

The <midi-instrument> element 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 ` element within a part.

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:9560

Properties

attributes

attributes: MidiInstrumentAttributes

contents: MidiInstrumentContents

`Readonly` schema

schema: {
    attributes: {
        id: {
            type: "required";
            value: {
                pattern: RegExp;
                type: "regex";
                zero: "_";
            };
        };
    };
    contents: readonly [{
        type: "optional";
        value: typeof MidiChannel;
    }, {
        type: "optional";
        value: typeof MidiName;
    }, {
        type: "optional";
        value: typeof MidiBank;
    }, {
        type: "optional";
        value: typeof MidiProgram;
    }, {
        type: "optional";
        value: typeof MidiUnpitched;
    }, {
        type: "optional";
        value: typeof Volume;
    }, {
        type: "optional";
        value: typeof Pan;
    }, {
        type: "optional";
        value: typeof Elevation;
    }];
    name: "midi-instrument";
} = MidiInstrument.schema

Type declaration

Readonly attributes: {
    id: {
        type: "required";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        };
    };
}
- Readonly id: {
      type: "required";
      value: {
          pattern: RegExp;
          type: "regex";
          zero: "_";
      };
  }
  - Readonly type: "required"
  - Readonly value: {
        pattern: RegExp;
        type: "regex";
        zero: "_";
    }
    - Readonly pattern: RegExp
    - Readonly type: "regex"
    - Readonly zero: "_"
Readonly contents: readonly [{
    type: "optional";
    value: typeof MidiChannel;
}, {
    type: "optional";
    value: typeof MidiName;
}, {
    type: "optional";
    value: typeof MidiBank;
}, {
    type: "optional";
    value: typeof MidiProgram;
}, {
    type: "optional";
    value: typeof MidiUnpitched;
}, {
    type: "optional";
    value: typeof Volume;
}, {
    type: "optional";
    value: typeof Pan;
}, {
    type: "optional";
    value: typeof Elevation;
}]
Readonly name: "midi-instrument"

`Static` `Readonly` schema

Type declaration

Readonly attributes: {
    id: {
        type: "required";
        value: {
            pattern: RegExp;
            type: "regex";
            zero: "_";
        };
    };
}
- Readonly id: {
      type: "required";
      value: {
          pattern: RegExp;
          type: "regex";
          zero: "_";
      };
  }
  - Readonly type: "required"
  - Readonly value: {
        pattern: RegExp;
        type: "regex";
        zero: "_";
    }
    - Readonly pattern: RegExp
    - Readonly type: "regex"
    - Readonly zero: "_"
Readonly contents: readonly [{
    type: "optional";
    value: typeof MidiChannel;
}, {
    type: "optional";
    value: typeof MidiName;
}, {
    type: "optional";
    value: typeof MidiBank;
}, {
    type: "optional";
    value: typeof MidiProgram;
}, {
    type: "optional";
    value: typeof MidiUnpitched;
}, {
    type: "optional";
    value: typeof Volume;
}, {
    type: "optional";
    value: typeof Pan;
}, {
    type: "optional";
    value: typeof Elevation;
}]
Readonly name: "midi-instrument"

Methods

getElevation

getElevation(): null | Elevation
Gets

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

getId

getId(): string
Gets

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

getMidiBank

getMidiBank(): null | MidiBank
Gets

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

getMidiChannel

getMidiChannel(): null | MidiChannel
Gets

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

getMidiName

getMidiName(): null | MidiName
Gets

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

getMidiProgram

getMidiProgram(): null | MidiProgram
Gets

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

getMidiUnpitched

getMidiUnpitched(): null | MidiUnpitched
Gets

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

getPan

getPan(): null | Pan
Gets

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

getVolume

getVolume(): null | Volume
Gets

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

setElevation

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

setId

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

setMidiBank

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

setMidiChannel

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

setMidiName

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

setMidiProgram

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

setMidiUnpitched

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

setPan

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

setVolume

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

Class MidiInstrument

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

Type declaration

Readonly attributes: { id: { type: "required"; value: { pattern: RegExp; type: "regex"; zero: "_"; }; }; }

Readonly id: { type: "required"; value: { pattern: RegExp; type: "regex"; zero: "_"; }; }

Readonly type: "required"

Readonly value: { pattern: RegExp; type: "regex"; zero: "_"; }

Readonly pattern: RegExp

Readonly type: "regex"

Readonly zero: "_"

Readonly name: "midi-instrument"

Static Readonly schema

Type declaration

Readonly attributes: { id: { type: "required"; value: { pattern: RegExp; type: "regex"; zero: "_"; }; }; }

Readonly id: { type: "required"; value: { pattern: RegExp; type: "regex"; zero: "_"; }; }

Readonly type: "required"

Readonly value: { pattern: RegExp; type: "regex"; zero: "_"; }

Readonly pattern: RegExp

Readonly type: "regex"

Readonly zero: "_"

Readonly name: "midi-instrument"

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

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

`Optional` attributes?: Partial<MidiInstrumentAttributes>

`Optional` contents?: MidiInstrumentContents

`Readonly` schema

`Readonly` attributes: {
id: {
type: "required";
value: {
pattern: RegExp;
type: "regex";
zero: "_";
};
};
}

`Readonly` id: {
type: "required";
value: {
pattern: RegExp;
type: "regex";
zero: "_";
};
}

`Readonly` type: "required"

`Readonly` value: {
pattern: RegExp;
type: "regex";
zero: "_";
}

`Readonly` pattern: RegExp

`Readonly` type: "regex"

`Readonly` zero: "_"

`Readonly` name: "midi-instrument"

`Static` `Readonly` schema

`Readonly` attributes: {
id: {
type: "required";
value: {
pattern: RegExp;
type: "regex";
zero: "_";
};
};
}

`Readonly` id: {
type: "required";
value: {
pattern: RegExp;
type: "regex";
zero: "_";
};
}

`Readonly` type: "required"

`Readonly` value: {
pattern: RegExp;
type: "regex";
zero: "_";
}

`Readonly` pattern: RegExp

`Readonly` type: "regex"

`Readonly` zero: "_"

`Readonly` name: "midi-instrument"