流媒体
注意：开始流媒体端点仅能用于从 Kaleo Connect 设备开始流媒体。 该端点不能用于从网页浏览器开始流媒体。其他所有流媒体端点均可控制浏览器和 Kaleo Connect 设备。
获取流媒体状态
读取当前会话和共享教会设置。所有字段均存在，包括空闲时。
路径参数
churchId您的教会 ID。从仪表板中“集成”下的 API 页面复制。
获取流媒体状态 › 响应
成功
streamingtrue 表示活动会话，包括启动、重连和关闭。不确认音频是否到达。
sessionId当前会话 ID；空闲时为 null。
startedAt当前会话开始时间；空闲时为 null。
deadlineAt自动停止时间；空闲时或无截止时间记录时为 null。
speakerLanguage当前发言语言代码；空闲时为 null。
targetLanguages当前翻译语言代码；空闲时为空。
voice翻译语音，包括空闲时。
visibletrue 显示字幕；false 隐藏字幕。空闲时同样适用。
publisher发送音频的 Kaleo Connect 设备或浏览器；空闲时为 null。
phase会话阶段；空闲表示无活动会话。
下次手动开始的教会默认设置。活动会话的覆盖不改变这些值。
开始流媒体
使用保存的设置在 Kaleo Connect 设备上开始流媒体。可选请求体可选择 deviceId 并覆盖本次会话的设置。若无 deviceId，当有多个支持音频的设备时，Kaleo 会选择仪表板中“集成”下 Kaleo Connect 页面配置的默认音频源；若仅有一个设备，则使用该设备。
路径参数
churchId您的教会 ID。从仪表板中“集成”下的 API 页面复制。
开始流媒体 › 请求体 可选
deviceId可选的音频源设备 ID，来自 GET /devices。覆盖教会默认设置，仅限本次会话。若省略，则使用保存的默认音频源或唯一支持音频的配对设备；若有多个设备且无默认，则需选择。所选设备必须处于准备就绪状态。
仅限本次会话的设置。省略字段使用保存的默认值。
开始流媒体 › 响应
成功
streamingtrue 表示活动会话，包括启动、重连和关闭。不确认音频是否到达。
sessionId当前会话 ID；空闲时为 null。
startedAt当前会话开始时间；空闲时为 null。
deadlineAt自动停止时间；空闲时或无截止时间记录时为 null。
speakerLanguage当前发言语言代码；空闲时为 null。
targetLanguages当前翻译语言代码；空闲时为空。
voice翻译语音，包括空闲时。
visibletrue 显示字幕；false 隐藏字幕。空闲时同样适用。
publisher发送音频的 Kaleo Connect 设备或浏览器；空闲时为 null。
phase会话阶段；空闲表示无活动会话。
下次手动开始的教会默认设置。活动会话的覆盖不改变这些值。
停止流媒体
停止当前流媒体会话。无需请求体。
路径参数
churchId您的教会 ID。从仪表板中“集成”下的 API 页面复制。
停止流媒体 › 响应
成功
streamingtrue 表示活动会话，包括启动、重连和关闭。不确认音频是否到达。
sessionId当前会话 ID；空闲时为 null。
startedAt当前会话开始时间；空闲时为 null。
deadlineAt自动停止时间；空闲时或无截止时间记录时为 null。
speakerLanguage当前发言语言代码；空闲时为 null。
targetLanguages当前翻译语言代码；空闲时为空。
voice翻译语音，包括空闲时。
visibletrue 显示字幕；false 隐藏字幕。空闲时同样适用。
publisher发送音频的 Kaleo Connect 设备或浏览器；空闲时为 null。
phase会话阶段；空闲表示无活动会话。
下次手动开始的教会默认设置。活动会话的覆盖不改变这些值。
更改翻译语音
在空闲或流媒体时更改翻译语音。
路径参数
churchId您的教会 ID。从仪表板中“集成”下的 API 页面复制。
更改翻译语音 › 响应
成功
streamingtrue 表示活动会话，包括启动、重连和关闭。不确认音频是否到达。
sessionId当前会话 ID；空闲时为 null。
startedAt当前会话开始时间；空闲时为 null。
deadlineAt自动停止时间；空闲时或无截止时间记录时为 null。
speakerLanguage当前发言语言代码；空闲时为 null。
targetLanguages当前翻译语言代码；空闲时为空。
voice翻译语音，包括空闲时。
visibletrue 显示字幕；false 隐藏字幕。空闲时同样适用。
publisher发送音频的 Kaleo Connect 设备或浏览器；空闲时为 null。
phase会话阶段；空闲表示无活动会话。
下次手动开始的教会默认设置。活动会话的覆盖不改变这些值。
更改可见性
在空闲或流媒体时显示或隐藏字幕。隐藏字幕不会停止会话。
路径参数
churchId您的教会 ID。从仪表板中“集成”下的 API 页面复制。
更改可见性 › 响应
成功
streamingtrue 表示活动会话，包括启动、重连和关闭。不确认音频是否到达。
sessionId当前会话 ID；空闲时为 null。
startedAt当前会话开始时间；空闲时为 null。
deadlineAt自动停止时间；空闲时或无截止时间记录时为 null。
speakerLanguage当前发言语言代码；空闲时为 null。
targetLanguages当前翻译语言代码；空闲时为空。
voice翻译语音，包括空闲时。
visibletrue 显示字幕；false 隐藏字幕。空闲时同样适用。
publisher发送音频的 Kaleo Connect 设备或浏览器；空闲时为 null。
phase会话阶段；空闲表示无活动会话。
下次手动开始的教会默认设置。活动会话的覆盖不改变这些值。
清除字幕
清除当前字幕流。无需请求体。
路径参数
churchId您的教会 ID。从仪表板中“集成”下的 API 页面复制。
清除字幕 › 响应
成功
streamingtrue 表示活动会话，包括启动、重连和关闭。不确认音频是否到达。
sessionId当前会话 ID；空闲时为 null。
startedAt当前会话开始时间；空闲时为 null。
deadlineAt自动停止时间；空闲时或无截止时间记录时为 null。
speakerLanguage当前发言语言代码；空闲时为 null。
targetLanguages当前翻译语言代码；空闲时为空。
voice翻译语音，包括空闲时。
visibletrue 显示字幕；false 隐藏字幕。空闲时同样适用。
publisher发送音频的 Kaleo Connect 设备或浏览器；空闲时为 null。
phase会话阶段；空闲表示无活动会话。
下次手动开始的教会默认设置。活动会话的覆盖不改变这些值。
更改自动停止截止时间
设置活动会话的自动停止时间。返回更新后的流媒体状态。
路径参数
churchId您的教会 ID。从仪表板中“集成”下的 API 页面复制。
更改自动停止截止时间 › 响应
成功
streamingtrue 表示活动会话，包括启动、重连和关闭。不确认音频是否到达。
sessionId当前会话 ID；空闲时为 null。
startedAt当前会话开始时间；空闲时为 null。
deadlineAt自动停止时间；空闲时或无截止时间记录时为 null。
speakerLanguage当前发言语言代码；空闲时为 null。
targetLanguages当前翻译语言代码；空闲时为空。
voice翻译语音，包括空闲时。
visibletrue 显示字幕；false 隐藏字幕。空闲时同样适用。
publisher发送音频的 Kaleo Connect 设备或浏览器；空闲时为 null。
phase会话阶段；空闲表示无活动会话。
下次手动开始的教会默认设置。活动会话的覆盖不改变这些值。
调整自动停止时间
增加或减少自动停止时间。空闲时更改下次手动开始的持续时间；流媒体时更改当前截止时间。每个请求应用单独调整。
路径参数
churchId您的教会 ID。从仪表板中“集成”下的 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会话阶段；空闲表示无活动会话。
下次手动开始的教会默认设置。活动会话的覆盖不改变这些值。