Method: spaces.connectActiveConference

仲介與空間現有會議的 WebRTC 連線。

成功後,用戶端必須使用產生的 SDP (工作階段描述通訊協定) 回覆,建立 WebRTC 連線。連線後,WebRTC 資料管道會提供額外功能。

如要進一步瞭解這項連線,請參閱「Meet Media API 總覽」。

HTTP 要求

POST https://meet.googleapis.com/v2beta/{name=spaces/*}:connectActiveConference

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
name

string

必填。聊天室的資源名稱。格式:spaces/{spaceId}

要求主體

要求主體會包含結構如下的資料:

JSON 表示法
{
  "offer": string,
  "config": {
    object (ConnectionConfig)
  }
}
欄位
offer

string

必填。用戶端提供的 WebRTC SDP (工作階段描述通訊協定)。

格式由 RFC 8866 定義,強制性鍵則由 RFC 8829 定義。這是標準 SDP 格式,由對等連線的 createOffer() 和 createAnswer() 方法產生。

config

object (ConnectionConfig)

(選用步驟) 媒體 API 工作階段的其他設定選項。如未設定,系統會為工作階段提供預設值。

回應主體

spaces.connectActiveConference 方法的回應。

成功回應並不表示已完全加入會議,必須透過 WebRTC 進行進一步通訊。

如要進一步瞭解這項連線,請參閱「Meet Media API 總覽」。

如果成功,回應主體會含有以下結構的資料:

JSON 表示法
{
  "answer": string,
  "traceId": string
}
欄位
answer

string

WebRTC SDP 回覆提案。

traceId

string

用於偵錯的追蹤 ID。回報錯誤時,請附上這個值。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/meetings.conference.media.readonly
  • https://www.googleapis.com/auth/meetings.conference.media.audio.readonly
  • https://www.googleapis.com/auth/meetings.conference.media.video.readonly

詳情請參閱授權指南。

ConnectionConfig

媒體 API 工作階段的其他設定選項。

JSON 表示法
{
  "confirmationTimeout": string
}
欄位
confirmationTimeout

string (Duration format)

(選用步驟) 取消確認動作前等待的時間長度。如未設定,系統會使用預設值。時間長度不得超過 5 分鐘。如果逾時時間較長或持續時間為負值,RPC 就會失敗。