winsound — Schnittstelle zur Klangausgabe unter Windows

Quellcode: PC/winsound.c


Das Modul winsound gibt dir Zugriff auf die grundlegende Klangausgabe, die Windows-Plattformen mitbringen. Es enthält Funktionen und mehrere Konstanten.

Verfügbarkeit: Windows.

Funktionen

winsound.Beep(frequency, duration)

Lässt den PC-Lautsprecher piepen. Der Parameter frequency gibt die Frequenz des Tons in Hertz an und muss im Bereich von 37 bis 32.767 liegen. Der Parameter duration gibt an, wie viele Millisekunden der Ton dauern soll. Kann das System den Lautsprecher nicht ansteuern, wird RuntimeError ausgelöst.

winsound.PlaySound(sound, flags)

Ruft die zugrundeliegende Funktion PlaySound() der Plattform-API auf. Der Parameter sound kann ein Dateiname, ein Systemklang-Alias, Audiodaten als bytes-like object oder None sein. Wie er ausgewertet wird, hängt vom Wert von flags ab, der eine bitweise mit ODER verknüpfte Kombination der unten beschriebenen Konstanten sein kann. Ist der Parameter sound None, wird ein gerade laufender Waveform-Klang gestoppt. Meldet das System einen Fehler, wird RuntimeError ausgelöst.

winsound.MessageBeep(type=MB_OK)

Ruft die zugrundeliegende Funktion MessageBeep() der Plattform-API auf. Damit wird ein Klang abgespielt, wie er in der Registry festgelegt ist. Das Argument type gibt an, welcher Klang abgespielt wird. Möglich sind -1, MB_ICONASTERISK, MB_ICONEXCLAMATION, MB_ICONHAND, MB_ICONQUESTION und MB_OK, alle unten beschrieben. Der Wert -1 erzeugt einen einfachen Piepton. Das ist der letzte Ausweg, wenn sich kein anderer Klang abspielen lässt. Meldet das System einen Fehler, wird RuntimeError ausgelöst.

Konstanten

winsound.SND_FILENAME

Der Parameter sound ist der Name einer WAV-Datei. Nicht gemeinsam mit SND_ALIAS verwenden.

winsound.SND_ALIAS

Der Parameter sound ist ein Klangzuordnungsname aus der Registry. Enthält die Registry keinen solchen Namen, wird der Standardklang des Systems abgespielt, sofern nicht zusätzlich SND_NODEFAULT angegeben ist. Ist kein Standardklang eingetragen, wird RuntimeError ausgelöst. Nicht gemeinsam mit SND_FILENAME verwenden.

Alle Win32-Systeme unterstützen mindestens die folgenden Namen, die meisten Systeme noch viele weitere:

PlaySound() name

Zugehöriger Klangname in der Systemsteuerung

'SystemAsterisk'

Sternchen

'SystemExclamation'

Hinweis

'SystemExit'

Windows beenden

'SystemHand'

Kritischer Fehler

'SystemQuestion'

Frage

Zum Beispiel:

import winsound
# Play Windows exit sound.
winsound.PlaySound("SystemExit", winsound.SND_ALIAS)

# Probably play Windows default sound, if any is registered (because
# "*" probably isn't the registered name of any sound).
winsound.PlaySound("*", winsound.SND_ALIAS)
winsound.SND_LOOP

Spielt den Klang wiederholt ab. Das Flag SND_ASYNC muss zusätzlich gesetzt sein, damit der Aufruf nicht blockiert. Nicht gemeinsam mit SND_MEMORY verwendbar.

winsound.SND_MEMORY

Der Parameter sound von PlaySound() ist ein Speicherabbild einer WAV-Datei als bytes-like object.

Bemerkung

Dieses Modul kann ein Speicherabbild nicht asynchron abspielen. Die Kombination dieses Flags mit SND_ASYNC löst daher RuntimeError aus.

winsound.SND_PURGE

Beendet alle laufenden Wiedergaben des angegebenen Klangs.

Bemerkung

Dieses Flag wird auf aktuellen Windows-Plattformen nicht unterstützt.

winsound.SND_ASYNC

Kehrt sofort zurück, sodass der Klang asynchron abgespielt wird.

winsound.SND_NODEFAULT

Spielt nicht den Standardklang des Systems ab, wenn der angegebene Klang nicht gefunden wird.

winsound.SND_NOSTOP

Unterbricht gerade laufende Klänge nicht.

winsound.SND_NOWAIT

Kehrt sofort zurück, wenn der Klangtreiber belegt ist.

Bemerkung

Dieses Flag wird auf aktuellen Windows-Plattformen nicht unterstützt.

winsound.SND_APPLICATION

Der Parameter sound ist ein anwendungseigener Alias in der Registry. Dieses Flag lässt sich mit dem Flag SND_ALIAS verbinden, um einen von der Anwendung festgelegten Klang-Alias anzugeben.

winsound.SND_SENTRY

Löst beim Abspielen des Klangs ein SoundSentry-Ereignis aus.

Added in version 3.14.

winsound.SND_SYNC

Der Klang wird synchron abgespielt. Das ist das Standardverhalten.

Added in version 3.14.

winsound.SND_SYSTEM

Ordnet den Klang der Audiositzung für Systembenachrichtigungen zu.

Added in version 3.14.

winsound.MB_ICONASTERISK

Spielt den Klang SystemDefault ab.

winsound.MB_ICONEXCLAMATION

Spielt den Klang SystemExclamation ab.

winsound.MB_ICONHAND

Spielt den Klang SystemHand ab.

winsound.MB_ICONQUESTION

Spielt den Klang SystemQuestion ab.

winsound.MB_OK

Spielt den Klang SystemDefault ab.

winsound.MB_ICONERROR

Spielt den Klang SystemHand ab.

Added in version 3.14.

winsound.MB_ICONINFORMATION

Spielt den Klang SystemDefault ab.

Added in version 3.14.

winsound.MB_ICONSTOP

Spielt den Klang SystemHand ab.

Added in version 3.14.

winsound.MB_ICONWARNING

Spielt den Klang SystemExclamation ab.

Added in version 3.14.