Démarrer l'essai gratuit — 7 jours offerts

Démarrer l'essai gratuit

← Back to docs

Voco Docs

Stream Deck et télécommande

Contrôlez Voco à partir d'un bouton Stream Deck, d'une action ProPresenter ou d'un outil de contrôle à distance fiable à l'aide de l'API Signal.

L'API Signal

L'API Signal de Voco permet aux appareils externes d'envoyer des commandes au flux actif sans ouvrir le tableau de bord d'administration. Il est disponible sur les forfaits Voco Pro et Réseau.

L'API prend en charge cinq actions : stream:start, stream:stop, captions:clear, captions:hide et captions:show.

Configuration de Stream Deck (action d'URL)

Pour les outils prenant en charge les en-têtes HTTP personnalisés, utilisez POST avec un en-tête Authorization. Cela maintient votre clé API hors des URL, de l'historique du navigateur et des journaux du serveur.

Le bouton de base du site Web de Stream Deck peut toujours utiliser un déclencheur d'URL lorsqu'aucune action basée sur l'en-tête n'est disponible, mais traitez le profil de ce bouton comme un mot de passe et faites pivoter la clé si elle est partagée.

  1. 1Trouvez votre clé APIOuvrez Paramètres → API dans le tableau de bord Voco et copiez la clé API de votre église.
  2. 2Utilisez une action compatible avec l'en-tête lorsque cela est possibleDéfinissez la méthode sur POST, l'URL sur https://voco.church/api/v1/signal et ajoutez l'autorisation : Bearer YOUR_KEY.
  3. 3Envoyer l'actionEnvoyez du JSON tel que { "action": "stream:start" } pour chaque bouton.
  4. 4Solution de secours uniquement : déclencheur d'URLSi votre outil ne peut pas envoyer d'en-têtes, utilisez le format URL ci-dessous et gardez le profil Stream Deck privé.
  5. 5Répéter pour chaque actionCréez un bouton par action : démarrer, arrêter, activer/désactiver les sous-titres, effacer.
POST https://voco.church/api/v1/signal
Authorization: Bearer YOUR_KEY
{ "action": "stream:start" }
https://voco.church/api/v1/signal?api_key=YOUR_KEY&action=stream:start
https://voco.church/api/v1/signal?api_key=YOUR_KEY&action=stream:stop
https://voco.church/api/v1/signal?api_key=YOUR_KEY&action=captions:hide
https://voco.church/api/v1/signal?api_key=YOUR_KEY&action=captions:show
https://voco.church/api/v1/signal?api_key=YOUR_KEY&action=captions:clear

Compagnon Bitfocus

Bitfocus Companion prend en charge les actions de requête HTTP, qui fonctionnent avec le point de terminaison POST de l'API Signal. Utilisez un bouton de requête HTTP générique et définissez la méthode sur POST, l'URL sur https://voco.church/api/v1/signal, et envoyez soit un en-tête d'autorisation, soit un corps JSON avec votre clé API et votre action.

Companion est utile lorsque vous avez besoin d'un contrôleur de grille à boutons complets plutôt que d'un Stream Deck grand public, ou lors de l'intégration avec des workflows de contrôle ATEM, vMix ou ProPresenter.

ProPresenter Actions d'URL

Les diapositives ProPresenter peuvent déclencher des actions d'URL lorsqu'elles sont affichées. Ajoutez une action d'URL à n'importe quelle diapositive à l'aide du point de terminaison GET de l'API Signal - par exemple, une diapositive de pré-service qui démarre automatiquement le flux Voco lorsqu'il est affiché à l'écran.

Gardez votre clé API privée

Ne collez pas votre clé API dans des documents partagés, des discussions de groupe de bénévoles ou des enregistrements de diffusion en direct. Les outils de déclenchement d'URL peuvent stocker la clé dans leur configuration, alors gardez ces fichiers privés et faites pivoter la clé depuis Paramètres → API si elle est exposée.

Related guides