注意:啟動串流端點僅能用於從 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會議階段;閒置表示無活動會議。
教會預設的下一次手動啟動設定。活動會議的覆寫不會更改這些值。

