AIR application descriptor elements

Content

true or false (default)

Example

<allowBrowserInvocation>true</allowBrowserInvocation>

Content

Elements defining the Android-specific properties to add to the Android application manifest.

Example

<android> 
    <manifestAdditions> 
        ... 
    </manifestAdditions> 
</android>

Attributes

minimumPatchLevel — The AIR runtime minimum patch level required by this application.

xmlns — the XML namespace attribute determines the required AIR runtime version of the application.

The namespace changes with each major release of AIR (but not with minor patches). The last segment of the namespace, such as “3.0,” indicates the runtime version required by the application.

The xmlns values for the major AIR releases are:

xmlns="http://ns.adobe.com/air/application/1.0" 
xmlns="http://ns.adobe.com/air/application/1.1" 
xmlns="http://ns.adobe.com/air/application/1.5" 
xmlns="http://ns.adobe.com/air/application/1.5.2" 
xmlns="http://ns.adobe.com/air/application/1.5.3" 
xmlns="http://ns.adobe.com/air/application/2.0" 
xmlns="http://ns.adobe.com/air/application/2.5" 
xmlns="http://ns.adobe.com/air/application/2.6" 
xmlns="http://ns.adobe.com/air/application/2.7" 
xmlns="http://ns.adobe.com/air/application/3.0" 
xmlns="http://ns.adobe.com/air/application/3.1" 
xmlns="http://ns.adobe.com/air/application/3.2" 
xmlns="http://ns.adobe.com/air/application/3,3" 
xmlns="http://ns.adobe.com/air/application/3.4" 
xmlns="http://ns.adobe.com/air/application/3.5" 
xmlns="http://ns.adobe.com/air/application/3.6" 
xmlns="http://ns.adobe.com/air/application/3.7"

For SWF-based applications, the AIR runtime version specified in the application descriptor determines the maximum SWF version that can be loaded as the initial content of the application. Applications that specify AIR 1.0 or AIR 1.1 can only use SWF9 (Flash Player 9) files as initial content — even when run using the AIR 2 runtime. Applications that specify AIR 1.5 (or later) can use either SWF9 or SWF10 (Flash Player 10) files as initial content.

The SWF version determines which version of the AIR and Flash Player APIs are available. If a SWF9 file is used as the initial content of an AIR 1.5 application, that application will only have access to the AIR 1.1 and Flash Player 9 APIs. Furthermore, behavior changes made to existing APIs in AIR 2.0 or Flash Player 10.1 will not be effective. (Important security-related changes to APIs are an exception to this principle and can be applied retroactively in present or future patches of the runtime.)

For HTML-based applications, the runtime version specified in the application descriptor determines which version of the AIR and Flash Player APIs are available to the application. The HTML, CSS, and JavaScript behaviors are always determined by the version of Webkit used in the installed AIR runtime, not by the application descriptor.

When an AIR application loads SWF content, the version of the AIR and Flash Player APIs available to that content depends on how the content is loaded. Sometimes the effective version is determined by the application descriptor namespace, sometimes it is determined by the version of the loading content, and sometimes it is determined by the version of the loaded content. The following table shows how the API version is determined based on the loading method:

When loading a SWF file of a different version than the loading content, you can run into the two problems:

• Loading a newer version SWF by an older version SWF— References to APIs added in the newer versions of AIR and Flash Player in the loaded content will be unresolved

• Loading an older version SWF by a newer version SWF — APIs changed in the newer versions of AIR and Flash Player may behave in ways that the loaded content does not expect.

Content

The application element contains child elements that define the properties of an AIR application.

Example

<?xml version="1.0" encoding="utf-8" ?> 
<application xmlns="http://ns.adobe.com/air/application/3.0"> 
    <id>HelloWorld</id> 
    <version>2.0</version> 
    <filename>Hello World</filename> 
    <name>Example Co. AIR Hello World</name> 
     <description> 
        <text xml:lang="en">This is an example.</text> 
        <text xml:lang="fr">C'est un exemple.</text> 
        <text xml:lang="es">Esto es un ejemplo.</text> 
    </description> 
    <copyright>Copyright (c) 2010 Example Co.</copyright> 
    <initialWindow> 
        <title>Hello World</title> 
        <content> 
            HelloWorld.swf 
        </content> 
        <systemChrome>none</systemChrome> 
        <transparent>true</transparent> 
        <visible>true</visible> 
        <minSize>320 240</minSize> 
    </initialWindow>  
    <installFolder>Example Co/Hello World</installFolder> 
    <programMenuFolder>Example Co</programMenuFolder> 
    <icon> 
        <image16x16>icons/smallIcon.png</image16x16> 
        <image32x32>icons/mediumIcon.png</image32x32> 
        <image48x48>icons/bigIcon.png</image48x48> 
        <image128x128>icons/biggestIcon.png</image128x128>  
    </icon> 
    <customUpdateUI>true</customUpdateUI> 
    <allowBrowserInvocation>false</allowBrowserInvocation> 
    <fileTypes> 
        <fileType> 
            <name>adobe.VideoFile</name> 
            <extension>avf</extension> 
            <description>Adobe Video File</description> 
            <contentType>application/vnd.adobe.video-file</contentType> 
            <icon> 
                <image16x16>icons/avfIcon_16.png</image16x16> 
                <image32x32>icons/avfIcon_32.png</image32x32> 
                <image48x48>icons/avfIcon_48.png</image48x48> 
                <image128x128>icons/avfIcon_128.png</image128x128> 
            </icon> 
        </fileType> 
    </fileTypes> 
</application>

Content

portrait, landscape, or any

Example

<aspectRatio>landscape</aspectRatio>

Content

true or false (default)

Example

<autoOrients>true</autoOrients>

Content

One of the following values:

• 16bit

• 32bit

Example

<android> 
    <colorDepth>16bit</colorDepth> 
    <manifestAdditions>...</manifestAdditions> 
</android>

Content

One of the following values:

• true

• false

Example

<android> 
    <containsVideo>true</containsVideo> 
    <manifestAdditions>...</manifestAdditions> 
</android>

Content

A URL relative to the application directory. Because the value of the content element is treated as a URL, characters in the name of the content file must be URL encoded according to the rules defined in RFC 1738. Space characters, for example, must be encoded as %20.

Example

<content>TravelPlanner.swf</content>

Content

The MIME type and subtype. See RFC2045 for more information about MIME types.

Example

<contentType>text/plain</contentType>

Content

A string containing the application copyright information.

Example

<copyright>© 2010, Examples, Inc.All rights reserved.</copyright>

Content

true or false (default)

Example

<customUpdateUI>true</customUpdateUI>

Content

true or false (default)

Example

<depthAndStencil>true</depthAndStencil>

Content

The AIR 1.0 application descriptor schema allows only one simple text node to be defined for the name (not multiple text elements).

In AIR 1.1 (or above), you can specify multiple languages in the description element. The xml:lang attribute for each text element specifies a language code, as defined in RFC4646 (http://www.ietf.org/rfc/rfc4646.txt).

Example

Description with simple text node:

<description>This is a sample AIR application.</description> 

Description with localized text elements for English, French, and Spanish (valid in AIR 1.1 and later):

<description> 
    <text xml:lang="en">This is an example.</text> 
    <text xml:lang="fr">C'est un exemple.</text> 
    <text xml:lang="es">Esto es un ejemplo.</text> 
</description> 

Content

A string describing the file contents.

Example

<description>PNG image</description>

Content

The embedFonts element may contain any number of font elements.

Example

<embedFonts> 
   <font> 
      <fontPath>ttf/space age.ttf</fontPath>
      <fontName>space age</fontName> 
   </font>
   <font> 
      <fontPath>ttf/xminus.ttf</fontPath>
      <fontName>xminus</fontName> 
   </font>
</embedFonts>

Content

Contains child elements specifying key-value pairs to use as Entitlements.plist settings for the application. Content of the Entitlements element should be enclosed in a CDATA block. For more information, see the Entitlement Key Reference in the iOS Developer Library.

Example

<iphone> 
... 
   <Entitlements> 
      <![CDATA[ 
         <key>aps-environment</key> 
         <string>development</string> 
      ]]> 
   </Entitlements> 
</iphone>

Content

A string identifying the file extension characters (without the dot, “.”).

Example

<extension>png</extension>

Content

A string identifying the ActionScript extension ID.

Example

<extensionID>com.example.extendedFeature</extensionID>

Content

Child extensionID elements containing the ActionScript extension IDs from the extension descriptor file.

Example

<extensions> 
    <extensionID>extension.first</extensionID> 
    <extensionID>extension.next</extensionID> 
    <extensionID>extension.last</extensionID> 
</extensions>

Content

Name of a text file that contains a line-delimited list of SWFs to be remotely hosted.

Attributes:

None.

Examples

iOS:

<iPhone> 
    <externalSwfs>FileContainingListofSWFs.txt</externalSwfs> 
</iPhone>

Content

The filename property can contain any Unicode (UTF-8) character except the following, which are prohibited from use as filenames on various file systems:

The filename value cannot end in a period.

Example

<filename>MyApplication</filename>

Content

Elements describing a file type.

Example

<fileType> 
    <name>foo.example</name> 
    <extension>foo</extension> 
    <description>Example file type</description> 
    <contentType>text/plain</contentType> 
    <icon> 
        <image16x16>icons/fooIcon16.png</image16x16> 
        <image48x48>icons/fooIcon48.png</imge48x48> 
    <icon> 
</fileType>

Content

The fileTypes element may contain any number of fileType elements.

Example

<fileTypes> 
    <fileType> 
        <name>adobe.VideoFile</name> 
        <extension>avf</extension> 
        <description>Adobe Video File</description> 
        <contentType>application/vnd.adobe.video-file</contentType> 
        <icon> 
            <image16x16>icons/AIRApp_16.png</image16x16>       
            <image32x32>icons/AIRApp_32.png</image32x32>       
            <image48x48>icons/AIRApp_48.png</image48x48>      
            <image128x128>icons/AIRApp_128.png</image128x128> 
        </icon> 
    </fileType> 
</fileTypes>

Content

Elements specifying the custom font name and its path.

Example

<font> 
   <fontPath>ttf/space age.ttf</fontPath>
   <fontName>space age</fontName> 
</font>

Content

Name of the custom font to be specified in StageText.fontFamily

Example

<fontName>space age</fontName> 

Content

Path of the custom font file (with respect to the source).

Example

<fontPath>ttf/space age.ttf</fontPath> 

Content

Space-separated list of device model names.

Attributes:

None.

Examples

iOS:

... 
<renderMode>GPU</renderMode> 
... 
<iPhone> 
... 
   <forceCPURenderModeForDevices>iPad1,1 iPhone1,1 iPhone1,2 iPod1,1 
   </forceCPURenderModeForDevices> 
</iPhone>

Content

true or false (default)

Example

<fullscreen>true</fullscreen>

Content

A positive integer with a maximum value of 4095.

Example

<height>4095</height>

Content

An imageNxN element for each desired icon size.

Example

<icon> 
    <image16x16>icons/smallIcon.png</image16x16> 
    <image32x32>icons/mediumIcon.png</image32x32> 
    <image48x48>icons/bigIcon.png</image48x48> 
    <image128x128>icons/biggestIcon.png</image128x128>  
</icon>

Content

The ID value is restricted to the following characters:

• 0–9

• a–z

• A–Z

• . (dot)

• - (hyphen)

The value must contain 1 to 212 characters. This element is required.

Example

<id>org.example.application</id>

Content

The file path to the icon can contain any Unicode (UTF-8) character except the following, which are prohibited from use as filenames on various file systems:

Example

<image32x32>icons/icon32.png</image32x32>

Content

Contains child elements specifying key-value pairs to use as Info.plist settings for the application. Content of the InfoAdditions element should be enclosed in a CDATA block.

See Information Property List Key Reference in the Apple iPhone Reference Library for information about the key value pairs and how to express them in XML.

Example

<InfoAdditions> 
    <![CDATA[ 
        <key>UIStatusBarStyle</key> 
        <string>UIStatusBarStyleBlackOpaque</string> 
        <key>UIRequiresPersistentWiFi</key> 
        <string>NO</string> 
    ]]> 
</InfoAdditions>

Content

Child elements defining the application appearance and behavior.

Example

<initialWindow> 
    <title>Hello World</title> 
    <content> 
        HelloWorld.swf 
    </content> 
    <depthAndStencil>true</depthAndStencil> 
    <systemChrome>none</systemChrome> 
    <transparent>true</transparent> 
    <visible>true</visible> 
    <maxSize>1024 800</maxSize> 
    <minSize>320 240</minSize> 
    <maximizable>false</maximizable> 
    <minimizable>false</minimizable> 
    <resizable>true</resizable> 
    <x>20</x> 
    <y>20</y> 
    <height>600</height> 
    <width>800</width> 
    <aspectRatio>landscape</aspectRatio> 
    <autoOrients>true</autoOrients> 
    <fullScreen>false</fullScreen> 
    <renderMode>direct</renderMode> 
</initialWindow>

Content

The installFolder property can contain any Unicode (UTF-8) character except those that are prohibited from use as folder names on various file systems (see the filename property for the list of exceptions).

Use the forward-slash (/) character as the directory separator character if you want to specify a nested subdirectory.

Example

<installFolder>utilities/toolA</installFolder>

Content

The manifest element is not, technically speaking, a part of the AIR application descriptor schema. It is the root of the Android manifest XML document. Any content that you put within the manifest element must conform to the AndroidManifest.xml schema. When you generate an APK file with the AIR tools, information in the manifest element is copied into the corresponding part of the generated AndroidManifest.xml of the application.

If you specify Android manifest values that are only available in an SDK version more recent than that directly supported by AIR, then you must set the ‑platformsdk flag to ADT when packaging the app. Set the flag to the file system path to a version of Android SDK which supports the values that you are adding.

The manifest element itself must be enclosed in a CDATA block within the AIR application descriptor.

Example

<![CDATA[      
    <manifest android:sharedUserID="1001"> 
        <uses-permission android:name="android.permission.CAMERA"/> 
        <uses-feature android:required="false" android:name="android.hardware.camera"/> 
        <application     android:allowClearUserData="true" 
                    android:enabled="true" 
                    android:persistent="true"/> 
    </manifest> 
]]>

Content

Information in the manifestAdditions element is added to the AndroidManifest XML document.

AIR sets several manifest entries in the generated Android manifest document to ensure that application and runtime features work correctly. You cannot override the following settings:

You cannot set the following attributes of the manifest element:

• package

• android:versionCode

• android:versionName

You cannot set the following attributes for the main activity element:

• android:label

• android:icon

You cannot set the following attributes of the application element:

• android:theme

• android:name

• android:label

• android:windowSoftInputMode

• android:configChanges

• android:screenOrientation

• android:launchMode

Example

<manifestAdditions> 
    <![CDATA[      
        <manifest android:installLocation="preferExternal"> 
            <uses-permission android:name="android.permission.INTERNET"/> 
            <application     android:allowClearUserData="true" 
                        android:enabled="true" 
                        android:persistent="true"/> 
        </manifest> 
    ]]> 
</manifestAdditions>

Content

true (default) or false

Example

<maximizable>false</maximizable>

Content

Two integers representing the maximum width and height, separated by whites pace.

Example

<maxSize>1024 360</maxSize>

Content

true (default) or false

Example

<minimizable>false</minimizable>

Content

Two integers representing the minimum width and height, separated by whites pace. Note that the minimum size imposed by the operating system takes precedence over the value set in the application descriptor.

Example

<minSize>120 60</minSize>

Content

If you specify a single text node (instead of multiple <text> elements), the AIR application installer uses this name, regardless of the system language.

The AIR 1.0 application descriptor schema allows only one simple text node to be defined for the name (not multiple text elements). In AIR 1.1 (or above), you can specify multiple languages in the name element.

The xml:lang attribute for each text element specifies a language code, as defined in RFC4646 (http://www.ietf.org/rfc/rfc4646.txt).

The AIR application installer uses the name that most closely matches the user interface language of the user’s operating system. For example, consider an installation in which the name element of the application descriptor file includes a value for the en (English) locale. The AIR application installer uses the en name if the operating system identifies en (English) as the user interface language. It also uses the en name if the system user interface language is en-US (U.S. English). However, if the user interface language is en-US and the application descriptor file defines both en-US and en-GB names, then the AIR application installer uses the en-US value. If the application defines no name that matches the system user interface languages, the AIR application installer uses the first name value defined in the application descriptor file.

The name element only defines the application title used in the AIR application installer. The AIR application installer supports multiple languages: Traditional Chinese, Simplified Chinese, Czech, Dutch, English, French, German, Italian, Japanese, Korean, Polish, Brazilian Portuguese, Russian, Spanish, Swedish, and Turkish. The AIR application installer selects its displayed language (for text other than the application title and description) based on the system user interface language. This language selection is independent of the settings in the application descriptor file.

The name element does not define the locales available for the running, installed application. For details on developing multi-language applications, see Localizing AIR applications.

Example

The following example defines a name with a simple text node:

<name>Test Application</name> 

The following example, valid in AIR 1.1 and later, specifies the name in three languages (English, French, and Spanish) using <text> element nodes:

<name> 
    <text xml:lang="en">Hello AIR</text> 
    <text xml:lang="fr">Bonjour AIR</text> 
    <text xml:lang="es">Hola AIR</text> 
</name> 

Content

A string representing the name of the file type.

Example

<name>adobe.VideoFile</name>

Content

The string used for the programMenuFolder value can contain any Unicode (UTF-8) character except those that are prohibited from use as folder names on various file systems (see the filename element for the list of exceptions). Do not use a forward slash (/) character as the last character of this value.

Example

<programMenuFolder>Example Company/Sample Application</programMenuFolder>

Content

A publisher ID string.

Example

<publisherID>B146A943FBD637B68C334022D304CEA226D129B4.1</publisherID>

Content

One of the following values:

• auto (default) — currently falls back to CPU mode.

• cpu — hardware acceleration is not used.

• direct — rendering composition occurs in the CPU; blitting uses the GPU. Available in AIR 3+.

  Note: In order to leverage GPU acceleration of Flash content with AIR for mobile platforms, Adobe recommends that you use renderMode="direct" (that is, Stage3D) rather than renderMode="gpu". Adobe officially supports and recommends the following Stage3D based frameworks: Starling (2D) and Away3D (3D). For more details on Stage3D and Starling/Away3D, see http://gaming.adobe.com/getstarted/.

• gpu — hardware acceleration is used, if available.

  Important: Do not use GPU rendering mode for Flex applications.

Example

<renderMode>direct</renderMode>

Content

Either standard, the default, or high.

Attribute:

excludeDevices — a space-separated list of iOS model names or model name prefixes. This allows the developer to have some devices use high resolution and others use standard resolution. This attribute is only available on iOS (the requestedDisplayResolution element is nested in the iPhone element). The excludeDevices attribute is available in AIR 3.6 and later.

For any device whose model name is specified in this attribute, the requestedDisplayResolution value is the opposite of the specified value. In other words, if the requestedDisplayResolution value is high, the excluded devices use standard resolution. If the requestedDisplayResolution value is standard, the excluded devices use high resolution.

The values are iOS device model names or model name prefixes. For example, the value iPad3,1 refers specificially to a Wi-Fi 3rd-generation iPad (but not GSM or CDMA 3rd-generation iPads). Alternatively, the value iPad3 refers to any 3rd-generation iPad. An unofficial list of iOS model names is available at the iPhone wiki Models page.

Examples

Desktop:

<initialWindow> 
    <requestedDisplayResolution>high</requestedDisplayResolution> 
</initialWindow>

iOS:

<iPhone> 
    <requestedDisplayResolution excludeDevices="iPad3 iPad4">high</requestedDisplayResolution> 
</iPhone>

Content

true (default) or false

Example

<resizable>false</resizable>

Content

Either none or pan. The default value is pan.

Example

<softKeyboardBehavior>none</softKeyboardBehavior>

Content

A space delimited list of supported languages. Valid language values are ISO 639‑1 values for the languages supported by the AIR runtime: en, de, es, fr, it, ja, ko, pt, ru, cs, nl, pl, sv, tr, zh, da, nb, iw.

The packager generates an error for an empty value for the <supportedLanguages> element.

Example

<supportedLanguages>en ja fr es</supportedLanguages>

Content

You can include any of these values in the supportedProfiles element:

The supportedProfiles property is optional. When you do not include this element in the application descriptor file, the application can be compiled and deployed for any profile.

To specify multiple profiles, separate each with a space character. For example, the following setting specifies that the application is only available in the desktop and extended profiles:

<supportedProfiles>desktop extendedDesktop</supportedProfiles>

Example

<supportedProfiles>desktop mobileDevice</supportedProfiles>

Content

One of the following values:

• none — No system chrome is provided. The application (or an application framework such as Flex) is responsible for displaying window chrome.

• standard (default) — System chrome is provided by the operating system.

Example

<systemChrome>standard</systemChrome>

Content

An xml:lang attribute specifying a locale and a string of localized text.

Example

<text xml:lang="fr">Bonjour AIR</text>

Content

A string containing the window title.

Example

<title>Example Window Title</title>

Content

true or false (default)

Example

<transparent>true</transparent>

Content

A string containing the application version.

Example

<version>0.1 Alpha</version>

Content

A string containing the publicly displayed version text.

Example

<versionLabel>0.9 Beta</versionlabel>

Content

The version number can contain a sequence of up to three integers separated by periods. Each integer must be a number between 0 and 999 (inclusive).

Examples

<versionNumber>1.0.657</versionNumber> 
 
<versionNumber>10</versionNumber> 
 
<versionNumber>0.01</versionNumber>

Content

true or false (default)

Example

<visible>true</visible>

Content

A positive integer with a maximum value of 4095.

Example

<width>1024</width>

Content

An integer value.

Example

<x>120</x>

Content

An integer value.

Example

<y>250</y>