RICOH Live Streaming Conference エラー仕様

概要

本文書では、Live Streaming Conference のエラー仕様について記載します。

LSConfSDK からは 2 種類のエラーをアプリケーションに返します。

• LSConf で発生したエラー
• LSConf 内で利用する LSClientSDK で発生したエラー

エラーは例外及びエラーイベントで取得でき、エラーの詳細はErrorDetail型で表現されます。

interface ErrorDetail {
  code: Number;
  type: string;
  error: string;
}

エラー種別

LSConf で発生したエラー

エラーコードが 4桁 のエラーは LSConf で発生したエラーです。

LSClientSDK で発生したエラー

エラーコードが 5桁 のエラーは LSConf 内で利用する LSClientSDK で発生したエラーです。

LSClientSDK のエラー仕様については RICOH Live Streaming Client SDK エラー仕様 を参照ください。

例外 (Exception)

関数呼び出し時のエラーは Error クラスの派生クラスの LSConfError クラスで取得できます。

利用例

try {
  await frame.join(...);
} catch (error) {
  if (error instanceof LSConfError) {
    console.log(error.detail.code);
    console.log(error.detail.type);
    console.log(error.detail.error);
    console.log(error.toReportString());
    if (error.data) {
      // エラーデータが含まれるエラー時のみ
      console.log(JSON.stringify(error.data));
    }
  }
}

LSClientSDK で発生したエラーについては、問い合わせ時に toReportString() の情報が必要となります。

• toReportString() はエラー内容によっては数十 KB になる場合があるため、エラー出力などを行う場合は注意してください
• toReportString() を問い合わせ以外の目的で利用することはサポートしません

エラーイベント

その他のエラーは error イベントを listen することで取得できます。

イベントハンドラには LSConfErrorEvent クラスが通知されます。 エラー詳細は LSConfErrorEvent クラスの error.detail メンバに含まれる。

LSClientSDK で発生したエラーについては、問い合わせ時に toReportString() の情報が必要となります。

• toReportString() はエラー内容によっては数十 KB になる場合があるため、エラー出力などを行う場合は注意してください
• toReportString() を問い合わせ以外の目的で利用することはサポートしません

利用例

frame.addEventListener('error', (event: LSConfErrorEvent) => {
  console.log(event.error.detail.code);
  console.log(event.error.detail.type);
  console.log(event.error.detail.error);
  console.log(event.error.toReportString());
  if (event.error.data) {
    // エラーデータが含まれるエラー時のみ
    console.log(event.error.data);
  }
});

エラーデータ

以下のエラーはエラーデータを取得することが可能です。

MediaSourceError

指定したメディアソースにエラーが発生した

{
  type: 'error',
  error: {
    detail: ErrorDetail,
    data: {
      connectionId: IDString,
      url: string
    }
  }
}

GetDeviceFailed

接続時のカメラやマイクのデバイス取得に失敗した

{
  detail: ErrorDetail,
  data: {
    reason: string
  }
}

GetMediaDevicesError

カメラやマイクのデバイス取得時にエラーが発生した

{
  detail: ErrorDetail,
  data: {
    reason: string
  }
}

エラー一覧

※ エラーコードが 5桁 の LSClientSDK のエラーについては RICOH Live Streaming Client SDK エラー仕様 を参照ください。