Streaming
Remarque : le point de terminaison Démarrer le streaming ne peut être utilisé que pour démarrer le streaming depuis un appareil Kaleo Connect. Ce point de terminaison ne peut pas être utilisé pour démarrer le streaming depuis un navigateur web. Tous les autres points de terminaison de streaming contrôlent à la fois les navigateurs et les appareils Kaleo Connect.
Obtenir le statut du streaming
Lire la session en cours et les paramètres partagés de l'église. Tous les champs sont présents, même en veille.
Paramètres de chemin
churchIdL'ID de votre église. Copiez-le depuis la page API (sous Intégrations) dans votre tableau de bord.
Obtenir le statut du streaming › Réponses
Succès
streamingtrue pendant une session active, y compris démarrage, reconnexions et arrêt. Ne confirme pas que l'audio arrive.
sessionIdID de la session en cours ; null en veille.
startedAtHeure de début de la session en cours ; null en veille.
deadlineAtHeure d'arrêt automatique ; null en veille ou si aucune date limite enregistrée.
speakerLanguageCode de langue du locuteur actuel ; null en veille.
targetLanguagesCodes des langues de traduction actuelles ; vide en veille.
voiceVoix de traduction, y compris en veille.
visibletrue affiche les sous-titres ; false les masque. S'applique aussi en veille.
publisherAppareil Kaleo Connect ou navigateur qui envoie l'audio ; null en veille.
phaseÉtape de la session ; veille signifie qu'aucune session n'est active.
Paramètres par défaut de l'église pour le prochain démarrage manuel. Les sessions actives ne modifient pas ces valeurs.
Démarrer le streaming
Démarrez le streaming sur un appareil Kaleo Connect en utilisant les paramètres enregistrés. Le corps optionnel peut sélectionner un deviceId et remplacer les paramètres pour cette session. Sans deviceId, Kaleo choisit la source audio par défaut configurée sur la page Kaleo Connect (sous Intégrations) dans votre tableau de bord s'il y a plusieurs appareils audio disponibles, ou la seule source audio disponible si un seul appareil est disponible.
Paramètres de chemin
churchIdL'ID de votre église. Copiez-le depuis la page API (sous Intégrations) dans votre tableau de bord.
Démarrer le streaming › Corps de la requête optionnel
deviceIdID optionnel de l'appareil source audio depuis GET /devices. Remplace la valeur par défaut de l'église pour cette session. Si omis, utilise la source audio par défaut enregistrée ou l'unique appareil couplé capable d'audio ; plusieurs appareils sans valeur par défaut nécessitent une sélection. L'appareil sélectionné doit être prêt.
Paramètres uniquement pour cette session. Les champs omis utilisent les valeurs par défaut enregistrées.
Démarrer le streaming › Réponses
Succès
streamingtrue pendant une session active, y compris démarrage, reconnexions et arrêt. Ne confirme pas que l'audio arrive.
sessionIdID de la session en cours ; null en veille.
startedAtHeure de début de la session en cours ; null en veille.
deadlineAtHeure d'arrêt automatique ; null en veille ou si aucune date limite enregistrée.
speakerLanguageCode de langue du locuteur actuel ; null en veille.
targetLanguagesCodes des langues de traduction actuelles ; vide en veille.
voiceVoix de traduction, y compris en veille.
visibletrue affiche les sous-titres ; false les masque. S'applique aussi en veille.
publisherAppareil Kaleo Connect ou navigateur qui envoie l'audio ; null en veille.
phaseÉtape de la session ; veille signifie qu'aucune session n'est active.
Paramètres par défaut de l'église pour le prochain démarrage manuel. Les sessions actives ne modifient pas ces valeurs.
Arrêter le streaming
Arrêtez la session de streaming en cours. Aucun corps de requête n'est nécessaire.
Paramètres de chemin
churchIdL'ID de votre église. Copiez-le depuis la page API (sous Intégrations) dans votre tableau de bord.
Arrêter le streaming › Réponses
Succès
streamingtrue pendant une session active, y compris démarrage, reconnexions et arrêt. Ne confirme pas que l'audio arrive.
sessionIdID de la session en cours ; null en veille.
startedAtHeure de début de la session en cours ; null en veille.
deadlineAtHeure d'arrêt automatique ; null en veille ou si aucune date limite enregistrée.
speakerLanguageCode de langue du locuteur actuel ; null en veille.
targetLanguagesCodes des langues de traduction actuelles ; vide en veille.
voiceVoix de traduction, y compris en veille.
visibletrue affiche les sous-titres ; false les masque. S'applique aussi en veille.
publisherAppareil Kaleo Connect ou navigateur qui envoie l'audio ; null en veille.
phaseÉtape de la session ; veille signifie qu'aucune session n'est active.
Paramètres par défaut de l'église pour le prochain démarrage manuel. Les sessions actives ne modifient pas ces valeurs.
Changer la voix de traduction
Changer la voix de traduction pendant que le système est en veille ou en streaming.
Paramètres de chemin
churchIdL'ID de votre église. Copiez-le depuis la page API (sous Intégrations) dans votre tableau de bord.
Changer la voix de traduction › Corps de la requête
voiceVoix de traduction. Peut changer en veille ou en streaming.
Changer la voix de traduction › Réponses
Succès
streamingtrue pendant une session active, y compris démarrage, reconnexions et arrêt. Ne confirme pas que l'audio arrive.
sessionIdID de la session en cours ; null en veille.
startedAtHeure de début de la session en cours ; null en veille.
deadlineAtHeure d'arrêt automatique ; null en veille ou si aucune date limite enregistrée.
speakerLanguageCode de langue du locuteur actuel ; null en veille.
targetLanguagesCodes des langues de traduction actuelles ; vide en veille.
voiceVoix de traduction, y compris en veille.
visibletrue affiche les sous-titres ; false les masque. S'applique aussi en veille.
publisherAppareil Kaleo Connect ou navigateur qui envoie l'audio ; null en veille.
phaseÉtape de la session ; veille signifie qu'aucune session n'est active.
Paramètres par défaut de l'église pour le prochain démarrage manuel. Les sessions actives ne modifient pas ces valeurs.
Changer la visibilité
Afficher ou masquer les sous-titres pendant que le système est en veille ou en streaming. Masquer les sous-titres ne stoppe pas la session.
Paramètres de chemin
churchIdL'ID de votre église. Copiez-le depuis la page API (sous Intégrations) dans votre tableau de bord.
Changer la visibilité › Corps de la requête
visibletrue affiche les sous-titres ; false les masque pendant que le streaming continue.
Changer la visibilité › Réponses
Succès
streamingtrue pendant une session active, y compris démarrage, reconnexions et arrêt. Ne confirme pas que l'audio arrive.
sessionIdID de la session en cours ; null en veille.
startedAtHeure de début de la session en cours ; null en veille.
deadlineAtHeure d'arrêt automatique ; null en veille ou si aucune date limite enregistrée.
speakerLanguageCode de langue du locuteur actuel ; null en veille.
targetLanguagesCodes des langues de traduction actuelles ; vide en veille.
voiceVoix de traduction, y compris en veille.
visibletrue affiche les sous-titres ; false les masque. S'applique aussi en veille.
publisherAppareil Kaleo Connect ou navigateur qui envoie l'audio ; null en veille.
phaseÉtape de la session ; veille signifie qu'aucune session n'est active.
Paramètres par défaut de l'église pour le prochain démarrage manuel. Les sessions actives ne modifient pas ces valeurs.
Effacer les sous-titres
Effacez le flux de sous-titres actuel. Aucun corps de requête n'est nécessaire.
Paramètres de chemin
churchIdL'ID de votre église. Copiez-le depuis la page API (sous Intégrations) dans votre tableau de bord.
Effacer les sous-titres › Réponses
Succès
streamingtrue pendant une session active, y compris démarrage, reconnexions et arrêt. Ne confirme pas que l'audio arrive.
sessionIdID de la session en cours ; null en veille.
startedAtHeure de début de la session en cours ; null en veille.
deadlineAtHeure d'arrêt automatique ; null en veille ou si aucune date limite enregistrée.
speakerLanguageCode de langue du locuteur actuel ; null en veille.
targetLanguagesCodes des langues de traduction actuelles ; vide en veille.
voiceVoix de traduction, y compris en veille.
visibletrue affiche les sous-titres ; false les masque. S'applique aussi en veille.
publisherAppareil Kaleo Connect ou navigateur qui envoie l'audio ; null en veille.
phaseÉtape de la session ; veille signifie qu'aucune session n'est active.
Paramètres par défaut de l'église pour le prochain démarrage manuel. Les sessions actives ne modifient pas ces valeurs.
Changer la date limite d'arrêt automatique
Définissez l'heure d'arrêt automatique pour une session active. Renvoie le statut de streaming mis à jour.
Paramètres de chemin
churchIdL'ID de votre église. Copiez-le depuis la page API (sous Intégrations) dans votre tableau de bord.
Changer la date limite d'arrêt automatique › Corps de la requête
deadlineAtHeure future d'arrêt automatique avec Z ou un décalage horaire. Pas plus tard que six heures après startedAt.
Changer la date limite d'arrêt automatique › Réponses
Succès
streamingtrue pendant une session active, y compris démarrage, reconnexions et arrêt. Ne confirme pas que l'audio arrive.
sessionIdID de la session en cours ; null en veille.
startedAtHeure de début de la session en cours ; null en veille.
deadlineAtHeure d'arrêt automatique ; null en veille ou si aucune date limite enregistrée.
speakerLanguageCode de langue du locuteur actuel ; null en veille.
targetLanguagesCodes des langues de traduction actuelles ; vide en veille.
voiceVoix de traduction, y compris en veille.
visibletrue affiche les sous-titres ; false les masque. S'applique aussi en veille.
publisherAppareil Kaleo Connect ou navigateur qui envoie l'audio ; null en veille.
phaseÉtape de la session ; veille signifie qu'aucune session n'est active.
Paramètres par défaut de l'église pour le prochain démarrage manuel. Les sessions actives ne modifient pas ces valeurs.
Ajuster l'heure d'arrêt automatique
Ajouter ou soustraire du temps d'arrêt automatique. En veille, modifiez la durée pour le prochain démarrage manuel. En streaming, modifiez la date limite actuelle. Chaque requête applique un ajustement séparé.
Paramètres de chemin
churchIdL'ID de votre église. Copiez-le depuis la page API (sous Intégrations) dans votre tableau de bord.
Ajuster l'heure d'arrêt automatique › Corps de la requête
deltaSecondsSecondes à ajouter à la durée en veille ou à la date limite actuelle ; les valeurs négatives soustraient. Ne peut pas être 0. Durée en veille : 60–21600 secondes. Date limite en direct : future, dans les six heures suivant startedAt.
Ajuster l'heure d'arrêt automatique › Réponses
Succès
streamingtrue pendant une session active, y compris démarrage, reconnexions et arrêt. Ne confirme pas que l'audio arrive.
sessionIdID de la session en cours ; null en veille.
startedAtHeure de début de la session en cours ; null en veille.
deadlineAtHeure d'arrêt automatique ; null en veille ou si aucune date limite enregistrée.
speakerLanguageCode de langue du locuteur actuel ; null en veille.
targetLanguagesCodes des langues de traduction actuelles ; vide en veille.
voiceVoix de traduction, y compris en veille.
visibletrue affiche les sous-titres ; false les masque. S'applique aussi en veille.
publisherAppareil Kaleo Connect ou navigateur qui envoie l'audio ; null en veille.
phaseÉtape de la session ; veille signifie qu'aucune session n'est active.
Paramètres par défaut de l'église pour le prochain démarrage manuel. Les sessions actives ne modifient pas ces valeurs.

