Installation

Es gibt nichts zu installieren. Das SDK ist eine einzelne Datei auf dem pixl-Server, die du per Script-Tag lädst.

Per Script-TagLink zur Überschrift kopieren

<script src="https://pixl.lennox.zip/sdk/pixl.js"></script>

Danach steht Pixl global zur Verfügung:

const pixl = new Pixl({ key: 'pixl_DEIN_SCHLÜSSEL' });

Das SDK verbindet sich mit der pixl-Instanz, von der das Script kommt. Lädst du es von einer lokalen Instanz oder einem Tunnel, spricht es automatisch mit genau dieser. Kommt es von anderswo, etwa von jsDelivr, verbindet es sich mit pixl.lennox.zip. Du kannst die Adresse aber auch fest vorgeben:

const pixl = new Pixl({
  key: 'pixl_DEIN_SCHLÜSSEL',
  baseUrl: 'https://pixl.lennox.zip',
});

OptionenLink zur Überschrift kopieren

Mit fester VersionLink zur Überschrift kopieren

Unter pixl.lennox.zip/sdk/pixl.js kommt immer die Version, die pixl gerade ausliefert. Soll ein Widget bei einer bestimmten Version bleiben, lädst du das Script mit Versionsnummer von jsDelivr:

<script src="https://cdn.jsdelivr.net/npm/@pixl-app/sdk@0.1.1/dist/pixl.js"></script>

Ab Version 0.1.1 verbindet es sich auch von dort mit pixl.lennox.zip, ohne baseUrl.

Mit npm und BundlerLink zur Überschrift kopieren

Für eigene Widgets mit Bundler und TypeScript gibt es das SDK auch als npm-Paket:

npm i @pixl-app/sdk

import { Pixl } from '@pixl-app/sdk';

Die Typen sind dabei. Was sich in einer Version geändert hat, steht in der Datei CHANGELOG.md im Paket.

Browser-UnterstützungLink zur Überschrift kopieren

Das SDK braucht fetch mit Streaming (ReadableStream). Das können alle aktuellen Browser, die Browserquellen in OBS und die Overlays von StreamElements. Auf EventSource verzichtet das SDK bewusst: So geht der Schlüssel als Header mit und steht nie in einer Adresse.