メインコンテンツまでスキップ

遠隔支援の利用

CWS APIでは、Soraをホスティングしています。

利用者側でSora Android SDKを用いてソフトウェアを作成いただくと、THINKLETでの利用が可能です。

CWS APIで提供中のSora​

CWS APIで提供中のSoraのバージョンは、利用可能なSoraのバージョンを取得APIを利用することで取得できます。

各バージョンの詳細については、WebRTC SFU Soraドキュメントをご参照ください。

Soraのアップデート方針は以下です。

  • CWS APIのSoraは、最新のメジャーバージョンと1世代前のメジャーバージョンを提供する。
  • 時雨堂社から新しいメジャーバージョンがリリースされた場合、CWS APIで提供中の「1世代前のメジャーバージョンのSora」を「新しいメジャーバージョンのSora」に置き換える。
  • 時雨堂社から新しいマイナーバージョンがリリースされた場合、メジャーバージョンが一致するSoraに対して更新する。
  • 弊社でのSoraのアップデート時期は、時雨堂社のリリースタイミングやリリース内容に依存する。

利用方法​

WebRTCエンドポイント取得APIを利用することで、接続先となるエンドポイントの取得と任意のミーティングID(Channel)の発行ができます。

発行したミーティングID(Channel)を利用することで、デバイスをミーティングに参加させる・ミーティング時の映像を録画するといったことが可能となります。

どのデバイスであっても、発行したミーティングID(Channel)に接続する場合は、アクセストークンを付与する必要があります。詳しくは こちらをご参照ください。

シグナリング接続時のIF​

シグナリング接続ではmetadataにアクセストークン文字列のみを指定する形式と、json文字列を入れてオプションを指定する形式があります。

IFが次のいずれかに当てはまる場合には、音声認識機能を利用しないものと判断した上で、シグナリング時の認証処理は成功とみなします。

  • オプションが未指定
  • オプションの値がNULL、文字列ではない、空文字
  • アクセストークン文字列のみ

アクセストークン文字列のみ​

"metadata": "xxxxxxxxxxx"

json 文字列によるオプション指定​

"metadata" : '{
  "token": "xxxxxxxxxxx",
  "options": "ja",
  "spotlightEncodings" : [
    {"rid": "r0", "active": true, "scaleResolutionDownBy": 2.0, "maxFramerate": 5.0},
    {"rid": "r1", "active": true, "scaleResolutionDownBy": 2.0, "maxFramerate": 20.0},
    {"rid": "r2", "active": true, "scaleResolutionDownBy": 1.0, "maxFramerate": 30.0}
  ]
}'
必須項目​
  • token: アクセストークン文字列
オプション項目​
  • options: 音声認識等mimiサービス利用オプション文字列
  • spotlightEncodings : スポットライト利用時の映像のエンコーディングパラメータ

ミーティングID(Channel)の有効期限​

WebRTCエンドポイント取得で発行したミーティングID(Channel)には有効期限があります。

Channelへの接続がない状態から10分経過した場合、有効期限切れとなりシグナリング接続時にエラーとなります。

録画データの保存​

録画データを利用者様で保存される際は、Amazon S3と署名付きURL発行APIを利用者様であらかじめご用意ください。

CWS APIは、通知・アクセス設定で次のキーで登録されたURLに対して、利用者様のAmazon S3に録画データをアップロードする署名付URLの発行を依頼します。

  • soraRecGetMultiPresignedUrl(録画データ（Sora）用署名付きURL取得URL(マルチパート対応))
  • soraRecGetPresignedUrl (録画データ（Sora）用署名付きURL取得URL)

上記両方のURLを登録した場合、soraRecGetMultiPresignedUrlの設定が優先されます。

録画データのファイルサイズによりアップロードに失敗する可能性があるため、soraRecGetMultiPresignedUrlの使用を推奨します。

マルチパートでの署名付きURLを発行した場合、利用者様で録画データ通知の受信を契機に、マルチパートアップロードの完了処理を実施してください。

署名付きURLの有効期限内に、マルチパートアップロードの完了処理を行わなかった場合、Amazon S3にアップロードされた録画データは利用できません。