JoinStorageSessionAsViewer - Amazon Kinesis Video Streams
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

JoinStorageSessionAsViewer

注意

根据服务条款的定义,支持多画面浏览器(预览版)的WebRTC收录以预览版形式提供 Amazon ,可能会发生变化。它目前仅在 us-east-1 (IAD) 中可用。

要参与预览,请发送电子邮件kvs-webrtc-multi-view至-preview@amazon.com

注意

在使用此 API 之前,您必须调用该 GetSignalingChannelEndpoint API 来请求 WEBRTC 终端节点。然后,您可以在 JoinStorageSessionAsViewer API 请求中指定终端节点和区域。

JoinStorageSessionAsViewer允许观众加入正在进行的云端录制的 WebRTC 直播会话。该API通过在观看者和录制代理之间发送SDP报价和ICE候选内容来启动WebRTC连接,允许观看者通过录制代理接收来自主人的实时视频,并通过录制代理参与双向音频通信。连接后,观看者的音频(如果提供)将转发给所有其他连接的对等方,包括主参与者,并合并到保存到Kinesis视频流的WebRTC流中。

重要

观众目前无法发送任何视频曲目。观众可以发送可选音轨或根本不发送任何曲目。

当前观众参与者的发送要求:

  • 视频曲目:不支持

  • 音轨(可选):Opus

如果主参与者当前已连接到视频制作设备,则在 Kinesis 视频流中生成的摄取视频将具有以下参数:H.264 视频和 AAC 音频。

注意

查看者参与者直接连接到存储会话,而不是直接连接到主参与者。存储会话负责混合、复制媒体并将其路由到相应的目的地。

注意

如果主参与者不在场,观众将无法听见对方的声音。

观看者参与者通过WebRTC协商连接后,只要主参与者也连接到存储会话,摄取的音频会话就会存储在Kinesis视频流中。

您还可以使用现有的 Kinesis Video Streams 功能,HLS例如DASH或播放、通过 webRTC 生成图像等,以及GetImages通过摄取的 WebRTC 媒体进行图像生成等。

注意

目前不支持 S3 图像传输和通知。

注意

假设只有一个视频制作设备客户端可以与该频道的会话相关联。如果多个客户端作为视频制作设备加入特定频道的会话,则最新的客户端请求优先。

限制

目前的限制已经到位:

  • 最大观看人数:3

  • 在没有@@ 主参与者在场的情况下,查看者参与者与存储会话保持连接的最长时间:3 分钟

重要

如果查看者断开与存储会话的连接(关闭对等连接),则其配额(查看者限制)将在 1 分钟内保持消耗。在这个 1 分钟内,查看者可以使用相同的客户端 ID 调用此 API 以重新加入会话,而无需消耗额外的观看者配额。1 分钟后,观众配额已释放,可供其他观众加入。

其他信息

  • 等性-此 API 不是等性的。

  • 重试行为-这算作新的 API 调用。

  • 并发呼叫-允许并发呼叫。每次调用发送一次提议。

注意

此 API Amazon 在中国区域不可用。

请求语法

POST /joinStorageSessionAsViewer HTTP/1.1 Content-type: application/json { "channelArn": "string", "clientId": "string" }

URI 请求参数

该请求不使用任何 URI 参数。

请求正文

请求接受采用 JSON 格式的以下数据。

channelArn

信令通道的 Amazon 资源名称(ARN)。

重要

请注意此输入参数的大写。

类型:字符串

模式:^arn:(aws[a-zA-Z-]*):kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+$

必需:是

clientId

发件人客户端的唯一标识符。

类型:字符串

长度限制:最小长度为 1。最大长度为 256。

模式:^[a-zA-Z0-9_.-]+$

必需:是

响应语法

HTTP/1.1 200

响应元素

如果此操作成功,则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。

错误

有关所有操作的常见错误的信息,请参阅常见错误

AccessDeniedException

您没有执行此操作所需的权限。

HTTP 状态代码:403

ClientLimitExceededException

Kinesis Video Streams 已限制该请求,因为您已超过允许的客户端调用限制。稍后再尝试拨打电话。

HTTP 状态代码:400

InvalidArgumentException

此输入参数的值无效。

HTTP 状态代码:400

ResourceNotFoundException

未找到指定的资源。

HTTP 状态代码:404

另请参阅

有关以特定语言之一使用此 API 的更多信息 Amazon SDKs,请参阅以下内容: