Resources | developer.brewmp.com Resources | developer.brewmp.com

Developer

resources

Configure wallpaper settings

The wallpaper.ini configuration file must be customized by the manufacturer to convey accurate information about the device's support for wallpapers. Some of the settings are required to be configured for all devices. Some are optional. The following table shows the settings that are defined for wallpaper and indicates which are required and which are optional. A description of each setting is provided in the second table.

1 [general] Required
2 wpDirs/protected/1=fs:/~0x0102e5fc/ Required
3 wpDirs/unprotected/1=fs:/~0x0102382c/ Optional
4 [displays] Required
5 010127d4/sizeX=240 Required
6 010127d4/sizeY=320 Required
7 010127d4/orientInd=0 Required
8 010127d4/typeActive=0 Required
9 010127d4/config/1/wallpaperActive=fs:/~0x0102e5fc/wp_port.png Required
10 010127d4/config/1/wallpaperPort=fs:/~0x0102e5fc/wp_port.png Required
11 010127d4/config/1/wallpaperLand=fs:/~0x0102e5fc/wp_land.png Required
12 010127d4/formats/1/mimeType=image/png Required
13 010127d4/formats/1/minX=32 Optional
14 010127d4/formats/1/minY=32 Optional
15 010127d4/formats/1/maxX=480 Optional
16 010127d4/formats/1/maxY=640 Optional
17 010127d4/formats/1/maxSize=1024000 Optional
18 010127d4/formats/1/anim=0 Optional
19 010127d4/formats/1/bitDepth=1,2,4,8,16 Optional
20 010127d4/formats/2/mimeType=image/jpg Optional
21 010127d4/formats/3/mimeType=image/jpeg Optional
22 010127d4/formats/4/mimeType=image/bmp Optional
23 010127d5/sizeX=240 Optional
24 010127d5/sizeY=320 Optional
25 010127d5/orientInd=0 Optional
26 010127d5/typeActive=0 Optional
27 010127d5/config/1/wallpaperActive=fs:/~0x0102e5fc/wp_port.png Optional
28 010127d5/config/1/wallpaperPort=fs:/~0x0102e5fc/wp_port.png Optional
29 010127d5/config/1/wallpaperLand=fs:/~0x0102e5fc/wp_land.png Optional
30 010127d5/formats/1/mimeType=image/png Optional
Row Description
1 Section header for general wallpaper settings. Settings in this section apply to the device as a whole. This section header must be present in the wallpaper.ini file.
2 List of one or more protected wallpaper directories on the device (providing some sort of DRM or content protection), in the form of an "fs:/" file path URI. Validation of any content protection methodology is outside of the scope of this feature. Typically, a wallpaper application would save purchased content to these directories, while unprotected content (such as camera images) could be saved to an unprotected directory. It is mandatory to support at least one protected directory for wallpaper content on the device. Any protected directories beyond the first directory are optional. In the example above, the AEEFS_MCF_PICTURE_LOCK_DIR is used as the protected wallpaper directory. MCF directory definitions are listed in AEEMCF.h.
3 List of unprotected wallpaper directories on the device. Typically (as in the example above), the AEEFS_MCF_PICTURE_DIR is used as to store unprotected wallpaper files. Devices are not required to support any unprotected wallpaper directories, but would generally list at least the directory used to store camera images.
4 Section header for display-specific wallpaper settings. Settings in this section apply to a specific display, which is always identified by an 8-digit hexadecimal string representing the ClassID of the display object. This string must be exactly 8 characters long, meaning that it should not be preceded by "0x" and must be padded with leading zeroes as necessary. For example, when AEECLSID_DISPLAY1 = 0x010127d4, the settings key for display 1 should be the string "010127d4". It is mandatory to support at least one display for wallpaper settings on the device.
5 This setting is required for every supported display. sizeX indicates the x dimension of the region in which the wallpaper image is displayed. In many cases, this is the same as the display dimensions, but not necessarily. For example, a device may display wallpapers in a smaller region if an annunciator row or softkey menu bar occupies part of the screen.
6 This setting is required for every supported display. sizeY indicates the y dimension of the region in which the wallpaper image is displayed.
7 This setting is required for every supported display, and must have a value of either '0' (not supported) or '1' (supported). orientInd indicates whether or not wallpapers may be independently configured based on the current orientation of the display. If orientInd has a value of '1', a user could have a wallpaper assigned to be active when the display is in portrait mode, and a different image assigned when the display is in landscape mode. Switching between the two images is the responsibility of the manufacturer's wallpaper-displaying application.
8 This setting is required for every supported display, and must have a value of either '0' (WALLPAPER_PORTRAIT, value defined in AEEIWallpaper.h) or '1' (WALLPAPER_LANDSCAPE). This indicates whether the display is in portrait or landscape mode, and correspondingly whether the portrait or landscape wallpaper is active. This should contain the initial orientation of the display, and the wallpaper-displaying application should modify this setting when the display orientation changes.
9 The active wallpaper setting. This should contain the exact same value as the current landscape or portrait wallpaper (below), based on the value stored in the typeActive setting above. Note that the three wallpaper settings fall under a "config" subtree. Configurations are a means for manufacturers to implement "virtual desktops" on a display, each with its own configured wallpaper setting. If this functionality is not required on the device, simply provide information for the first (default) configuration.
10 The wallpaper resource currently set as the portrait wallpaper. This will usually be an fs:/ URI pointing to an image file within one of the wallpaper directories (protected or unprotected) listed in the wallpaper.ini file above.
11 The wallpaper resource currently set as the landscape wallpaper.
12 The MIME type for this wallpaper format. This will usually correspond to a BREW MIME type handled by the IImage interface. Every display must support at least one format for wallpaper resources, and the MIME type setting is always required for every supported format.

Note: The optional restriction nodes listed below allow the manufacturer to provide details about specific restrictions on wallpapers of this format type. If no such restriction exists, the entire line should be removed from the wallpaper.ini file.

13 This setting indicates whether there is a minimum x dimension for wallpapers of this format on this display.
14 An optional restriction on wallpapers of this format type. This setting indicates whether there is a minimum y dimension for wallpapers of this format on this display.
15 An optional restriction on wallpapers of this format type. This setting indicates whether there is a maximum x dimension for wallpapers of this format on this display.
16 An optional restriction on wallpapers of this format type. This setting indicates whether there is a maximum y dimension for wallpapers of this format on this display.
17 An optional restriction on wallpapers of this format type. This setting indicates whether there is a maximum file size (in bytes) for wallpapers of this format on this display.
18 An optional restriction on wallpapers of this format type. This setting indicates whether animation is supported for wallpapers of this format type, and has the value of '0' (not supported) or '1' (supported).
19 An optional restriction on wallpapers of this format type. This setting contains a comma-separated list of supported bit depths for wallpapers of this format. The list cannot contain spaces, and does not need to be sorted.
20-22 Listing of other supported wallpaper format MIME types. A minimum of one format is required, but all supported formats should be listed.
23-30 Provides settings support for an additional display. Even though this entire section is described as optional here, any mandatory display-specific settings (e.g. sizeX, sizeY) must be listed for all additional supported displays.

MIME type requirements:

  • The device must support at least PNG and JPEG formats for each display that supports wallpaper.

  • manufacturer-defined formats can be defined. The MIME type for such formats should be defined according to the "Vendor Tree" section of RFC4288 (for example, vnd.oemname.fmt, where oemname is the company name of the manufacturer and fmt is the image format). In such cases, the manufacturer must also provide an IImage class that is registered with the Brew MP registry under the same MIME type.

Requirements for the wallpaperActive, wallpaperPort, and wallpaperLand settings:

  • For pre-installed wallpapers, manufacturers should install such files in one of the MCF directories that are indicated in the wpDirs settings.

  • Pre-installed wallpapers may be installed in the persistent file system to prevent deletion. Manufacturers should still use the MCF directories for these files.

  • If it is not possible to install the pre-installed wallpaper image files to the EFS or the persistent file system, the wallpaperActive, wallpaperPort, and wallpaperLand settings keys may be set to a URI beginning with "oem:/". URIs beginning with "oem:/" are manufacturer-defined.