Трансляция
Примечание: конечная точка Start streaming может использоваться только для запуска трансляции с устройства Kaleo Connect. Эта конечная точка не может использоваться для запуска трансляции из веб-браузера. Все остальные конечные точки трансляции управляют как браузером, так и устройствами Kaleo Connect.
Получить статус трансляции
Получить текущую сессию и общие настройки церкви. Все поля присутствуют, включая состояние бездействия.
Параметры пути
churchIdID вашей церкви. Скопируйте его со страницы API (в разделе Интеграции) в вашей панели управления.
Получить статус трансляции › Ответы
Успешно
streamingtrue во время активной сессии, включая запуск, переподключения и завершение. Не подтверждает поступление аудио.
sessionIdТекущий ID сессии; null во время бездействия.
startedAtВремя начала текущей сессии; null во время бездействия.
deadlineAtВремя автоматической остановки; null во время бездействия или если срок не установлен.
speakerLanguageКод языка диктора; null во время бездействия.
targetLanguagesКоды языков перевода; пусто во время бездействия.
voiceГолос перевода, включая состояние бездействия.
visibletrue показывает субтитры; false скрывает их. Также применяется во время бездействия.
publisherУстройство Kaleo Connect или браузер, отправляющий аудио; null во время бездействия.
phaseЭтап сессии; idle означает отсутствие активной сессии.
Настройки по умолчанию церкви для следующего ручного запуска. Активная сессия не изменяет эти значения.
Начать трансляцию
Начать трансляцию на устройстве Kaleo Connect с использованием сохранённых настроек. Опциональное тело запроса может выбрать deviceId и переопределить настройки для этой сессии. Без deviceId Kaleo выбирает аудиоисточник по умолчанию, настроенный на странице Kaleo Connect (в разделе Интеграции) в вашей панели управления, если доступно несколько аудиоустройств, или единственное доступное аудиоустройство, если оно одно.
Параметры пути
churchIdID вашей церкви. Скопируйте его со страницы API (в разделе Интеграции) в вашей панели управления.
Начать трансляцию › Тело запроса необязательно
deviceIdОпциональный ID устройства аудиоисточника из GET /devices. Переопределяет аудиоисточник по умолчанию церкви для этой сессии. Если не указан, используется сохранённый аудиоисточник по умолчанию или единственное аудиоустройство; при наличии нескольких устройств без выбора по умолчанию требуется выбор. Выбранное устройство должно быть готово.
Настройки только для этой сессии. Пропущенные поля используют сохранённые значения по умолчанию.
Начать трансляцию › Ответы
Успешно
streamingtrue во время активной сессии, включая запуск, переподключения и завершение. Не подтверждает поступление аудио.
sessionIdТекущий ID сессии; null во время бездействия.
startedAtВремя начала текущей сессии; null во время бездействия.
deadlineAtВремя автоматической остановки; null во время бездействия или если срок не установлен.
speakerLanguageКод языка диктора; null во время бездействия.
targetLanguagesКоды языков перевода; пусто во время бездействия.
voiceГолос перевода, включая состояние бездействия.
visibletrue показывает субтитры; false скрывает их. Также применяется во время бездействия.
publisherУстройство Kaleo Connect или браузер, отправляющий аудио; null во время бездействия.
phaseЭтап сессии; idle означает отсутствие активной сессии.
Настройки по умолчанию церкви для следующего ручного запуска. Активная сессия не изменяет эти значения.
Остановить трансляцию
Остановить текущую потоковую сессию. Тело запроса не требуется.
Параметры пути
churchIdID вашей церкви. Скопируйте его со страницы API (в разделе Интеграции) в вашей панели управления.
Остановить трансляцию › Ответы
Успешно
streamingtrue во время активной сессии, включая запуск, переподключения и завершение. Не подтверждает поступление аудио.
sessionIdТекущий ID сессии; null во время бездействия.
startedAtВремя начала текущей сессии; null во время бездействия.
deadlineAtВремя автоматической остановки; null во время бездействия или если срок не установлен.
speakerLanguageКод языка диктора; null во время бездействия.
targetLanguagesКоды языков перевода; пусто во время бездействия.
voiceГолос перевода, включая состояние бездействия.
visibletrue показывает субтитры; false скрывает их. Также применяется во время бездействия.
publisherУстройство Kaleo Connect или браузер, отправляющий аудио; null во время бездействия.
phaseЭтап сессии; idle означает отсутствие активной сессии.
Настройки по умолчанию церкви для следующего ручного запуска. Активная сессия не изменяет эти значения.
Изменить голос перевода
Изменить голос перевода во время бездействия или трансляции.
Параметры пути
churchIdID вашей церкви. Скопируйте его со страницы API (в разделе Интеграции) в вашей панели управления.
Изменить голос перевода › Тело запроса
voiceГолос перевода. Может изменяться во время бездействия или трансляции.
Изменить голос перевода › Ответы
Успешно
streamingtrue во время активной сессии, включая запуск, переподключения и завершение. Не подтверждает поступление аудио.
sessionIdТекущий ID сессии; null во время бездействия.
startedAtВремя начала текущей сессии; null во время бездействия.
deadlineAtВремя автоматической остановки; null во время бездействия или если срок не установлен.
speakerLanguageКод языка диктора; null во время бездействия.
targetLanguagesКоды языков перевода; пусто во время бездействия.
voiceГолос перевода, включая состояние бездействия.
visibletrue показывает субтитры; false скрывает их. Также применяется во время бездействия.
publisherУстройство Kaleo Connect или браузер, отправляющий аудио; null во время бездействия.
phaseЭтап сессии; idle означает отсутствие активной сессии.
Настройки по умолчанию церкви для следующего ручного запуска. Активная сессия не изменяет эти значения.
Изменить видимость
Показать или скрыть субтитры во время бездействия или трансляции. Скрытие субтитров не останавливает сессию.
Параметры пути
churchIdID вашей церкви. Скопируйте его со страницы API (в разделе Интеграции) в вашей панели управления.
Изменить видимость › Тело запроса
visibletrue показывает субтитры; false скрывает их при продолжающейся трансляции.
Изменить видимость › Ответы
Успешно
streamingtrue во время активной сессии, включая запуск, переподключения и завершение. Не подтверждает поступление аудио.
sessionIdТекущий ID сессии; null во время бездействия.
startedAtВремя начала текущей сессии; null во время бездействия.
deadlineAtВремя автоматической остановки; null во время бездействия или если срок не установлен.
speakerLanguageКод языка диктора; null во время бездействия.
targetLanguagesКоды языков перевода; пусто во время бездействия.
voiceГолос перевода, включая состояние бездействия.
visibletrue показывает субтитры; false скрывает их. Также применяется во время бездействия.
publisherУстройство Kaleo Connect или браузер, отправляющий аудио; null во время бездействия.
phaseЭтап сессии; idle означает отсутствие активной сессии.
Настройки по умолчанию церкви для следующего ручного запуска. Активная сессия не изменяет эти значения.
Очистить субтитры
Очистить текущую ленту субтитров. Тело запроса не требуется.
Параметры пути
churchIdID вашей церкви. Скопируйте его со страницы API (в разделе Интеграции) в вашей панели управления.
Очистить субтитры › Ответы
Успешно
streamingtrue во время активной сессии, включая запуск, переподключения и завершение. Не подтверждает поступление аудио.
sessionIdТекущий ID сессии; null во время бездействия.
startedAtВремя начала текущей сессии; null во время бездействия.
deadlineAtВремя автоматической остановки; null во время бездействия или если срок не установлен.
speakerLanguageКод языка диктора; null во время бездействия.
targetLanguagesКоды языков перевода; пусто во время бездействия.
voiceГолос перевода, включая состояние бездействия.
visibletrue показывает субтитры; false скрывает их. Также применяется во время бездействия.
publisherУстройство Kaleo Connect или браузер, отправляющий аудио; null во время бездействия.
phaseЭтап сессии; idle означает отсутствие активной сессии.
Настройки по умолчанию церкви для следующего ручного запуска. Активная сессия не изменяет эти значения.
Изменить время автоостановки
Установить время автоостановки для активной сессии. Возвращает обновлённый статус трансляции.
Параметры пути
churchIdID вашей церкви. Скопируйте его со страницы API (в разделе Интеграции) в вашей панели управления.
Изменить время автоостановки › Тело запроса
deadlineAtБудущее время автоостановки с Z или смещением часового пояса. Не позже шести часов после startedAt.
Изменить время автоостановки › Ответы
Успешно
streamingtrue во время активной сессии, включая запуск, переподключения и завершение. Не подтверждает поступление аудио.
sessionIdТекущий ID сессии; null во время бездействия.
startedAtВремя начала текущей сессии; null во время бездействия.
deadlineAtВремя автоматической остановки; null во время бездействия или если срок не установлен.
speakerLanguageКод языка диктора; null во время бездействия.
targetLanguagesКоды языков перевода; пусто во время бездействия.
voiceГолос перевода, включая состояние бездействия.
visibletrue показывает субтитры; false скрывает их. Также применяется во время бездействия.
publisherУстройство Kaleo Connect или браузер, отправляющий аудио; null во время бездействия.
phaseЭтап сессии; idle означает отсутствие активной сессии.
Настройки по умолчанию церкви для следующего ручного запуска. Активная сессия не изменяет эти значения.
Корректировать время автоостановки
Добавить или вычесть время автоостановки. Во время бездействия изменить длительность для следующего ручного запуска. Во время трансляции изменить текущий срок. Каждый запрос применяет отдельную корректировку.
Параметры пути
churchIdID вашей церкви. Скопируйте его со страницы API (в разделе Интеграции) в вашей панели управления.
Корректировать время автоостановки › Тело запроса
deltaSecondsСекунды для добавления к длительности бездействия или текущему сроку; отрицательные значения вычитают. Не может быть 0. Длительность бездействия: 60–21600 секунд. Живой срок: будущее, в пределах шести часов от startedAt.
Корректировать время автоостановки › Ответы
Успешно
streamingtrue во время активной сессии, включая запуск, переподключения и завершение. Не подтверждает поступление аудио.
sessionIdТекущий ID сессии; null во время бездействия.
startedAtВремя начала текущей сессии; null во время бездействия.
deadlineAtВремя автоматической остановки; null во время бездействия или если срок не установлен.
speakerLanguageКод языка диктора; null во время бездействия.
targetLanguagesКоды языков перевода; пусто во время бездействия.
voiceГолос перевода, включая состояние бездействия.
visibletrue показывает субтитры; false скрывает их. Также применяется во время бездействия.
publisherУстройство Kaleo Connect или браузер, отправляющий аудио; null во время бездействия.
phaseЭтап сессии; idle означает отсутствие активной сессии.
Настройки по умолчанию церкви для следующего ручного запуска. Активная сессия не изменяет эти значения.

