Method: spaces.connectActiveConference

スペースのアクティブな会議への WebRTC 接続を仲介します。

成功すると、クライアントは結果の SDP(セッション記述プロトコル)アンサーを使用して WebRTC 接続を確立する必要があります。接続されると、WebRTC データチャンネル全体で追加機能が利用可能になります。

この接続について詳しくは、Meet Media API の概要をご覧ください。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

必須。スペースのリソース名。形式: spaces/{spaceId}

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現
{
  "offer": string,
  "config": {
    object (ConnectionConfig)
  }
}
フィールド
offer

string

必須。クライアントからの WebRTC SDP(Session Description Protocol)オファー。

この形式は RFC 8866 で定義され、必須キーは RFC 8829 で定義されます。これは、ピア接続の createOffer() メソッドと createAnswer() メソッドによって生成される標準の SDP 形式です。

config

object (ConnectionConfig)

省略可。Media 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

Media API セッションの追加構成オプション。

JSON 表現
{
  "confirmationTimeout": string
}
フィールド
confirmationTimeout

string (Duration format)

省略可。確認アクションがキャンセルされるまでの待機時間。設定されていない場合は、デフォルト値が使用されます。期間は 5 分を超えてはなりません。タイムアウトが大きすぎる場合や期間が負の値の場合、RPC は失敗します。