RICOH Live Streaming Conference アプリケーション開発者ガイド

はじめに

RICOH Live Streaming Conference は RICOH Live Streaming Service を使った様々な機能をiframeコンポーネントとしてWebアプリケーションへ簡単に組み込むためのWebアプリケーション用コンポーネントです。

利用イメージ

利用イメージ

コンポーネント構成

RICOH Live Streaming Conference で利用する各コンポーネントの位置付けは以下の通りです。

LSConf

後述の LSConfSDK から生成するiframeコンポーネント。
生成したiframeコンポーネントをアプリケーション内に組み込むことで、RICOH Live Streaming Service を利用した映像や音声によるコミュニケーションを行う通話画面のUI部品として利用できる。
LSConf の生成時に LSConfSDK から様々なカスタマイズ設定を行うことができる。

LSConfSDK

本SDKをライブラリとしてアプリケーションに組み込むことで、LSConf の生成、LSConf に対してのリクエスト、LSConf からのイベント通知の受け取り、などが可能となる。
LSConf の生成後にJoinのAPIを実行することで生成された LSConf 上で RICOH Live Streaming Service への接続を行う。

LSClientSDKとの連携

LSConfとLSClientSDKを組み合わせて利用する際の注意事項を記載します。

Access Token

LSConfとLSClientSDKをそれぞれ利用したアプリケーションから同一のRoomに接続させたい場合、以下のパラメータを全てのクライアントで合わせる必要があります。

  • Client.connect() 時に指定する client_id の値
  • Access Token の署名に使用する client_secret の値
  • Access Token 内の room_spec の値

Track Metadata

LSClientSDKから送信されたTrackをLSConf側で正しく表示したい場合、LSClientSDK側でTrack Metadataを明示的に設定する必要があります。

LSClientSDKのMetadataの仕様と利用方法については RICOH Live Streaming Client SDK アプリケーション開発者ガイド を参照ください。

LSConfでは以下のMetadataの指定がされた場合に対応する処理を行います。

キー             説明
isTheta 映像ソースがTHETAかどうかを識別し、true の場合は360映像として表示する。指定がない場合は false とする。
thetaVideoFormat 360映像のフォーマットを識別して表示をする。isTheta が trueでこちらの値の指定がない場合は "eq" とする。

エラー

RICOH Live Streaming Conference エラー仕様 を参照ください。

シーケンス

RICOH Live Streaming Conference を使用したサンプルアプリの利用シーケンスを記載します。

シーケンス図

Content Security Policy (CSP)

LSConfを利用したアプリケーションに CSP を適用する場合は、Web サーバレスポンスの Content-Security-Policy HTTP ヘッダーに下記のポリシーディレクティブをマージしてください。

connect-src wss://signaling.livestreaming.mw.smart-integration.ricoh.com wss://signaling-dev.livestreaming.mw.smart-integration.ricoh.com
media-src mediastream:
frame-src https://conf.livestreaming.mw.smart-integration.ricoh.com

※ wss://signaling-dev.livestreaming.mw.smart-integration.ricoh.com/v1/room はdev環境を使用しない場合は不要です。

障害発生時のお問い合わせについて

接続できない、異常切断される、映像または音声が出力されない等の障害が生じた場合、以下の方法で得られた出力結果(テキスト)を添付してサポート窓口にお問い合わせください。

  • 以下のAPIおよびエラーイベントの情報の出力結果をお送りください
    • getVideoAudioLog
    • getScreenShareLog
    • getVideoAudioStats
    • getScreenShareStats
    • エラーイベントの情報