Type alias SoundAttributes

SoundAttributes: {
    coda: string | null;
    dacapo: "yes" | "no" | null;
    dalsegno: string | null;
    damper-pedal: "no" | "yes" | 0 | 1 | null;
    divisions: number | null;
    dynamics: number | null;
    elevation: number | null;
    fine: string | null;
    forward-repeat: "yes" | "no" | null;
    id: string | null;
    pan: number | null;
    pizzicato: "yes" | "no" | null;
    segno: string | null;
    soft-pedal: "no" | "yes" | 0 | 1 | null;
    sostenuto-pedal: "no" | "yes" | 0 | 1 | null;
    tempo: number | null;
    time-only: string | null;
    tocoda: string | null;
}

Type declaration

  • coda: string | null

    Indicates the end point for a forward jump to a coda sign. If there are multiple jumps, the value of these parameters can be used to name and distinguish them.

  • dacapo: "yes" | "no" | null

    Indicates to go back to the beginning of the movement. When used it always has the value "yes".

    By default, a dacapo attribute indicates that the jump should occur the first time through. The times that jumps occur can be changed by using the time-only attribute.

  • dalsegno: string | null

    Indicates the starting point for a backward jump to a segno sign. If there are multiple jumps, the value of these parameters can be used to name and distinguish them.

    By default, a dalsegno attribute indicates that the jump should occur the first time through. The times that jumps occur can be changed by using the time-only attribute.

  • damper-pedal: "no" | "yes" | 0 | 1 | null

    Effects playback of the the common right piano pedal and its MIDI controller equivalent. The yes value indicates the pedal is depressed; no indicates the pedal is released. A numeric value from 0 to 100 may also be used for half pedaling. This value is the percentage that the pedal is depressed. A value of 0 is equivalent to no, and a value of 100 is equivalent to yes.

  • divisions: number | null

    If the segno or coda attributes are used, the divisions attribute can be used to indicate the number of divisions per quarter note. Otherwise sound and MIDI generating programs may have to recompute this.

  • dynamics: number | null

    Dynamics (or MIDI velocity) are expressed as a percentage of the default forte value (90 for MIDI 1.0).

  • elevation: number | null

    Allows placing of sound in a 3-D space relative to the listener, expressed in degrees ranging from -180 to 180. 0 is level with the listener, 90 is directly above, and -90 is directly below.

    Deprecated as of Version 2.0. The <elevation> element in the <midi-instrument> element should be used instead. If both are present, the <elevation> element takes priority.

  • fine: string | null

    Follows the final note or rest in a movement with a da capo or dal segno direction. If numeric, the value represents the actual duration of the final note or rest, which can be ambiguous in written notation and different among parts and voices. The value may also be "yes" to indicate no change to the final duration.

  • forward-repeat: "yes" | "no" | null

    Indicates that a forward repeat sign is implied but not displayed. It is used for example in two-part forms with repeats, such as a minuet and trio where no repeat is displayed at the start of the trio. This usually occurs after a barline. When used it always has the value of "yes".

  • id: string | null

    Specifies an ID that is unique to the entire document.

  • pan: number | null

    Allows placing of sound in a 3-D space relative to the listener, expressed in degrees ranging from -180 to 180. 0 is straight ahead, -90 is hard left, 90 is hard right, and -180 and 180 are directly behind the listener.

    Deprecated as of Version 2.0. The <pan> element in the <midi-instrument> element should be used instead. If both are present, the <pan> element takes priority.

  • pizzicato: "yes" | "no" | null

    Affects all following notes. Yes indicates pizzicato, no indicates arco.

  • segno: string | null

    Indicates the end point for a backward jump to a segno sign. If there are multiple jumps, the value of these parameters can be used to name and distinguish them.

  • soft-pedal: "no" | "yes" | 0 | 1 | null

    Effects playback of the the common left piano pedal and its MIDI controller equivalent. The yes value indicates the pedal is depressed; no indicates the pedal is released. A numeric value from 0 to 100 may also be used for half pedaling. This value is the percentage that the pedal is depressed. A value of 0 is equivalent to no, and a value of 100 is equivalent to yes.

  • sostenuto-pedal: "no" | "yes" | 0 | 1 | null

    Effects playback of the the common center piano pedal and its MIDI controller equivalent. The yes value indicates the pedal is depressed; no indicates the pedal is released. A numeric value from 0 to 100 may also be used for half pedaling. This value is the percentage that the pedal is depressed. A value of 0 is equivalent to no, and a value of 100 is equivalent to yes.

  • tempo: number | null

    Tempo is expressed in quarter notes per minute. If 0, the sound-generating program should prompt the user at the time of compiling a sound (MIDI) file.

  • time-only: string | null

    Indicates which times to apply the sound element if the element applies only particular times through a repeat.

  • tocoda: string | null

    Indicates the starting point for a forward jump to a coda sign. If there are multiple jumps, the value of these parameters can be used to name and distinguish them.

    By default, a tocoda attribute indicates the jump should occur the second time through. The times that jumps occur can be changed by using the time-only attribute.

Settings

Theme

Generated using TypeDoc