diff --git a/README.md b/README.md
index 5a18c37..f64ca0f 100644
--- a/README.md
+++ b/README.md
@@ -35,6 +35,16 @@ Although the object is attached to the global scoped `navigator`, it is not avai
cordova plugin add cordova-plugin-camera
+## API
+- Camera
+ - navigator.camera.getPicture(success, fail, options)
+ - CameraOptions
+ - CameraPopoverHandle
+ - CameraPopoverOptions
+ - navigator.camera.cleanup
+
+
+
## navigator.camera.getPicture
Takes a photo using the camera, or retrieves a photo from the device's
@@ -43,9 +53,9 @@ base64-encoded `String`, or as the URI for the image file. The method
itself returns a `CameraPopoverHandle` object that can be used to
reposition the file selection popover.
- navigator.camera.getPicture( cameraSuccess, cameraError, cameraOptions );
+ navigator.camera.getPicture(cameraSuccess, cameraError, cameraOptions);
-### Description
+#### Description
The `camera.getPicture` function opens the device's default camera
application that allows users to snap pictures. This behavior occurs
@@ -83,69 +93,11 @@ quality, even if a `quality` parameter is specified. To avoid common
memory problems, set `Camera.destinationType` to `FILE_URI` rather
than `DATA_URL`.
-### Supported Platforms
+#### Supported Platforms
-- Amazon Fire OS
-- Android
-- BlackBerry 10
-- Browser
-- Firefox OS
-- iOS
-- Tizen
-- Windows Phone 7 and 8
-- Windows 8
-- Windows
+        
-### Preferences (iOS)
-
-- __CameraUsesGeolocation__ (boolean, defaults to false). For capturing JPEGs, set to true to get geolocation data in the EXIF header. This will trigger a request for geolocation permissions if set to true.
-
-
-
-
-### Amazon Fire OS Quirks
-
-Amazon Fire OS uses intents to launch the camera activity on the device to capture
-images, and on phones with low memory, the Cordova activity may be killed. In this
-scenario, the image may not appear when the cordova activity is restored.
-
-### Android Quirks
-
-Android uses intents to launch the camera activity on the device to capture
-images, and on phones with low memory, the Cordova activity may be killed. In this
-scenario, the image may not appear when the Cordova activity is restored.
-
-### Browser Quirks
-
-Can only return photos as base64-encoded image.
-
-### Firefox OS Quirks
-
-Camera plugin is currently implemented using [Web Activities](https://hacks.mozilla.org/2013/01/introducing-web-activities/).
-
-### iOS Quirks
-
-Including a JavaScript `alert()` in either of the callback functions
-can cause problems. Wrap the alert within a `setTimeout()` to allow
-the iOS image picker or popover to fully close before the alert
-displays:
-
- setTimeout(function() {
- // do your thing here!
- }, 0);
-
-### Windows Phone 7 Quirks
-
-Invoking the native camera application while the device is connected
-via Zune does not work, and triggers an error callback.
-
-### Tizen Quirks
-
-Tizen only supports a `destinationType` of
-`Camera.DestinationType.FILE_URI` and a `sourceType` of
-`Camera.PictureSourceType.PHOTOLIBRARY`.
-
-### Example
+#### Example
Take a photo and retrieve it as a base64-encoded image:
@@ -176,6 +128,54 @@ Take a photo and retrieve the image's file location:
alert('Failed because: ' + message);
}
+#### Preferences (iOS)
+
+- __CameraUsesGeolocation__ (boolean, defaults to false). For capturing JPEGs, set to true to get geolocation data in the EXIF header. This will trigger a request for geolocation permissions if set to true.
+
+
+
+#### Amazon Fire OS Quirks
+
+Amazon Fire OS uses intents to launch the camera activity on the device to capture
+images, and on phones with low memory, the Cordova activity may be killed. In this
+scenario, the image may not appear when the cordova activity is restored.
+
+#### Android Quirks
+
+Android uses intents to launch the camera activity on the device to capture
+images, and on phones with low memory, the Cordova activity may be killed. In this
+scenario, the image may not appear when the Cordova activity is restored.
+
+#### Browser Quirks
+
+Can only return photos as base64-encoded image.
+
+#### Firefox OS Quirks
+
+Camera plugin is currently implemented using [Web Activities](https://hacks.mozilla.org/2013/01/introducing-web-activities/).
+
+#### iOS Quirks
+
+Including a JavaScript `alert()` in either of the callback functions
+can cause problems. Wrap the alert within a `setTimeout()` to allow
+the iOS image picker or popover to fully close before the alert
+displays:
+
+ setTimeout(function() {
+ // do your thing here!
+ }, 0);
+
+#### Windows Phone 7 Quirks
+
+Invoking the native camera application while the device is connected
+via Zune does not work, and triggers an error callback.
+
+#### Tizen Quirks
+
+Tizen only supports a `destinationType` of
+`Camera.DestinationType.FILE_URI` and a `sourceType` of
+`Camera.PictureSourceType.PHOTOLIBRARY`.
+
## CameraOptions
Optional parameters to customize the camera settings.
@@ -190,8 +190,6 @@ Optional parameters to customize the camera settings.
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. The default is 50. _(Number)_ (Note that information about the camera's resolution is unavailable.)
- __destinationType__: Choose the format of the return value. The default is FILE_URI. Defined in `navigator.camera.DestinationType` _(Number)_
@@ -244,7 +242,7 @@ Optional parameters to customize the camera settings.
FRONT : 1 // Use the front-facing camera
};
-### Amazon Fire OS Quirks
+#### Amazon Fire OS Quirks
- Any `cameraDirection` value results in a back-facing photo.
@@ -252,7 +250,7 @@ Optional parameters to customize the camera settings.
- `Camera.PictureSourceType.PHOTOLIBRARY` and `Camera.PictureSourceType.SAVEDPHOTOALBUM` both display the same photo album.
-### Android Quirks
+#### Android Quirks
- Any `cameraDirection` value results in a back-facing photo.
@@ -261,7 +259,7 @@ with the Google Plus Photos application. Other crops may not work.
- `Camera.PictureSourceType.PHOTOLIBRARY` and `Camera.PictureSourceType.SAVEDPHOTOALBUM` both display the same photo album.
-### BlackBerry 10 Quirks
+#### BlackBerry 10 Quirks
- Ignores the `quality` parameter.
@@ -273,7 +271,7 @@ with the Google Plus Photos application. Other crops may not work.
- Ignores the `cameraDirection` parameter.
-### Firefox OS Quirks
+#### Firefox OS Quirks
- Ignores the `quality` parameter.
@@ -293,19 +291,19 @@ with the Google Plus Photos application. Other crops may not work.
- Ignores the `cameraDirection` parameter.
-### iOS Quirks
+#### 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. The contents of the application's temporary directory is deleted when the application ends.
-### Tizen Quirks
+#### Tizen Quirks
- options not supported
- always returns a FILE URI
-### Windows Phone 7 and 8 Quirks
+#### Windows Phone 7 and 8 Quirks
- Ignores the `allowEdit` parameter.
@@ -327,7 +325,7 @@ onError callback function that provides an error message.
// Show a helpful message
}
-### Parameters
+#### Description
- __message__: The message is provided by the device's native code. _(String)_
@@ -340,11 +338,11 @@ onSuccess callback function that provides the image data.
// Do something with the image
}
-### Parameters
+#### Description
- __imageData__: Base64 encoding of the image data, _or_ the image file URI, depending on `cameraOptions` in effect. _(String)_
-### Example
+#### Example
// Show image
//
@@ -358,23 +356,15 @@ onSuccess callback function that provides the image data.
A handle to the popover dialog created by `navigator.camera.getPicture`.
-### Methods
+#### Description
-- __setPosition__: Set the position of the popover.
+- __setPosition__: Set the position of the popover. Takes the `CameraPopoverOptions` that specify the new position.
-### Supported Platforms
+#### Supported Platforms
-- iOS
+        
-### setPosition
-
-Set the position of the popover.
-
-__Parameters__:
-
-- `cameraPopoverOptions`: the `CameraPopoverOptions` that specify the new position
-
-### Example
+#### Example
var cameraPopoverHandle = navigator.camera.getPicture(onSuccess, onFail,
{ destinationType: Camera.DestinationType.FILE_URI,
@@ -388,7 +378,6 @@ __Parameters__:
cameraPopoverHandle.setPosition(cameraPopoverOptions);
}
-
## CameraPopoverOptions
iOS-only parameters that specify the anchor element location and arrow
@@ -402,7 +391,7 @@ or album.
arrowDir : Camera.PopoverArrowDirection.ARROW_ANY
};
-### CameraPopoverOptions
+#### Description
- __x__: x pixel coordinate of screen element onto which to anchor the popover. _(Number)_
@@ -434,18 +423,18 @@ storage.
navigator.camera.cleanup( cameraSuccess, cameraError );
-### Description
+#### Description
Removes intermediate image files that are kept in temporary storage
after calling `camera.getPicture`. Applies only when the value of
`Camera.sourceType` equals `Camera.PictureSourceType.CAMERA` and the
`Camera.destinationType` equals `Camera.DestinationType.FILE_URI`.
-### Supported Platforms
+#### Supported Platforms
-- iOS
+        
-### Example
+#### Example
navigator.camera.cleanup(onSuccess, onFail);
diff --git a/doc/img/android-fail.png b/doc/img/android-fail.png
new file mode 100644
index 0000000..f9e4e86
Binary files /dev/null and b/doc/img/android-fail.png differ
diff --git a/doc/img/android-success.png b/doc/img/android-success.png
new file mode 100644
index 0000000..0bb9abd
Binary files /dev/null and b/doc/img/android-success.png differ
diff --git a/doc/img/blackberry-fail.png b/doc/img/blackberry-fail.png
new file mode 100644
index 0000000..b89efaf
Binary files /dev/null and b/doc/img/blackberry-fail.png differ
diff --git a/doc/img/blackberry-success.png b/doc/img/blackberry-success.png
new file mode 100644
index 0000000..286d0b9
Binary files /dev/null and b/doc/img/blackberry-success.png differ
diff --git a/doc/img/browser-fail.png b/doc/img/browser-fail.png
new file mode 100644
index 0000000..3894be6
Binary files /dev/null and b/doc/img/browser-fail.png differ
diff --git a/doc/img/browser-success.png b/doc/img/browser-success.png
new file mode 100644
index 0000000..6c2c000
Binary files /dev/null and b/doc/img/browser-success.png differ
diff --git a/doc/img/firefox-fail.png b/doc/img/firefox-fail.png
new file mode 100644
index 0000000..2c6cbd1
Binary files /dev/null and b/doc/img/firefox-fail.png differ
diff --git a/doc/img/firefox-success.png b/doc/img/firefox-success.png
new file mode 100644
index 0000000..deb9d24
Binary files /dev/null and b/doc/img/firefox-success.png differ
diff --git a/doc/img/fireos-fail.png b/doc/img/fireos-fail.png
new file mode 100644
index 0000000..b1e7b9b
Binary files /dev/null and b/doc/img/fireos-fail.png differ
diff --git a/doc/img/fireos-success.png b/doc/img/fireos-success.png
new file mode 100644
index 0000000..7b6289e
Binary files /dev/null and b/doc/img/fireos-success.png differ
diff --git a/doc/img/ios-fail.png b/doc/img/ios-fail.png
new file mode 100644
index 0000000..2d8caf8
Binary files /dev/null and b/doc/img/ios-fail.png differ
diff --git a/doc/img/ios-success.png b/doc/img/ios-success.png
new file mode 100644
index 0000000..3bf3b5a
Binary files /dev/null and b/doc/img/ios-success.png differ
diff --git a/doc/img/ubuntu-fail.png b/doc/img/ubuntu-fail.png
new file mode 100644
index 0000000..ca82c79
Binary files /dev/null and b/doc/img/ubuntu-fail.png differ
diff --git a/doc/img/ubuntu-success.png b/doc/img/ubuntu-success.png
new file mode 100644
index 0000000..b15227d
Binary files /dev/null and b/doc/img/ubuntu-success.png differ
diff --git a/doc/img/windows-fail.png b/doc/img/windows-fail.png
new file mode 100644
index 0000000..982a8cf
Binary files /dev/null and b/doc/img/windows-fail.png differ
diff --git a/doc/img/windows-success.png b/doc/img/windows-success.png
new file mode 100644
index 0000000..b8ae79b
Binary files /dev/null and b/doc/img/windows-success.png differ
diff --git a/doc/img/wp8-fail.png b/doc/img/wp8-fail.png
new file mode 100644
index 0000000..28c4588
Binary files /dev/null and b/doc/img/wp8-fail.png differ
diff --git a/doc/img/wp8-success.png b/doc/img/wp8-success.png
new file mode 100644
index 0000000..a37cad6
Binary files /dev/null and b/doc/img/wp8-success.png differ