cameraOptions

Optional parameters to customize the camera settings.

{ quality : 75,
  destinationType : Camera.DestinationType.DATA_URL,
  sourceType : Camera.PictureSourceType.CAMERA,
  allowEdit : true,
  encodingType: Camera.EncodingType.JPEG,
  targetWidth: 100,
  targetHeight: 100,
  popoverOptions: CameraPopoverOptions,
  saveToPhotoAlbum: false };

Options

  • quality: Quality of the saved image, expressed as a range of 0-100, where 100 is typically full resolution with no loss from file compression. (Number) (Note that information about the camera's resolution is unavailable.)

  • destinationType: Choose the format of the return value. Defined in navigator.camera.DestinationType (Number)

      Camera.DestinationType = {
      DATA_URL : 0,      // Return image as base64-encoded string
      FILE_URI : 1,      // Return image file URI
      NATIVE_URI : 2     // Return image native URI (e.g., assets-library:// on iOS or content:// on Android)
  };

  • sourceType: Set the source of the picture. Defined in navigator.camera.PictureSourceType (Number)

      Camera.PictureSourceType = {
      PHOTOLIBRARY : 0,
      CAMERA : 1,
      SAVEDPHOTOALBUM : 2
  };

  • allowEdit: Allow simple editing of image before selection. (Boolean)

  • encodingType: Choose the returned image file's encoding. Defined in navigator.camera.EncodingType (Number)

      Camera.EncodingType = {
      JPEG : 0,               // Return JPEG encoded image
      PNG : 1                 // Return PNG encoded image
  };

  • targetWidth: Width in pixels to scale image. Must be used with targetHeight. Aspect ratio remains constant. (Number)

  • targetHeight: Height in pixels to scale image. Must be used with targetWidth. Aspect ratio remains constant. (Number)

  • mediaType: Set the type of media to select from. Only works when PictureSourceType is PHOTOLIBRARY or SAVEDPHOTOALBUM. Defined in nagivator.camera.MediaType (Number)

      Camera.MediaType = {
      PICTURE: 0,    // allow selection of still pictures only. DEFAULT. Will return format specified via DestinationType
      VIDEO: 1,      // allow selection of video only, WILL ALWAYS RETURN FILE_URI
      ALLMEDIA : 2   // allow selection from all media types };

  • correctOrientation: Rotate the image to correct for the orientation of the device during capture. (Boolean)

  • saveToPhotoAlbum: Save the image to the photo album on the device after capture. (Boolean)

  • popoverOptions: iOS-only options that specify popover location in iPad. Defined in [CameraPopoverOptions](CameraPopoverOptions.html).

  • cameraDirection: Choose the camera to use (front- or back-facing). Defined in navigator.camera.Direction (Number)

      Camera.Direction = {
      BACK : 0,      // Use the back-facing camera
      FRONT : 1      // Use the front-facing camera
  };

Android Quirks

  • Ignores the allowEdit parameter.

  • [Camera](../camera.html).PictureSourceType.PHOTOLIBRARY and [Camera](../camera.html).PictureSourceType.SAVEDPHOTOALBUM both display the same photo album.

BlackBerry Quirks

  • Ignores the quality parameter.

  • Ignores the sourceType parameter.

  • Ignores the allowEdit parameter.

  • Application must have key injection permissions to close the native Camera application after the user snaps the photo.

  • Using large image sizes may result in the inability to encode images on later-model devices (e.g., Torch 9800) that feature high-resolution cameras.

  • [Camera](../camera.html).MediaType is not supported.

  • Ignores the correctOrientation parameter.

  • Ignores the cameraDirection parameter.

iOS Quirks

  • Set quality below 50 to avoid memory errors on some devices.

  • When using destinationType.FILE_URI, photos are saved in the application's temporary directory. You may delete the contents of this directory using the navigator.fileMgr APIs if storage space is a concern.

Tizen Quirks

  • options not supported

  • always returns a FILE URI

Windows Phone 7 and 8 Quirks

  • Ignores the allowEdit parameter.

  • Ignores the correctOrientation parameter.

  • Ignores the cameraDirection parameter.