Class VirtualInstrument

The <virtual-instrument> element

Parent elements: <instrument-change>, <score-instrument>

The <virtual-instrument> element defines a specific virtual instrument used for an <instrument sound>.

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

Hierarchy

VirtualInstrument

Implements

XMLElement<"virtual-instrument", VirtualInstrumentAttributes, VirtualInstrumentContents>

Index

Constructors

constructor

new VirtualInstrument(opts?): VirtualInstrument
Parameters
- Optional opts: {
  attributes?: Partial<VirtualInstrumentAttributes>;
  contents?: VirtualInstrumentContents;
  }
  - Optional attributes?: Partial<VirtualInstrumentAttributes>
  - Optional contents?: VirtualInstrumentContents
Returns VirtualInstrument
- Defined in generated/elements.ts:8904

Properties

attributes

attributes: VirtualInstrumentAttributes

contents: VirtualInstrumentContents

`Readonly` schema

schema: {
    attributes: {};
    contents: readonly [{
        type: "optional";
        value: typeof VirtualLibrary;
    }, {
        type: "optional";
        value: typeof VirtualName;
    }];
    name: "virtual-instrument";
} = VirtualInstrument.schema

Type declaration

Readonly attributes: {}
Readonly contents: readonly [{
    type: "optional";
    value: typeof VirtualLibrary;
}, {
    type: "optional";
    value: typeof VirtualName;
}]
Readonly name: "virtual-instrument"

`Static` `Readonly` schema

Type declaration

Readonly attributes: {}
Readonly contents: readonly [{
    type: "optional";
    value: typeof VirtualLibrary;
}, {
    type: "optional";
    value: typeof VirtualName;
}]
Readonly name: "virtual-instrument"

Methods

getVirtualLibrary

getVirtualLibrary(): null | VirtualLibrary
Gets

Returns null | VirtualLibrary
- Defined in generated/elements.ts:8910

getVirtualName

getVirtualName(): null | VirtualName
Gets

Returns null | VirtualName
- Defined in generated/elements.ts:8919

setVirtualLibrary

setVirtualLibrary(virtualLibrary): VirtualInstrument
Sets
Parameters
- virtualLibrary: null | VirtualLibrary
Returns VirtualInstrument
- Defined in generated/elements.ts:8914

setVirtualName

setVirtualName(virtualName): VirtualInstrument
Sets
Parameters
- virtualName: null | VirtualName
Returns VirtualInstrument
- Defined in generated/elements.ts:8923

Class VirtualInstrument

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<VirtualInstrumentAttributes>; contents?: VirtualInstrumentContents; }

Optional attributes?: Partial<VirtualInstrumentAttributes>

Optional contents?: VirtualInstrumentContents

Returns VirtualInstrument

Properties

attributes

contents

Readonly schema

Type declaration

Readonly attributes: {}

Readonly contents: readonly [{ type: "optional"; value: typeof VirtualLibrary; }, { type: "optional"; value: typeof VirtualName; }]

Readonly name: "virtual-instrument"

Static Readonly schema

Type declaration

Readonly attributes: {}

Readonly contents: readonly [{ type: "optional"; value: typeof VirtualLibrary; }, { type: "optional"; value: typeof VirtualName; }]

Readonly name: "virtual-instrument"

Methods

getVirtualLibrary

Returns null | VirtualLibrary

getVirtualName

Returns null | VirtualName

setVirtualLibrary

Parameters

virtualLibrary: null | VirtualLibrary

Returns VirtualInstrument

setVirtualName

Parameters

virtualName: null | VirtualName

Returns VirtualInstrument

Settings

Theme

On This Page

`Optional` opts: {
attributes?: Partial<VirtualInstrumentAttributes>;
contents?: VirtualInstrumentContents;
}

`Optional` attributes?: Partial<VirtualInstrumentAttributes>

`Optional` contents?: VirtualInstrumentContents

`Readonly` schema

`Readonly` attributes: {}

`Readonly` contents: readonly [{
type: "optional";
value: typeof VirtualLibrary;
}, {
type: "optional";
value: typeof VirtualName;
}]

`Readonly` name: "virtual-instrument"

`Static` `Readonly` schema

`Readonly` attributes: {}

`Readonly` contents: readonly [{
type: "optional";
value: typeof VirtualLibrary;
}, {
type: "optional";
value: typeof VirtualName;
}]

`Readonly` name: "virtual-instrument"