Streaming
Observera: Endast slutpunkten Start streaming kan användas för att starta streaming från en Kaleo Connect-enhet. Denna slutpunkt kan inte användas för att starta streaming från en webbläsare. Alla andra streaming-slutpunkter styr både webbläsare och Kaleo Connect-enheter.
Hämta streamingstatus
Läs aktuell session och delade kyrkoinställningar. Alla fält är närvarande, även när inaktiv.
Sökvägsparametrar
churchIdDitt kyrko-ID. Kopiera det från sidan API (under Integrationer) i din kontrollpanel.
Hämta streamingstatus › Svar
Lyckades
streamingtrue under en aktiv session, inklusive uppstart, återanslutningar och avstängning. Bekräftar inte att ljud anländer.
sessionIdAktuellt sessions-ID; null när inaktiv.
startedAtAktuell sessions starttid; null när inaktiv.
deadlineAtAutomatisk stopptid; null när inaktiv eller om ingen deadline är inspelad.
speakerLanguageAktuell talarspråkkod; null när inaktiv.
targetLanguagesAktuella översättningsspråkkoder; tomt när inaktiv.
voiceÖversättarröst, även när inaktiv.
visibletrue visar undertexter; false döljer dem. Gäller även när inaktiv.
publisherKaleo Connect-enhet eller webbläsare som skickar ljud; null när inaktiv.
phaseSessionsfas; inaktiv betyder att ingen session är aktiv.
Kyrkans standardinställningar för nästa manuella start. Aktiva sessionsändringar ändrar inte dessa värden.
Starta streaming
Starta streaming på en Kaleo Connect-enhet med sparade inställningar. Den valfria kroppen kan välja en deviceId och åsidosätta inställningar för denna session. Utan deviceId väljer Kaleo standardljudkällan konfigurerad på sidan Kaleo Connect (under Integrationer) i din kontrollpanel om flera ljudenheter finns tillgängliga, eller den enda tillgängliga ljudkällan om endast en finns.
Sökvägsparametrar
churchIdDitt kyrko-ID. Kopiera det från sidan API (under Integrationer) i din kontrollpanel.
Starta streaming › Förfrågningskropp valfritt
deviceIdValfritt enhets-ID för ljudkälla från GET /devices. Åsidosätter kyrkans standard för denna session. Om utelämnad används sparad standardljudkälla eller den enda ljudkälla som är ihopparad; flera enheter utan standard kräver val. Den valda enheten måste fortfarande vara redo.
Inställningar endast för denna session. Uteslutna fält använder sparade standardvärden.
Starta streaming › Svar
Lyckades
streamingtrue under en aktiv session, inklusive uppstart, återanslutningar och avstängning. Bekräftar inte att ljud anländer.
sessionIdAktuellt sessions-ID; null när inaktiv.
startedAtAktuell sessions starttid; null när inaktiv.
deadlineAtAutomatisk stopptid; null när inaktiv eller om ingen deadline är inspelad.
speakerLanguageAktuell talarspråkkod; null när inaktiv.
targetLanguagesAktuella översättningsspråkkoder; tomt när inaktiv.
voiceÖversättarröst, även när inaktiv.
visibletrue visar undertexter; false döljer dem. Gäller även när inaktiv.
publisherKaleo Connect-enhet eller webbläsare som skickar ljud; null när inaktiv.
phaseSessionsfas; inaktiv betyder att ingen session är aktiv.
Kyrkans standardinställningar för nästa manuella start. Aktiva sessionsändringar ändrar inte dessa värden.
Stoppa streaming
Stoppa den aktuella streaming-sessionen. Ingen begäran behövs i kroppen.
Sökvägsparametrar
churchIdDitt kyrko-ID. Kopiera det från sidan API (under Integrationer) i din kontrollpanel.
Stoppa streaming › Svar
Lyckades
streamingtrue under en aktiv session, inklusive uppstart, återanslutningar och avstängning. Bekräftar inte att ljud anländer.
sessionIdAktuellt sessions-ID; null när inaktiv.
startedAtAktuell sessions starttid; null när inaktiv.
deadlineAtAutomatisk stopptid; null när inaktiv eller om ingen deadline är inspelad.
speakerLanguageAktuell talarspråkkod; null när inaktiv.
targetLanguagesAktuella översättningsspråkkoder; tomt när inaktiv.
voiceÖversättarröst, även när inaktiv.
visibletrue visar undertexter; false döljer dem. Gäller även när inaktiv.
publisherKaleo Connect-enhet eller webbläsare som skickar ljud; null när inaktiv.
phaseSessionsfas; inaktiv betyder att ingen session är aktiv.
Kyrkans standardinställningar för nästa manuella start. Aktiva sessionsändringar ändrar inte dessa värden.
Byt översättarröst
Byt översättarröst medan inaktiv eller under streaming.
Sökvägsparametrar
churchIdDitt kyrko-ID. Kopiera det från sidan API (under Integrationer) i din kontrollpanel.
Byt översättarröst › Förfrågningskropp
voiceÖversättarröst. Kan ändras medan inaktiv eller under streaming.
Byt översättarröst › Svar
Lyckades
streamingtrue under en aktiv session, inklusive uppstart, återanslutningar och avstängning. Bekräftar inte att ljud anländer.
sessionIdAktuellt sessions-ID; null när inaktiv.
startedAtAktuell sessions starttid; null när inaktiv.
deadlineAtAutomatisk stopptid; null när inaktiv eller om ingen deadline är inspelad.
speakerLanguageAktuell talarspråkkod; null när inaktiv.
targetLanguagesAktuella översättningsspråkkoder; tomt när inaktiv.
voiceÖversättarröst, även när inaktiv.
visibletrue visar undertexter; false döljer dem. Gäller även när inaktiv.
publisherKaleo Connect-enhet eller webbläsare som skickar ljud; null när inaktiv.
phaseSessionsfas; inaktiv betyder att ingen session är aktiv.
Kyrkans standardinställningar för nästa manuella start. Aktiva sessionsändringar ändrar inte dessa värden.
Ändra synlighet
Visa eller dölj undertexter medan inaktiv eller under streaming. Att dölja undertexter stoppar inte sessionen.
Sökvägsparametrar
churchIdDitt kyrko-ID. Kopiera det från sidan API (under Integrationer) i din kontrollpanel.
Ändra synlighet › Förfrågningskropp
visibletrue visar undertexter; false döljer dem medan streaming fortsätter.
Ändra synlighet › Svar
Lyckades
streamingtrue under en aktiv session, inklusive uppstart, återanslutningar och avstängning. Bekräftar inte att ljud anländer.
sessionIdAktuellt sessions-ID; null när inaktiv.
startedAtAktuell sessions starttid; null när inaktiv.
deadlineAtAutomatisk stopptid; null när inaktiv eller om ingen deadline är inspelad.
speakerLanguageAktuell talarspråkkod; null när inaktiv.
targetLanguagesAktuella översättningsspråkkoder; tomt när inaktiv.
voiceÖversättarröst, även när inaktiv.
visibletrue visar undertexter; false döljer dem. Gäller även när inaktiv.
publisherKaleo Connect-enhet eller webbläsare som skickar ljud; null när inaktiv.
phaseSessionsfas; inaktiv betyder att ingen session är aktiv.
Kyrkans standardinställningar för nästa manuella start. Aktiva sessionsändringar ändrar inte dessa värden.
Rensa undertexter
Rensa den aktuella undertextflödet. Ingen begäran behövs i kroppen.
Sökvägsparametrar
churchIdDitt kyrko-ID. Kopiera det från sidan API (under Integrationer) i din kontrollpanel.
Rensa undertexter › Svar
Lyckades
streamingtrue under en aktiv session, inklusive uppstart, återanslutningar och avstängning. Bekräftar inte att ljud anländer.
sessionIdAktuellt sessions-ID; null när inaktiv.
startedAtAktuell sessions starttid; null när inaktiv.
deadlineAtAutomatisk stopptid; null när inaktiv eller om ingen deadline är inspelad.
speakerLanguageAktuell talarspråkkod; null när inaktiv.
targetLanguagesAktuella översättningsspråkkoder; tomt när inaktiv.
voiceÖversättarröst, även när inaktiv.
visibletrue visar undertexter; false döljer dem. Gäller även när inaktiv.
publisherKaleo Connect-enhet eller webbläsare som skickar ljud; null när inaktiv.
phaseSessionsfas; inaktiv betyder att ingen session är aktiv.
Kyrkans standardinställningar för nästa manuella start. Aktiva sessionsändringar ändrar inte dessa värden.
Ändra automatisk stopp-tid
Ställ in automatisk stopptid för en aktiv session. Returnerar uppdaterad streamingstatus.
Sökvägsparametrar
churchIdDitt kyrko-ID. Kopiera det från sidan API (under Integrationer) i din kontrollpanel.
Ändra automatisk stopp-tid › Förfrågningskropp
deadlineAtFramtida automatisk stopptid med Z eller tidszonsförskjutning. Senast sex timmar efter startedAt.
Ändra automatisk stopp-tid › Svar
Lyckades
streamingtrue under en aktiv session, inklusive uppstart, återanslutningar och avstängning. Bekräftar inte att ljud anländer.
sessionIdAktuellt sessions-ID; null när inaktiv.
startedAtAktuell sessions starttid; null när inaktiv.
deadlineAtAutomatisk stopptid; null när inaktiv eller om ingen deadline är inspelad.
speakerLanguageAktuell talarspråkkod; null när inaktiv.
targetLanguagesAktuella översättningsspråkkoder; tomt när inaktiv.
voiceÖversättarröst, även när inaktiv.
visibletrue visar undertexter; false döljer dem. Gäller även när inaktiv.
publisherKaleo Connect-enhet eller webbläsare som skickar ljud; null när inaktiv.
phaseSessionsfas; inaktiv betyder att ingen session är aktiv.
Kyrkans standardinställningar för nästa manuella start. Aktiva sessionsändringar ändrar inte dessa värden.
Justera automatisk stopptid
Lägg till eller dra ifrån automatisk stopptid. När inaktiv ändrar du varaktigheten för nästa manuella start. Under streaming ändrar du aktuell deadline. Varje förfrågan tillämpar en separat justering.
Sökvägsparametrar
churchIdDitt kyrko-ID. Kopiera det från sidan API (under Integrationer) i din kontrollpanel.
Justera automatisk stopptid › Förfrågningskropp
deltaSecondsSekunder att lägga till på inaktiv varaktighet eller aktuell deadline; negativa värden drar ifrån. Kan inte vara 0. Inaktiv varaktighet: 60–21600 sekunder. Live-deadline: framtida, inom sex timmar från startedAt.
Justera automatisk stopptid › Svar
Lyckades
streamingtrue under en aktiv session, inklusive uppstart, återanslutningar och avstängning. Bekräftar inte att ljud anländer.
sessionIdAktuellt sessions-ID; null när inaktiv.
startedAtAktuell sessions starttid; null när inaktiv.
deadlineAtAutomatisk stopptid; null när inaktiv eller om ingen deadline är inspelad.
speakerLanguageAktuell talarspråkkod; null när inaktiv.
targetLanguagesAktuella översättningsspråkkoder; tomt när inaktiv.
voiceÖversättarröst, även när inaktiv.
visibletrue visar undertexter; false döljer dem. Gäller även när inaktiv.
publisherKaleo Connect-enhet eller webbläsare som skickar ljud; null när inaktiv.
phaseSessionsfas; inaktiv betyder att ingen session är aktiv.
Kyrkans standardinställningar för nästa manuella start. Aktiva sessionsändringar ändrar inte dessa värden.

