Wrapper
Notre wrapper, tel que décrit précédemment, est distribué sous la forme d'une page HTML présente à l'adresse suivante :
https://obs.multistream.tools/v1/wrapper
Le wrapper reçoit et transmet les événements émis par notre dock, l'API JavaScript d'OBS et les overlays. Sans lui, aucun overlay n'aurait accès à tout ceci ; il est donc nécessaire d'utiliser notre wrapper pour ajouter des overlays à votre installation d'OBS, soit en tant que source de type navigateur Web soit en tant que dock Internet personnalisé.
Paramètres
| nom | valeur | optionnel |
|---|---|---|
url | URL distante HTTPS | non |
obsAPI | true | oui |
obsEvents | Noms d'événements | oui |
Pour ce faire, le parmètre url est obligatoire, il sert tout bonnement à indiquer l'URL de la page HTML correspondant à l'overlay à afficher. Cette page doit être servie en HTTPS. Par exemple :
https://obs.multistream.tools/v1/wrapper?url=https://obs.multistream.tools/v1/overlays/chat/overlay
Dans le cas où l'overlay à charger possède ses propres paramètres il est important d'encoder (%26), dans la valeur du paramètre url, les caractères & séparant les différents paramètres. On écrira donc :
https://obs.multistream.tools/v1/wrapper?url=https://obs.multistream.tools/v1/overlays/chat/overlay?ignore=StreamElements%26limit=10
Au lieu de :
https://obs.multistream.tools/v1/wrapper?url=https://obs.multistream.tools/v1/overlays/chat/overlay?ignore=StreamElements&limit=10
API JavaScript d'OBS
Afin de pouvoir accéder à l'API JavaScript d'OBS, un overlay doit être chargé via un wrapper configuré pour obtenir cet accès. Il existe deux paramètres optionnels dédiés nommés obsAPI et obsEvents. Le premier permet à l'overlay de contrôler OBS tandis que le second mettra en place des écouteurs d'événements transmettant directement des informations à l'overlay. Ces deux paramètres sont indépendants.
Pour que l'accès à l'API JavaScript d'OBS soit accordé, il est nécessaire de configurer correctement l'attribut Permissions de la page de la source de type navigateur Web associée au wrapper.
On écrira donc ceci pour activer l'accès à l'API JavaScript d'OBS :
https://obs.multistream.tools/v1/wrapper?obsAPI&url=https://your-domain.com/overlay.html
Par exemple cela pour écouter les événements obsStreamingStarted et obsStreamingStopped :
https://obs.multistream.tools/v1/wrapper?obsEvents=StreamingStarted,StreamingStopped&url=https://your-domain.com/overlay.html
Les noms d'événements à écouter doivent être séparés par des virgules, sans espace. Le préfixe obs doit être retiré et les majuscules doivent être conservées.
Et enfin ceci pour les deux à la fois :
https://obs.multistream.tools/v1/wrapper?obsAPI&obsEvents=StreamingStarted,StreamingStopped&url=https://your-domain.com/overlay.html
Pour un exemple pratique d'utilisation, rendez-vous sur notre page dédiée au développement d'overlays.
Configurateur
Afin de vous aider à construire les URLs de vos overlays, nous mettons à votre disposition un configurateur disponible sur la page dédiée aux overlays.