本文書は Live Streaming API に接続するためのクライアント機能を提供する SDK である Client SDK を用いたアプリケーションの開発者向けに SDK の使い方を解説する文書である。本文書は本 SDK のインターフェース仕様書や利用方法について記載する。
本文書で使用する用語の定義を行う。
本 SDK を利用するアプリケーション。Windows アプリ、Android アプリ、ブラウザアプリ等。
Live Streaming API のサーバー。
付加情報。Metadata には Connection 毎に設定可能な Connection Metadata と、Track 毎に設定可能な Track Metadata がある。
Live Streaming API のクライアント機能を提供するクラス。
Live Streaming API のクライアント機能で主に映像、音声機能を提供するクラス。
本 SDK のデータモデルを記載する。
RICOH Live Streaming Client SDK API 外部仕様
Metadata の仕様と利用方法を記載する。
Connection Metadata は本 SDK 利用者側の ID などとの紐付けや、映像への拠点名表示に 利用することができる。ただし、暗号化されないためメールアドレス等の個人情報は非推奨。
Track Metadata は音声や映像の種類の特定などに利用することができる。
Metadata はClient.connect()
で指定することで設定することができる。
Connection Metadata は他の参加者に対してaddremoteconnection
イベントによって共有される。
Track Metadata は他の参加者に対してaddRemoteTrack
イベントによって共有される。
一部 Metadata は特定の意味を表す。 RICOH Live Streaming Conference で特定の意味を表す Metadata はこちら。
RICOH Live Streaming Client SDK エラー仕様
本 SDK を使用した想定シーケンスを記載する。
ClientApp に CSP を適用する場合は、Web サーバレスポンスの Content-Security-Policy HTTP ヘッダーに下記のポリシーディレクティブをマージしてください。
connect-src wss://signaling.livestreaming.mw.smart-integration.ricoh.com
media-src mediastream:
※ Dev 環境を利用する場合、Dev 環境の URL も合わせて指定する必要があります
接続できない、異常切断される、映像または音声が出力されない等の障害が生じた場合、以下の方法で得られた出力結果(テキスト)を添付してサポート窓口にお問い合わせください。
client.addEventListener('error', (e) => {
console.log(e.toReportString())
})
この情報は役に立ちましたか?