Alto
dev

alto.ui.staff_playback

Connect a displayed music sample to the notes sounding on its staff.

StaffPlayback

StaffPlayback(
    parent: QWidget,
    *,
    highlight: Callable[[int | None], object] | None = None,
)

Bases: QObject

Follow a sample’s audio onsets and end playback when its view closes.

Constructor

Attach playback to its view.

Parameters

  • parent (QWidget): The view containing the sample.
  • highlight (callable or None): Draw the current step on the displayed staff or staves. Omit for audio-only playback.

StaffPlayback.play

def play(
    columns: Sequence[Sequence[Note]],
    *,
    gap_ms: int = DEFAULT_NOTE_GAP_MS,
    force: bool = False,
    warmup: bool = False,
) -> None

Play the displayed notes in order.

Parameters

  • columns (sequence of sequence of Note): Notes grouped by onset.
  • gap_ms (int): Time between onsets in milliseconds.
  • force (bool): Allow explicit auditions even when exercise sounds are muted.
  • warmup (bool): Prepare the audio streams before the first note.

StaffPlayback.stop

def stop() -> None

Clear this view’s sounding note and cancel its pending audio.

StaffPlayback.eventFilter

def eventFilter(
    watched: QObject,
    event: QEvent,
) -> bool

End the sample when the learner leaves its view.

Parameters

  • watched (QObject): The sample’s containing view.
  • event (QEvent): The pending Qt event.

Returns

  • bool: Whether the event was consumed.