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 定义。这是对等连接的 createOffer() 和 createAnswer() 方法生成的标准 SDP 格式。

config

object (ConnectionConfig)

可选。媒体 API 会话的其他配置选项。如果未设置,系统会为会话提供默认值。

响应正文

spaces.connectActiveConference 方法的响应。

成功响应并不表示会议已完全加入;必须通过 WebRTC 进行进一步通信。

如需详细了解此连接,请参阅 Meet Media API 概览。

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "answer": string,
  "traceId": string
}
字段
answer

string

针对提议的 WebRTC SDP 应答。

traceId

string

用于调试的轨迹 ID。提交 bug 时,请附上此值。

授权范围

需要以下 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 失败。