RICOH Live Streaming Client SDK エラー仕様

SDK エラーは例外及びエラーイベントで取得できる。

SDK エラーは ErrorDetail 型で表現される。

type ErrorType = 'ParameterError' | 'NetworkError' | 'UnexpectedError';
interface ErrorDetail {
  code: Number;
  type: ErrorType;
  error: string;
}

Exception

関数呼び出し時のエラーは Error クラスの派生クラスである SDKError クラスで取得できる。

エラー詳細は SDKError クラスの detail メンバに含まれる。

SDK 開発者への問い合わせの際に toReportString()メソッドで取得した文字列が使用できる。
※ SDK 開発者への問い合わせ以外の目的で当メソッドを利用することはサポートしない

SDKError クラス

class SDKError extends Error {
    public detail: ErrorDetail;
    public toReportString(): string;
}

利用例

try {
  client.connect();
} catch (e: SDKError) {
  console.log(e.detail.code);
  console.log(e.detail.type);
  console.log(e.detail.error);
}

エラーイベント

その他のエラーはerrorイベントを listen することで取得できる。
イベントハンドラには SDKErrorEvent クラスが通知される。

エラー詳細は SDKErrorEvent クラスの detail メンバに含まれる。

SDK 開発者への問い合わせの際に toReportString()メソッドで取得した文字列が使用できる。
※ SDK 開発者への問い合わせ以外の目的で当メソッドを利用することはサポートしない

SDKErrorEvent クラス

class SDKErrorEvent extends CustomEvent<any> {
  public detail: ErrorDetail;
  public toReportString(): string;
}

利用例

client.addEventListener('error', (e: SDKErrorEvent) => {
  console.log(e.detail.code);
  console.log(e.detail.type);
  console.log(e.detail.error);
});

エラー一覧

ParameterError

NetworkError

※ NetworkError に関して原因が記載されているものに関しては、エラー発生後に connect()を再度行うこと（リトライ）で接続可能な場合があります。ただし、リトライで接続できるケースは、ネットワーク混雑等に起因する場合のみですので、ネットワーク環境のルーターやファイアウォールの設定に問題がある場合は、設定を修正してください。

UnexpectedError