RICOH Live Streaming Conference エラー仕様

概要

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

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

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

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

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

エラー種別

LSConfで発生したエラー

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

type 発生箇所 code 概要 説明
RequestError LSConfSDK 4000番台 リクエストエラー リクエストの結果がエラーになった
InternalError LSConfSDK 5000番台 予期しないエラー LSConf開発者に問い合わせが必要なエラー

LSClientSDKで発生したエラー

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

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

例外 (Exception)

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

利用例

try {
  await frame.join(...);
} catch (error) {
  console.log(error.detail.code);
  console.log(error.detail.type);
  console.log(error.detail.error);
}

エラーイベント

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

イベントハンドラには ErrorEvent クラスが通知されます。

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

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

利用例

client.addEventListener("error", (event) => {
  console.log(event.error.detail.code);
  console.log(event.error.detail.type);
  console.log(event.error.detail.error);
  if (event.error.toReportString) {
    // LSClientSDKのエラー時のみ
    console.log(event.error.toReportString);
  }
});

エラー一覧

code type error 説明
4010 RequestError CreateArgsInvalid createの引数に誤りがある
4020 RequestError JoinArgsInvalid joinの引数に誤りがある
4030 RequestError SetArgsInvalid setの引数に誤りがある
4040 RequestError CreateFailed LSConfへのcreateのリクエストの送信に失敗した
4041 RequestError CreateTimeout LSConfのiframeのonloadのタイムアウトが発生した
4050 RequestError JoinFailed LSConfへのjoinリクエストの送信に失敗した
4060 RequestError CloseFailed LSConfへのleaveリクエストの送信に失敗した
4070 RequestError CameraMuteFailed LSConfへのsetCameraMuteリクエストの送信に失敗した
4080 RequestError MicMuteFailed LSConfへのsetMicMuteリクエストの送信に失敗した
4090 RequestError ShareRequestFailed LSConfへの画面共有のjoinリクエストの送信に失敗した
4100 RequestError GetReportFailed LSConfへのログ取得リクエストの送信に失敗した
4101 RequestError GetReportError ログ取得時にエラーが発生した
4110 RequestError ChangeLayoutFailed LSConfへのchangeLayoutリクエストの送信に失敗した
4120 RequestError GetDeviceFailed 通話開始時のカメラやマイクのデバイス取得に失敗した
4130 RequestError GetSubViewsFailed LSConfへのgetSubViewsリクエストの送信に失敗した
4131 RequestError GetSubViewsError getSubViewsの実行時にエラーが発生した
4140 RequestError GetPoVFailed LSConfへのgetPoVリクエストの送信に失敗した
4141 RequestError GetPoVError getPoVの実行時にエラーが発生した
4150 RequestError GetPoVArgsInvalid getPoVの引数に誤りがある
360映像でないSubViewに対してリクエストをした
4160 RequestError SetPoVFailed LSConfへのsetPoVリクエストの送信に失敗した
4161 RequestError SetPoVError setPoVの実行時にエラーが発生した
4170 RequestError SetPoVArgsInvalid setPoVの引数に誤りがある
360映像でないSubViewに対してリクエストをした
4180 RequestError ShareRequestArgsInvalid onShareRequested時の返り値のパラメータに誤りがある
4190 RequestError HighlightArgsInvalid highlightの引数に誤りがある
4200 RequestError HighlightFailed LSConfへのhighlightのリクエストの送信に失敗した
4210 RequestError HighlightError highlightの実行時にエラーが発生した
4220 RequestError AddRecordingMemberArgsInvalid addRecordingMemberの引数に誤りがある
4230 RequestError AddRecordingMemberFailed LSConfへのaddRecordingMemberのリクエストの送信に失敗した
4240 RequestError AddRecordingMemberError addRecordingMemberの実行時にエラーが発生した
4250 RequestError RemoveRecordingMemberArgsInvalid removeRecordingMemberの引数に誤りがある
4260 RequestError RemoveRecordingMemberFailed LSConfへのremoveRecordingMemberのリクエストの送信に失敗した
4270 RequestError RemoveRecordingMemberError removeRecordingMemberの実行時にエラーが発生した
4280 RequestError SetCameraDeviceFailed LSConfへのsetCameraDeviceのリクエストの送信に失敗した
4290 RequestError SetMicDeviceFailed LSConfへのsetMicDeviceのリクエストの送信に失敗した
4300 RequestError GetMediaDevicesFailed LSConfへのgetMediaDevicesのリクエストの送信に失敗した
4310 RequestError GetMediaDevicesError getMediaDevicesの実行時にエラーが発生した
5000-
5999
InternalError InternalErrorXXX LSConfSDKの内部エラー

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