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概要説明
RequestErrorLSConfSDK4000 番台リクエストエラーリクエストの結果がエラーになった
InternalErrorLSConfSDK5000 番台予期しないエラー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)
  }
})

エラー一覧

codetypeerror説明
4010RequestErrorCreateArgsInvalidcreate の引数に誤りがある
4020RequestErrorJoinArgsInvalidjoin の引数に誤りがある
4030RequestErrorSetArgsInvalidset の引数に誤りがある
4040RequestErrorCreateFailedLSConf への postMessage に失敗した
4041RequestErrorCreateTimeoutLSConf の iframe の onload のタイムアウトが発生した
4050RequestErrorJoinFailedLSConf への postMessage に失敗した
4051RequestErrorJoinFailedTimeoutLSConf への join のレスポンスがタイムアウト(10 秒)した
4060RequestErrorCloseFailedLSConf への postMessage に失敗した
4070RequestErrorCameraMuteFailedLSConf への postMessage に失敗した
4080RequestErrorMicMuteFailedLSConf への postMessage に失敗した
4090RequestErrorShareRequestFailedLSConf への postMessage に失敗した
4100RequestErrorGetReportFailedLSConf への postMessage に失敗した
4101RequestErrorGetReportError対象のクライアントが存在しない
(VideoAudio/ScreenShare)
4110RequestErrorChangeLayoutFailedLSConf への postMessage に失敗した
4120RequestErrorGetDeviceFailed接続時のカメラやマイクのデバイス取得に失敗した
4130RequestErrorGetSubViewsFailedLSConf への postMessage に失敗した
4131RequestErrorGetSubViewsErrorgetSubViews の実行時にエラーが発生した
4140RequestErrorGetPoVFailedLSConf への postMessage に失敗した
4141RequestErrorGetPoVError対象の SubView が存在しない
4150RequestErrorGetPoVArgsInvalidgetPoV の引数に誤りがある
360 映像でない SubView に対してリクエストをした
4160RequestErrorSetPoVFailedLSConf への postMessage に失敗した
4161RequestErrorSetPoVError対象の SubView が存在しない
4170RequestErrorSetPoVArgsInvalidsetPoV の引数に誤りがある
360 映像でない SubView に対してリクエストをした
4180RequestErrorShareRequestArgsInvalidonShareRequested 時の返り値のパラメータに誤りがある
4190RequestErrorHighlightArgsInvalidhighlight の引数に誤りがある
4200RequestErrorHighlightFailedLSConf への postMessage に失敗した
4210RequestErrorHighlightError対象の SubView が存在しない
4220RequestErrorAddRecordingMemberArgsInvalidaddRecordingMember の引数に誤りがある
4230RequestErrorAddRecordingMemberFailedLSConf への postMessage に失敗した
4240RequestErrorAddRecordingMemberError対象の SubView や ConnectionID が存在しない
4250RequestErrorRemoveRecordingMemberArgsInvalidremoveRecordingMember の引数に誤りがある
4260RequestErrorRemoveRecordingMemberFailedLSConf への postMessage に失敗した
4270RequestErrorRemoveRecordingMemberError対象の SubView や ConnectionID が存在しない
4280RequestErrorSetCameraDeviceFailedLSConf への postMessage に失敗した
4290RequestErrorSetMicDeviceFailedLSConf への postMessage に失敗した
4300RequestErrorGetMediaDevicesFailedLSConf への postMessage に失敗した
4310RequestErrorGetMediaDevicesErrorカメラやマイクのデバイス取得時にエラーが発生した
4320RequestErrorGetCaptureImageFailedLSConf への postMessage に失敗した
4330RequestErrorGetCaptureImageError対象の SubView が存在しない
キャプチャの試行回数の上限に達した
4331RequestErrorGetCaptureImageErrorCameraMuted対象の SubView がカメラミュート状態だった
4340RequestErrorGetCaptureImageArgsInvalidgetCaptureImage の引数に誤りがある
4350RequestErrorStartRecordingFailed録画対象の MediaStream が存在しない
録画対象の MediaStream が inactive
録画対象が他拠点かつカメラミュート
4351RequestErrorRecordingErrorBlackScreen録画中に既知の問題のNo.23の黒画面を検知した(誤検知の可能性もあるため、正常に録画できるのを確認した環境でこのメッセージが表示される場合は無視しても問題ありません)
4360RequestErrorStartReceiveVideoFailedLSConf への postMessage に失敗した
4370RequestErrorStartReceiveVideoError対象の SubView が存在しない
web-sdk 側でエラーが発生した
4380RequestErrorStartReceiveVideoArgsInvalidstartReceiveVideo の引数に誤りがある
4390RequestErrorStopReceiveVideoFailedLSConf への postMessage に失敗した
4400RequestErrorStopReceiveVideoError対象の SubView が存在しない
web-sdk 側でエラーが発生した
4410RequestErrorStopReceiveVideoArgsInvalidstopReceiveVideo の引数に誤りがある
4420RequestErrorGetLSConfLogFailedLSConf への postMessage に失敗した
4430RequestErrorGetLSConfLogErrorgetLSConfLog の実行時にエラーが発生した
4440RequestErrorEnablePointerFailedLSConf への postMessage に失敗した
4450RequestErrorUpdatePointerArgsInvalidupdatePointer の引数に誤りがある
4460RequestErrorUpdatePointerFailedLSConf への postMessage に失敗した
4470RequestErrorUpdatePointerError対象の SubView が存在しない
4480RequestErrorModeInvalidjoin 時に指定されたモードでは実行できないメソッドを実行した
4490RequestErrorChangeLayoutArgsInvalidchangeLayout の引数に誤りがある
4500RequestErrorEnableZoomFailedLSConf への postMessage に失敗した
4510RequestErrorEnableZoomError対象の SubView が存在しない
4520RequestErrorEnableZoomArgsInvalidenableZoom の引数に誤りがある
4530RequestErrorGetStatsArgsInvalidgetStats の引数に誤りがある
4540RequestErrorGetStatsFailedLSConf への postMessage に失敗した
4550RequestErrorGetStatsError対象の SubView が存在しない
4560RequestErrorSetRotationVectorFailedLSConf への postMessage に失敗した
4570RequestErrorSetRotationVectorError対象の SubView が存在しない
4580RequestErrorSetRotationVectorArgsInvalidsetRotationVector の引数に誤りがある
4590RequestErrorCreateTypeInvalidcreate/createPlayer 後に許可されていないメソッドを実行した
(Room/Player)
5000-
5999
InternalErrorInternalErrorXXXLSConfSDK の内部エラー

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