From 0b91635caf91b76d304e80997c82fe582b636428 Mon Sep 17 00:00:00 2001 From: Scott Main Date: Thu, 17 Dec 2009 18:01:04 -0800 Subject: [PATCH] docs: add "required" attribute to the docs and add a note to the CAMERA permission stating that it enables the for camera. This is an incrimental update for the 2.0.1 docs. More changes to come for the 2.1 docs to include more features --- core/res/AndroidManifest.xml | 8 +- .../topics/manifest/uses-feature-element.jd | 91 ++++++++++++------- 2 files changed, 63 insertions(+), 36 deletions(-) diff --git a/core/res/AndroidManifest.xml b/core/res/AndroidManifest.xml index 0d03ff2b28fdb..3c35fc7e18930 100644 --- a/core/res/AndroidManifest.xml +++ b/core/res/AndroidManifest.xml @@ -403,7 +403,13 @@ android:label="@string/permlab_recordAudio" android:description="@string/permdesc_recordAudio" /> - + 
 <uses-feature android:glEsVersion="integer"
-              android:name="string" />
+              android:name="string"
+              android:required=["true" | "false"] />
contained in:
-
<manifest>
+
<manifest>
description:
This element declares a specific feature used by the application. Android provides some features that may not be equally supported by all -Android devices. In a manner similar to the <uses-sdk> +Android devices. In a manner similar to the <uses-sdk> element, this element allows an application to specify which device-variable features it uses. In this way, the application will not be installed on devices that do not offer the feature.

@@ -27,14 +30,14 @@ If a device does not provide a camera with auto-focus, then it will not allow installation of the application.

In order to maintain strict device compatibility, it's very important that you use -this element to declare all features that your application uses. Failure to declare -a feature may result your application being installed on a device +this element to declare all applicable features (listed below) that your application uses. Failure +to declare a feature may result in your application being installed on a device that does not support the feature and your application failing.

For some features, there may exist a specfic attribute that allows you to define a version of the feature, such as the version of Open GL used (declared with {@code glEsVersion}). Other features that either do or do not -exist for a device, such as camera auto-focus, are declared using the +exist for a device, such as a camera, are declared using the {@code name} attribute.

Any software or hardware features that may vary among Android-powered @@ -47,13 +50,12 @@ camera, then you should include the following in your {@code AndroidManifest.xml <uses-feature android:name="android.hardware.camera" /> -

If you declare "android.hardware.camera", then your application is considered -compatible with all devices that include a camera, regardless of whether auto-focus is -available or not. If you also use the auto-focus features (available through the {@link -android.hardware.Camera Camera API}), then you need to include an additional -{@code <uses-feature>} element that declares the "android.hardware.camera.autofocus" +

If you declare {@code android.hardware.camera}, then your application is considered +compatible with all devices that include a camera. If your application also uses auto-focus +features, then you also need to include a +{@code <uses-feature>} element that declares the {@code android.hardware.camera.autofocus} feature. Also note that you must still request the {@link android.Manifest.permission#CAMERA -CAMERA permission}. Requesting permission grants your application access to the +CAMERA} permission. Requesting permission grants your application access to the appropriate hardware and software, while declaring the features used by your application ensures proper device compatibility.

@@ -75,50 +77,69 @@ instance of this element.

attributes:
-
{@code android:glEsVersion}
+
+
{@code android:glEsVersion}
The GLES version needed by the application. The higher 16 bits represent the major number and the lower 16 bits represent the minor number. For example, for GL 1.2 referring to 0x00000102, the actual value should be set as 0x00010002.
-
-
-
-
{@code android:name}
+
{@code android:name}
The name of a feature required by the application. The value must be one of the following accepted strings: - - + +
- - + + - - - - + - + + + +
Feature Value Description
Camera
Camera "{@code android.hardware.camera}" The application requires a camera.
"{@code android.hardware.camera.autofocus}"The application requires a camera with auto-focus capability. - As a prerequisite, "{@code android.hardware.camera}" must also be declared - with a separate {@code <uses-feature>} element. -
Note: Any application that requests the - {@link android.Manifest.permission#CAMERA CAMERA permission} but does not + {@link android.Manifest.permission#CAMERA} permission but does not declare any camera features with the {@code <uses-feature>} element will be assumed - to use all camera features (such as auto-focus). Thus, the application will not - be compatible with devices that do not support all features. Please use - {@code <uses-feature>} to declare only the camera features that your - application needs. + to use all camera features (auto-focus and flash). Thus, the application will not + be compatible with devices that do not support all camera features. Please use + {@code <uses-feature>} to declare only the camera features that your + application does need. For instance, if you requests the + {@link android.Manifest.permission#CAMERA} permission, but does not need auto-focus or + flash, then declare only the {@code android.hardware.camera} feature—the camera + features that you do not request will no longer be assumed as required.
Camera auto-focus"{@code android.hardware.camera.autofocus}"The application requires a camera with auto-focus capability. + As a prerequisite, "{@code android.hardware.camera}" must also be declared + with a separate {@code <uses-feature>} element. +
-
+ +
{@code android:required}
+
Indicates whether the feature is required by the application. This is + "true" by default. You should not use this attribute for most cases. +

+ +

The only situation in which you should set this attribute "false" is when your application + requests the {@link android.Manifest.permission#CAMERA} permission, but will degrade gracefully + and perform without failure if the device does not have a camera. In this situation, you must + declare the "{@code android.hardware.camera}" feature and set the {@code required} attribute + "false". This is necessary because the {@link android.Manifest.permission#CAMERA} permission + will automatically turn on the requirement for all camera features. So if your application uses + this permission but is still compatible with devices without a camera, then you must set this + attribute "false" for "{@code android.hardware.camera}" or else it will not install on devices + without a camera. Note that, while the permission will enable the requirement for all + camera features, you only need to off the requirement for the basic camera feature.

+ +
+