mirror of
https://github.com/apache/cordova-plugin-camera.git
synced 2025-01-19 03:42:52 +08:00
f20dfae735
Moved docs to jsdocs comments in the code, removed redundancy. Moved Quirks and extra examples to errata sections of the docs TEMPLATE.md, linked the jsdoc comments to these sections. Added dependencies to common plugin docs template and husky (precommit hook to regen the docs automatically). Added gen-docs command to re-generate the docs. Extended TOC manually [to include classes containing only one member](https://github.com/jsdoc2md/jsdoc-to-markdown/issues/34) (CameraPopoverHandle and CameraPopoverOptions). Extended the docs via DMD template to include "Installation", "How to contribute" and "Docs are generated" warning. github: close #129
89 lines
2.3 KiB
JavaScript
89 lines
2.3 KiB
JavaScript
/*
|
|
*
|
|
* 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.
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* @module Camera
|
|
*/
|
|
module.exports = {
|
|
/**
|
|
* @enum {number}
|
|
*/
|
|
DestinationType:{
|
|
/** Return base64 encoded string */
|
|
DATA_URL: 0,
|
|
/** Return file uri (content://media/external/images/media/2 for Android) */
|
|
FILE_URI: 1,
|
|
/** Return native uri (eg. asset-library://... for iOS) */
|
|
NATIVE_URI: 2
|
|
},
|
|
/**
|
|
* @enum {number}
|
|
*/
|
|
EncodingType:{
|
|
/** Return JPEG encoded image */
|
|
JPEG: 0,
|
|
/** Return PNG encoded image */
|
|
PNG: 1
|
|
},
|
|
/**
|
|
* @enum {number}
|
|
*/
|
|
MediaType:{
|
|
/** Allow selection of still pictures only. DEFAULT. Will return format specified via DestinationType */
|
|
PICTURE: 0,
|
|
/** Allow selection of video only, ONLY RETURNS URL */
|
|
VIDEO: 1,
|
|
/** Allow selection from all media types */
|
|
ALLMEDIA : 2
|
|
},
|
|
/**
|
|
* @enum {number}
|
|
*/
|
|
PictureSourceType:{
|
|
/** Choose image from picture library (same as SAVEDPHOTOALBUM for Android) */
|
|
PHOTOLIBRARY : 0,
|
|
/** Take picture from camera */
|
|
CAMERA : 1,
|
|
/** Choose image from picture library (same as PHOTOLIBRARY for Android) */
|
|
SAVEDPHOTOALBUM : 2
|
|
},
|
|
/**
|
|
* Matches iOS UIPopoverArrowDirection constants to specify arrow location on popover.
|
|
* @enum {number}
|
|
*/
|
|
PopoverArrowDirection:{
|
|
ARROW_UP : 1,
|
|
ARROW_DOWN : 2,
|
|
ARROW_LEFT : 4,
|
|
ARROW_RIGHT : 8,
|
|
ARROW_ANY : 15
|
|
},
|
|
/**
|
|
* @enum {number}
|
|
*/
|
|
Direction:{
|
|
/** Use the back-facing camera */
|
|
BACK: 0,
|
|
/** Use the front-facing camera */
|
|
FRONT: 1
|
|
}
|
|
};
|