pymusicxml.spanners.StopPedal

class pymusicxml.spanners.StopPedal(id: Any = 1, sign: bool = False, line: bool = True, placement: Union[str, pymusicxml.enums.StaffPlacement] = 'below', voice: int = 1, staff: int = None)[source]

Bases: pymusicxml.score_components.Direction, pymusicxml.score_components.StopNumberedSpanner

Stops a sustain pedal spanner.

Parameters

  • id – this should correspond to the id of the associated StartPedal

  • sign – whether or not to include a “*” sign

  • line – whether or not to use a line in the pedal marking

  • placement – Where to place the direction in relation to the staff (“above” or “below”)

  • voice – Which voice to attach to

  • staff – Which staff to attach to if the part has multiple staves

Methods

render_direction_type()

Renders the <direction-type> element that constitutes the main substance of a <direction> element.

Inherited Methods

export_to_file(file_path[, pretty_print])

Exports this musical object (wrapped as a score) to the given file path.

render()

Renders this component to a tuple of ElementTree.Element.

to_xml([pretty_print])

Renders this component to MusicXML, adding a version tag, but not wrapping it up as a full score.

view_in_software(command)

Uses the given terminal command to create a score out of this musical object, and open it in music notation software.

wrap_as_score()

Wraps this component in a Score so that it can be exported and viewed
render_direction_type() → Sequence[xml.etree.ElementTree.Element][source]

Renders the <direction-type> element that constitutes the main substance of a <direction> element.

export_to_file(file_path: str, pretty_print: bool = True) → None

Exports this musical object (wrapped as a score) to the given file path.

Parameters

  • file_path – The path of the file we want to write to.

  • pretty_print – If True, breaks the MusicXML onto multiple lines, with indentation

render() → Sequence[xml.etree.ElementTree.Element]

Renders this component to a tuple of ElementTree.Element. (The reason for making it a tuple is that musical objects like chords are represented by several notes side by side, with all but the first containing a </chord> tag.)

to_xml(pretty_print: bool = False) → str

Renders this component to MusicXML, adding a version tag, but not wrapping it up as a full score.

Parameters

pretty_print – If True, breaks the MusicXML onto multiple lines, with indentation

view_in_software(command: str) → None

Uses the given terminal command to create a score out of this musical object, and open it in music notation software.

Parameters

command – The terminal command corresponding to the software with which we want to open the score.

wrap_as_score() → pymusicxml.score_components.Score

Wraps this component in a Score so that it can be exported and viewed