forked from public/cordova-plugin-camera
added tests + docs
This commit is contained in:
Steven Gill
@@ -0,0 +1,136 @@
|
||||
---
|
||||
license: Licensed to the Apache Software Foundation (ASF) under one
|
||||
or more contributor license agreements. See the NOTICE file
|
||||
distributed with this work for additional information
|
||||
regarding copyright ownership. The ASF licenses this file
|
||||
to you under the Apache License, Version 2.0 (the
|
||||
"License"); you may not use this file except in compliance
|
||||
with the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing,
|
||||
software distributed under the License is distributed on an
|
||||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
KIND, either express or implied. See the License for the
|
||||
specific language governing permissions and limitations
|
||||
under the License.
|
||||
---
|
||||
|
||||
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 saved image. Range is [0, 100]. (`Number`)
|
||||
|
||||
- __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 (eg. assets-library:// on iOS or content:// on Android)
|
||||
};
|
||||
|
||||
- __sourceType:__ Set the source of the picture. Defined in nagivator.camera.PictureSourceType (`Number`)
|
||||
|
||||
Camera.PictureSourceType = {
|
||||
PHOTOLIBRARY : 0,
|
||||
CAMERA : 1,
|
||||
SAVEDPHOTOALBUM : 2
|
||||
};
|
||||
|
||||
- __allowEdit:__ Allow simple editing of image before selection. (`Boolean`)
|
||||
|
||||
- __encodingType:__ Choose the encoding of the returned image file. 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 is maintained. (`Number`)
|
||||
- __targetHeight:__ Height in pixels to scale image. Must be used with targetWidth. Aspect ratio is maintained. (`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 to specify popover location in iPad. Defined in CameraPopoverOptions.
|
||||
- __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.PictureSourceType.PHOTOLIBRARY and Camera.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 native Camera application after photo is taken.
|
||||
- Using Large image sizes may result in inability to encode image on later model devices with high resolution cameras (e.g. Torch 9800).
|
||||
- Camera.MediaType is not supported.
|
||||
- Ignores the `correctOrientation` parameter.
|
||||
- Ignores the `cameraDirection` parameter.
|
||||
|
||||
webOS Quirks
|
||||
-----------
|
||||
|
||||
- Ignores the `quality` parameter.
|
||||
- Ignores the `sourceType` parameter.
|
||||
- Ignores the `allowEdit` parameter.
|
||||
- Camera.MediaType is not supported.
|
||||
- Ignores the `correctOrientation` parameter.
|
||||
- Ignores the `saveToPhotoAlbum` parameter.
|
||||
- Ignores the `cameraDirection` parameter.
|
||||
|
||||
iOS Quirks
|
||||
--------------
|
||||
|
||||
- Set `quality` below 50 to avoid memory error on some devices.
|
||||
- When `destinationType.FILE_URI` is used, photos are saved in the application's temporary directory.
|
||||
|
||||
Windows Phone 7 and 8 Quirks
|
||||
--------------
|
||||
|
||||
- Ignores the `allowEdit` parameter.
|
||||
- Ignores the `correctOrientation` parameter.
|
||||
- Ignores the `cameraDirection` parameter.
|
||||
|
||||
Bada 1.2 Quirks
|
||||
--------------
|
||||
- options not supported
|
||||
- always returns a FILE URI
|
||||
|
||||
Tizen Quirks
|
||||
--------------
|
||||
- options not supported
|
||||
- always returns a FILE URI
|
||||
Reference in New Issue
Block a user