Class InstrumentChange

The <instrument-change> element.

The instrument-change element type represents a change to the virtual instrument sound for a given score-instrument. The id attribute refers to the score-instrument affected by the change. All instrument-change child elements can also be initially specified within the score-instrument element.

See

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

Hierarchy

InstrumentChange

Implements

XMLElement<"instrument-change", InstrumentChangeAttributes, InstrumentChangeContents>

Index

Constructors

constructor

new InstrumentChange(opts?): InstrumentChange
Parameters
- Optional opts: {
  attributes?: Partial<InstrumentChangeAttributes>;
  contents?: InstrumentChangeContents;
  }
  - Optional attributes?: Partial<InstrumentChangeAttributes>
  - Optional contents?: InstrumentChangeContents
Returns InstrumentChange
- Defined in generated/elements.ts:31762

Properties

attributes

attributes: InstrumentChangeAttributes

contents: InstrumentChangeContents

`Readonly` schema

schema: XMLElementSchema<"instrument-change"> = InstrumentChange.schema

`Static` `Readonly` schema

schema: XMLElementSchema<"instrument-change"> = schema.InstrumentChange

Methods

getId

getId(): string
Gets

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

getInstrumentSound

getInstrumentSound(): null | InstrumentSound
Gets

Returns null | InstrumentSound
- Defined in generated/elements.ts:31776

getInstrumentTypes

getInstrumentTypes(): (Solo | Ensemble)[]
Gets

Returns (Solo | Ensemble)[]
- Defined in generated/elements.ts:31785

getVirtualInstrument

getVirtualInstrument(): null | VirtualInstrument
Gets

Returns null | VirtualInstrument
- Defined in generated/elements.ts:31794

setId

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

setInstrumentSound

setInstrumentSound(instrumentSound): InstrumentChange
Sets
Parameters
- instrumentSound: null | InstrumentSound
Returns InstrumentChange
- Defined in generated/elements.ts:31780

setInstrumentTypes

setInstrumentTypes(instrumentTypes): InstrumentChange
Sets
Parameters
- instrumentTypes: (Solo | Ensemble)[]
Returns InstrumentChange
- Defined in generated/elements.ts:31789

setVirtualInstrument

setVirtualInstrument(virtualInstrument): InstrumentChange
Sets
Parameters
- virtualInstrument: null | VirtualInstrument
Returns InstrumentChange
- Defined in generated/elements.ts:31798

Class InstrumentChange

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<InstrumentChangeAttributes>; contents?: InstrumentChangeContents; }

Optional attributes?: Partial<InstrumentChangeAttributes>

Optional contents?: InstrumentChangeContents

Returns InstrumentChange

Properties

attributes

contents

Readonly schema

Static Readonly schema

Methods

getId

Returns string

getInstrumentSound

Returns null | InstrumentSound

getInstrumentTypes

Returns (Solo | Ensemble)[]

getVirtualInstrument

Returns null | VirtualInstrument

setId

Parameters

id: string

Returns InstrumentChange

setInstrumentSound

Parameters

instrumentSound: null | InstrumentSound

Returns InstrumentChange

setInstrumentTypes

Parameters

instrumentTypes: (Solo | Ensemble)[]

Returns InstrumentChange

setVirtualInstrument

Parameters

virtualInstrument: null | VirtualInstrument

Returns InstrumentChange

Settings

Theme

On This Page

`Optional` opts: {
attributes?: Partial<InstrumentChangeAttributes>;
contents?: InstrumentChangeContents;
}

`Optional` attributes?: Partial<InstrumentChangeAttributes>

`Optional` contents?: InstrumentChangeContents

`Readonly` schema

`Static` `Readonly` schema