Documentatie OBS, Poweroverlay en de API
Home Soundboard Beheer

Koppelen

Hier staat hoe de stream, Poweroverlay en een eigen programma een geluid laten afspelen. De geluiden zelf staan op deze hub. Afspelen doet de bron Soundboard in OBS, op de stream-pc.

OBS

Op de homepage staat OBS-plugin installeren. Dat bestand heeft het adres van deze hub en je PIN al in zich.

  1. Sluit OBS helemaal.
  2. Start het gedownloade bestand.
  3. Open OBS en voeg in je scène een bron toe: Soundboard.

Een mp3 is geluid. Een mp4 is hetzelfde, en laat ook het beeld zien. Tekst uit een verzoek staat onder dat beeld. Geef de bron in de scène een grootte. Beeld en tekst schalen daarbinnen, met de verhouding intact.

In de mixer staat Soundboard, met een meter en een schuif. Jij hoort het, en de kijker hoort het. Staat desktop-audio op hetzelfde apparaat als waar jij het op hoort, dan gaat het één keer de uitzending in.

Bijwerken gaat hetzelfde: OBS sluiten, het bestand opnieuw downloaden en starten. Stond er nog een script soundboard.lua bij Extra → Scripts, haal dat daar weg. Laat soundboard-stream uit. De plugin doet dat werk.

Poweroverlay

Poweroverlay krijgt de sub of de donatie binnen. In een flow stuur je een HTTP-verzoek naar deze hub. De trigger van de flow is het moment, bijvoorbeeld channel.subscribe. In de body zet je event op de naam die je in Beheer gebruikt, meestal subscribe.

Een sub die altijd het geluid Bruh speelt, met een zin op de bron:

{
  "event": "subscribe",
  "sound": "Bruh",
  "user": "{event.user.user_name}",
  "text": "{event.user.user_name} is geabonneerd"
}

sound is de naam van het geluid, zoals in Beheer, of het id dat daar bij het geluid staat. Hoofdletters maken niet uit. itemId is datzelfde id. Poweroverlay vult de tekst tussen accolades zelf in, met de variabelen van die flow. Zet Poweroverlay die JSON vanzelf tussen aanhalingstekens, met \n erin, dan leest de hub die vorm ook.

Wil je het geluid in Beheer kiezen, laat sound en itemId dan weg. Open het geluid, vul onder Kijker het event subscribe in, en druk op Koppelen. De body is dan alleen het event, de kijker en de tekst.

Een donatie werkt hetzelfde, met "event": "donation" en een amount. In Beheer kun je per geluid een minimumbedrag zetten. Het hoogste bedrag dat nog onder de donatie zit, wint. 5 en "5,50" mogen allebei.

{
  "event": "donation",
  "user": "{event.user.user_name}",
  "amount": "{amount}",
  "text": "{event.user.user_name} doneerde {amount}"
}

Lukt het, dan komt er {"ok":true,"name":"Bruh"} terug. Een foute PIN geeft 401. Staat de OBS-plugin uit, dan komt er een fout en wordt het verzoek niet bewaard. Het volgende verzoek werkt weer zodra OBS open is en de bron Soundboard erin zit.

text is de zin op de bron. Laat je die weg, dan wordt message gebruikt.

Zelf een verzoek

Een eigen programma gebruikt dezelfde hub. Zet de PIN in de header X-Pin. ?pin= achter het adres mag ook. In de voorbeelden hieronder is de PIN 1234. Vul je eigen PIN in.

Een geluid afspelen, met een zin op de bron:

POST /api/play
X-Pin: 1234

{"sound":"Bruh","text":"hallo"}

itemId mag in plaats van sound. Het antwoord bevat playback met het id van deze afspeling.

Dat ene geluid stoppen, of alles:

POST /api/stop-item
X-Pin: 1234

{"sound":"Bruh"}
POST /api/stop-all
X-Pin: 1234

GET /api/state met dezelfde header geeft de bibliotheek en wat er nu speelt.