JoinStorageSessionAsViewer - Amazon Kinesis Video Streams
リクエストの構文URI リクエストパラメータリクエスト本文レスポンスの構文レスポンス要素エラー以下の資料も参照してください。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

JoinStorageSessionAsViewer

注記

マルチビューワーサポートによるウェブRTC取り込み (プレビュー) は、 AWS 「 サービス条件」で定義されているようにプレビューで提供されており、変更される可能性があります。現在、us-east-1 () でのみ使用できますIAD。

プレビューに参加するには、kvs-webrtc-multi-view-preview@amazon.com までメールでご連絡ください。

注記

この を使用する前にAPI、 を呼び出しGetSignalingChannelEndpointAPIてWEBRTCエンドポイントをリクエストする必要があります。次に、JoinStorageSessionAsViewerAPIリクエストでエンドポイントとリージョンを指定します。

進行中の一方向動画および/または多方向音声ウェブRTCセッションを入力チャネルの動画生成デバイスとして参加します。チャネルに既存のセッションがない場合は、新しいストリーミングセッションを作成し、シグナリングチャネルの Amazon リソースネーム (ARN) を指定します。

現在、 SINGLE_MASTERタイプでは、ビデオ生成デバイスはオーディオメディアとビデオメディアの両方をストリームに取り込むことができます。

重要

現在、視聴者はビデオトラックを送信できません。ビューワーは、オプションのオーディオトラックを送信することも、トラックをまったく送信することもできません。

現在の視聴者参加者の送信要件：

  • ビデオトラック: サポートされていません

  • オーディオトラック (オプション): Opus

マスター参加者が現在ビデオ生成デバイスに接続されている場合、Kinesis ビデオストリームに取り込まれたビデオには、H.264 ビデオとAACオーディオのパラメータが含まれます。

ビューワー参加者は、相互に聞こえ、ウェブ を通じてマスター参加者からメディアを受信できますRTC。

注記

ビューワー参加者は、マスター参加者ではなくストレージセッションに直接接続します。ストレージセッションは、メディアを適切な宛先にミキシング、複製、ルーティングします。

注記

マスター参加者が存在しない場合、ビューワーは互いに聞くことができません。

ビューワー参加者がウェブ を介して接続をネゴシエートするとRTC、マスター参加者がストレージセッションにも接続されている限り、取り込まれたオーディオセッションが Kinesis ビデオストリームに保存されます。

取り込み済みウェブRTCメディアではGetImages、 HLSや DASH再生、 を介したイメージ生成などの既存の Kinesis Video Streams 機能を使用することもできます。

注記

S3 イメージの配信と通知は現在サポートされていません。

注記

チャンネルのセッションに関連付けることができるビデオ生成デバイスクライアントは 1 つだけであるとします。複数のクライアントが特定のチャネルのセッションを動画生成デバイスとして参加する場合、最新のクライアントリクエストが優先されます。

制限

現在の制限は設定されています。

  • ビューワーの最大数： 3

  • ビューワー参加者がマスター参加者なしでストレージセッションに接続したままの最大時間： 3 分

重要

ビューワーがストレージセッションから切断した場合 (ピア接続を閉じる場合）、クォータ (ビューワー制限) は 1 分間消費されたままになります。この 1 分間、ビューワーは同じクライアント ID APIでこれを呼び出して、追加のビューワークォータを消費することなくセッションに再参加できます。1 分後、ビューワークォータが解放され、他のビューワーが参加できるようになります。

追加情報

  • 冪等性 - API これは冪等性ではありません。

  • 再試行動作 - これは新しいAPI呼び出しとしてカウントされます。

  • 同時呼び出し - 同時呼び出しが許可されます。オファーは、コールごとに 1 回送信されます。

リクエストの構文

POST /joinStorageSessionAsViewer HTTP/1.1
Content-type: application/json

{
   "channelArn": "string",
   "clientId": "string"
}

URI リクエストパラメータ

リクエストはURIパラメータを使用しません。

リクエスト本文

リクエストは、 JSON形式の次のデータを受け入れます。

channelArn

シグナリングチャネルの Amazon リソースネーム (ARN）。

重要

この入力パラメータの大文字化に注意してください。

型: 文字列

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

必須：はい

clientId

セッションクライアントの一意の識別子 (ID)。

型: 文字列

長さの制限：最小長は 1 です。最大長は 256 です。

Pattern: ^[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でこれを使用する方法の詳細については AWS SDKs、以下を参照してください。