Befehle

Play Sound

Mit diesem Befehl können auf dem Gerät, auf welchem die HC-NodeRED Instanz läuft, Audiodateien abgespielt werden. Ist dieser Befehl ausgewählt, werden weitere Parameter sichtbar:

Pfad (Audio Datei): Hierdurch wird definiert, welche Audiodatei beim Aktivieren der Node abgespielt werden soll. Die Bezeichnung des Dateipfades muss beispielsweise so aussehen: d:\tuergong_1.wav
Spielzeit (in sek.): Durch diesen Parameter wird bestimmt, wie lange die Audiodatei nach dem Start gespielt werden soll, bis die Audiowiedergabe automatisch stoppt. Wenn die Datei in voller Länge abgespielt werden soll, muss hier "0" eingetragen werden.
Lautstärke: Falls für die Wiedergabe eine Bestimmte Lautstärke vorgesehen ist, kann diese hier eingestellt werden. Wenn die Lautstärke der aktuell eingestellten Systemlautstärke entsprechen soll, muss hier "0" eingetragen werden.
Andere Sounds ☑ Mute: Ist dieser Haken gesetzt, werden sofort alle anderen Wiedergaben stummgeschaltet, sobald dieser Knoten aktiviert wird. Sobald die Wiedergabe beendet ist, wird die Stummschaltung wieder aufgehoben.


Mute/Aus

Ist dieser Befehl ausgewählt, wird je nach eingabe des boolschen Wahrheitswerts true/false die gesamte Audiowiedergabe des Geräts Stummgeschaltet / die Stummschaltung aufgehoben. (true = Stummschaltung | false = Ton an)


Stop

Wird von einem anderen Knoten im Moment eine Audiodatei abgespielt, kann diese Wiedergabe durch das Aktivieren dieses Knotens durch den Input payload "true" gestoppt werden. Dies gilt nur für Wiedergaben, welche durch die HC-Audio Node gestartet wurden. Andere Wiedergaben des Systems können durch diesen Knoten nicht gestoppt werden.


Volume

Durch den Input payload eines Integer Wertes zwischen 1 und 100 kann die Systemlautstärke auf den gewünschten Wert gesetzt werden.


Status Anfordern

Mit diesem Befehl kann die Liste an Audiogeräten ausgegeben werden.
Als Input payload wird hier der boolsche Wert true erwartet. Sobald der Knoten durch diesen Befehl aktiviert wird, gibt er ein Nachrichtenobjekt mit relevanten Informationen über die Ausgabegeräte aus:

Wird aktuell eine Audiodatei abgespielt?
Welche Audiogeräte sind aktuell angeschlossen?
Welchen Wiedergabestatus (Parameter Mute / Volume) hat dieses Ausgabegerät?

☑ Kein Telegram bei Event

Ist dieser Haken gesetzt, wird der Output des Statusobjektes ausgesetzt.



Input payload

Ist als Befehl "Input payload" angegeben, kann der Knoten eine Liste an Befehlen mit zugehörigen Parametern verarbeiten.


BefehlFunktion

play:[Dateipfad Audiodatei]|[Volume 1-100]|[Wiedergabedauer in Sek.]|[Wiedergabegerät]

z.B.: play:e:\drumsolostereo.mp3|50|0|0

Audiowiedergabe einer gewünschten Audiodatei mit bestimmter Lautstärke / Wiedergabedauer / Wiedergabegerät. Soll ein Wert den aktuellen Systemeinstellungen entsprechen / die Wiedergabedauer die ganze Audiodatei abspielen, muss der jeweilige Wert im Befehl auf "0" gesetzt werden.

Spielt "drumsolo.mp3" bei Lautstärke 50 für die gesamte Spielzeit der Datei auf dem Standardgerät ab.

stopWird dieser Befehl geladen, stoppt jede Wiedergabe des HC-Audio Knotens.
mute / unmuteMit diesen Befehlen wird die Systemlautstärke stummgeschalten / die Stummschaltung aufgehoben.
muteAnotherApps / unmuteAnotherAppsDieser Befehl verhält sich wie mute/unmute, allerdings bezieht er sich nur auf nicht-HomeCockpit Anwendungen. Das heißt: HomeCockpit Anwendungen haben exklusivrechte auf die Audiowiedergabe, solange "muteAnotherApps" aktiv ist. "unmuteAnotherApps" schaltet die Anwendungen wieder für die Audiowiedergabe frei.
muteAllApps / unmuteAllAppsSiehe mute / unmute. Einziger Unterschied: Ausgabegerät wird nicht gemuted → neu gestartete Anwendungen können eine Audiowiedergabe starten.

setVolumeAnotherApps:[Wert zwischen 1-100]

z.B.: setVolumeAnotherApps:50

Setzt die Lautstärke aller nicht-HomeCockpit Anwendungen auf den angegebenen Wert im Verhältnis zur Lautstärke des ausgewählten Ausgabegeräts.

→ Beispiel: Ist der Lautstärkeregler des Ausgabegeräts auf 80, werden alle anderen Anwendungen auf 40 gesetzt.

safeVolumeStateWird dieser Befehl ausgeführt, speichert das System den Stand aller Audioeinstellungen und macht ihn für spätere Zeitpunkte durch den befehl "resoreVolumeState" zugänglich.
restoreVolumeStateDieser Befehl hat nur eine Funktion, wenn zu einem früheren Zeitpunkt der befehlt "safeVolumeState" ausgeführt wurde. Dann können alle Einstellungen, die zum Zeitpunkt des "safeVolumeState" vorhanden waren, wiederhergestellt werden.
getStateWenn dieser Befehl den Knoten aktiviert, wird ein Nachrichtenobjekt mit relevanten Informationen der Audioausgabe gesendet. → Nachrichtenobjekt siehe "Output"





Output

Nachrichtenobjekt bei Befehl "getState" / Status anfordern

DeviceList: array[1]

Device 1

Name: "Speakers (Realtek HD Audio)
Id: 0
IsDefault: true
Mute: false
Volume: 67
► AppStateList: array[4]

PlayingInstances: 0
SingleInstanceInfo

IsPlaying: false
Path: ""

dataInfo: "AudioState"
packetType: "res"
_msgid: "6f8f16c.e1045e8"







Ausklappbare Liste, welche alle angeschlossenen Audiogeräte abbildet.

Einzelnes Audiogerät. Ausklappbar, um Details der Konfiguration / des Status des Ausgabegeräts anzeigen zu lassen.

Name des Audioausgabegeräts.
Id des Audioasugabegeräts, wichtig für Befehl "Play Sound" / Input Befehl "play:[Dateipfad Audiodatei]|[Volume 1-100]|[Wiedergabedauer in Sek.]|[Wiedergabegerät]"
Wahrheitswert, ob dieses Gerät für die Standardausgabe von Audiodateien ausgewählt ist.
Wahrheitswert, ob dieses Gerät aktuell Stummgeschalten ist, oder nicht. → true = Stummgeschalten / false = Ton an
Aktuell eingestellte Wiedergabelautstärke des Geräts.
Ausklappbare Liste mit allen aktiven Anwendungen und ihren Audioeigenschaften.

Zahlenwert, wie viele Anwendungen aktiv Audio wiedergeben.
Ausklappbares Objekt, welches Information über die aktuelle Wiedergabe, falls aktiv, aufzeigt.

Wahrheitswert, ob aktuell eine Wiedergabe erfolgt.
Wenn eine Wiedergabe erfolgt, wird hier der Dateipfad des wiedergegebenen Audiofile angezeigt.

Bezeichnung des Statusobjekt-Typs.
Bezeichnung des Paket-Typs. ("res" = response,
Einzigartige Message ID. Keine Wichtige Bedeutung, dient nur der Nachvollziehbarkeit der Nachricht.