Class Volume

The <volume> element

Parent element: <midi-instrument>

The <volume> element value is a percentage of the maximum ranging from 0 to 100, with decimal values allowed. This corresponds to a scaling value for the MIDI 1.0 channel volume controller.

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

Hierarchy

Volume

Implements

XMLElement<"volume", VolumeAttributes, VolumeContents>

Index

Constructors

constructor

new Volume(opts?): Volume
Parameters
- Optional opts: {
  attributes?: Partial<VolumeAttributes>;
  contents?: VolumeContents;
  }
  - Optional attributes?: Partial<VolumeAttributes>
  - Optional contents?: VolumeContents
Returns Volume
- Defined in generated/elements.ts:9405

Properties

attributes

attributes: VolumeAttributes

contents: VolumeContents

`Readonly` schema

schema: {
    attributes: {};
    contents: readonly [{
        label: "volume";
        type: "label";
        value: {
            type: "required";
            value: {
                max: 100;
                min: 0;
                type: "float";
            };
        };
    }];
    name: "volume";
} = Volume.schema

Type declaration

Readonly attributes: {}
Readonly contents: readonly [{
    label: "volume";
    type: "label";
    value: {
        type: "required";
        value: {
            max: 100;
            min: 0;
            type: "float";
        };
    };
}]
Readonly name: "volume"

`Static` `Readonly` schema

schema: {
    attributes: {};
    contents: readonly [{
        label: "volume";
        type: "label";
        value: {
            type: "required";
            value: {
                max: 100;
                min: 0;
                type: "float";
            };
        };
    }];
    name: "volume";
} = ...

Type declaration

Readonly attributes: {}
Readonly contents: readonly [{
    label: "volume";
    type: "label";
    value: {
        type: "required";
        value: {
            max: 100;
            min: 0;
            type: "float";
        };
    };
}]
Readonly name: "volume"

Methods

getVolume

getVolume(): number
Gets

Returns number
- Defined in generated/elements.ts:9411

setVolume

setVolume(volume): Volume
Sets
Parameters
- volume: number
Returns Volume
- Defined in generated/elements.ts:9415

Class Volume

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

`Optional` opts: {
attributes?: Partial<VolumeAttributes>;
contents?: VolumeContents;
}

`Optional` attributes?: Partial<VolumeAttributes>

`Optional` contents?: VolumeContents

Returns Volume

Properties

attributes

contents

`Readonly` schema

Type declaration

`Readonly` attributes: {}

`Readonly` contents: readonly [{
    label: "volume";
    type: "label";
    value: {
        type: "required";
        value: {
            max: 100;
            min: 0;
            type: "float";
        };
    };
}]

`Readonly` name: "volume"

`Static` `Readonly` schema

Type declaration

`Readonly` attributes: {}

`Readonly` contents: readonly [{
    label: "volume";
    type: "label";
    value: {
        type: "required";
        value: {
            max: 100;
            min: 0;
            type: "float";
        };
    };
}]

`Readonly` name: "volume"

Methods

getVolume

Returns number

setVolume

Parameters

volume: number

Returns Volume

Settings

Theme

On This Page

Class Volume

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: { attributes?: Partial<VolumeAttributes>; contents?: VolumeContents; }

Optional attributes?: Partial<VolumeAttributes>

Optional contents?: VolumeContents

Returns Volume

Properties

attributes

contents

Readonly schema

Type declaration

Readonly attributes: {}

Readonly contents: readonly [{ label: "volume"; type: "label"; value: { type: "required"; value: { max: 100; min: 0; type: "float"; }; }; }]

Readonly name: "volume"

Static Readonly schema

Type declaration

Readonly attributes: {}

Readonly contents: readonly [{ label: "volume"; type: "label"; value: { type: "required"; value: { max: 100; min: 0; type: "float"; }; }; }]

Readonly name: "volume"

Methods

getVolume

Returns number

setVolume

Parameters

volume: number

Returns Volume

Settings

Theme

On This Page

`Optional` opts: {
attributes?: Partial<VolumeAttributes>;
contents?: VolumeContents;
}

`Optional` attributes?: Partial<VolumeAttributes>

`Optional` contents?: VolumeContents

`Readonly` schema

`Readonly` attributes: {}

`Readonly` contents: readonly [{
label: "volume";
type: "label";
value: {
type: "required";
value: {
max: 100;
min: 0;
type: "float";
};
};
}]

`Readonly` name: "volume"

`Static` `Readonly` schema

`Readonly` attributes: {}

`Readonly` contents: readonly [{
label: "volume";
type: "label";
value: {
type: "required";
value: {
max: 100;
min: 0;
type: "float";
};
};
}]

`Readonly` name: "volume"