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

はじめに

本文書はLive Streaming APIに接続するためのクライアント機能を提供するSDKであるClient SDKを用いたアプリケーションの開発者向けにSDKの使い方を解説する文書である。本文書は本SDKのインターフェース仕様書や利用方法について記載する。

用語定義

本文書で使用する用語の定義を行う。

ClientApp

本SDKを利用するアプリケーション。Windowsアプリ、Androidアプリ、ブラウザアプリ等。

Server

Live Streaming APIのサーバー。

Metadata

付加情報。Metadata には Connection 毎に設定可能な Connection Metadata と、Track 毎に設定可能な Track Metadata がある。

提供クラス

Client

Live Streaming API のクライアント機能を提供するクラス。

Track

Live Streaming API のクライアント機能で主に映像、音声機能を提供するクラス。

データモデル

本SDKのデータモデルを記載する。

データモデル

インターフェース仕様

RICOH Live Streaming Client SDK API 外部仕様

Metadata

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を使用した想定シーケンスを記載する。

接続~切断

接続~切断

Content Security Policy (CSP)

ClientApp に 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:

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

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

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

  • Web版では、以下のAPIおよびエラーイベントの情報の出力結果をお送りください。Report系のAPIはerrorイベントハンドラで実行して下さい。
    • getHeadReport
    • getTailReport
    • getStatsReport
    • エラーイベントの情報
      client.addEventListener("error", (e) => {
      console.log(e.toReportString());
      });
  • Android版およびWindows版ではログ出力結果をお送りください。