Document CameraException error codes.

[amirh]

In the camera plugin - it's unclear what are the possible values of CameraException.code.

[bharat-biradar]

HI @pedromassangocode is the explanation of error codes necessary. If it is, can I work on it?

[pedromassangocode]

Hi @bharat-biradar
Sorry, I'm not sure. Maybe @amirh could give you a hint.

[bharat-biradar]

@amirh is the explanation required, if not this issue can be closed.

[huberrom]

Hi @bharat-biradar @pedromassango !

I'm on this issue because the error codes was needed, and I indeed didn't know which code was equal to permission not granted.

For me it is needed if the user refuse to give permission (and select the option "Don't ask again"). I want to react to this event saying my app need it and then open settings.

Maybe a enum could be created so we can check which error we have (and to prevent futur bug if you change the error code).

Because
if(e.code == "cameraPermission"), if cameraPermission is changed, my code doesn't work anymore

Thanks in advance !

[bharat-biradar]

@pedromassangocode Shall I document the error codes and open a PR.

[pedromassangocode]

@bharat-biradar sure go-ahead :)

[bharat-biradar]

@huberrom the error code "cameraPermission" may be due given due to different reasons.

I found a lot of error codes and their description. Just to confirm is this what you needed to be documented.

///  |Error code          |  Error Description    |
  ///  "cameraPermission" => "Camera permission request ongoing"
  ///  "cameraPermission" => "MediaRecorderCamera permission not granted"
  ///  "cameraNotFound"   => "Camera not found. Please call the 'create' method before calling 'initialize'."
  ///  "captureAlreadyActive" => "Picture is currently already being captured"
  ///  "cannotCreateFile"  => "failed to create a file" (may depend on various factors)
  ///  "captureTimeout" => "Picture capture request timed out"
  ///  "captureFailure" => "Unknown reason"
  ///  "captureFailure" => "The capture has failed due to an abortCaptures() call"
  ///  "captureFailure" => "An error happened in the framework"
  ///  "IOError"     => "Failed saving image"
  ///  "IOError"  => "Setup Writer Failed"
  ///  "videoRecordingFailed"  => "Failed to record video"  (may depend on various factors)
  ///  "videoRecordingFailed"  => "pauseVideoRecording requires Android API +24."
  ///  "videoRecordingFailed"  => "resumeVideoRecording requires Android API +24."
  ///  "setFlashModeFailed"  => "Device does not have flash capabilities"
  ///  "setFlashModeFailed" => "Unknown flash mode " + mode
  ///  "setFlashModeFailed"   => "Could not set flash mode."
  ///  "setExposureModeFailed" => "Unknown exposure mode " + mode
  ///  "setExposurePointFailed" => "Device does not have exposure point capabilities"
  ///  "setExposurePointFailed" => "Could not determine max region boundaries"
  ///  "setFocusModeFailed" => "Unknown focus mode " + mode
  ///  "setFocusPointFailed" => "Device does not have focus point capabilities"
  ///  "setFocusPointFailed" => "Could not determine max region boundaries"
  ///  "ZOOM_ERROR"  =>   "Zoom level out of bounds (zoom level should be between min_zoom and max_zoom)."
  ///  "ZOOM_ERROR"  =>  "setZoomLevel is called without specifying a zoom level."

[huberrom]

Yes this is exactly what I need (in fact I personnaly just need cameraPermission).

I got another error code which is "Error -11852", which I got only on IOS and append at the same time as cameraPermission on Android. I don't where it come from tho

Edit : What I meant by documented was to use a enum too prevent issue if there is a modification later