Click here to Skip to main content
Click here to Skip to main content

How To Create Android Live Wallpaper

, 20 Mar 2012
Rate this:
Please Sign up or sign in to vote.
Step-by-step Android Live Wallpaper creation guide for absolute beginners

Introduction

Starting with Android 2.1. (API Level 7), developers can create live wallpapers - richer, animated, interactive backgrounds - on their home screens. A live wallpaper is very similar to a normal Android application: you can create menu with settings, use SGL and OpenGL for drawing, accelerometer, etc.

In this article, I want to demonstrate how to create live wallpaper from scratch. Step-by-step, we will create live wallpaper that would output TV test pattern on out home screen. Just like on real TV during night hours!

This article will highlight the following aspects of Live Wallpaper development:

  1. Drawing on graphic primitives (circles, rectangles) using android.graphics.Canvas class
  2. Developing of applications for screens with different resolution and orientation
  3. Creation of settings dialog for live wallpaper
  4. Reading of variables values for resource XML file
  5. Actual creation of live wallpaper for Android

Background

In this article, I show how to create a very simple live wallpaper.

On the internet, you can find much more profound and cooler apps, but I want you to check the following examples:

Using the Code

1. Making Android Virtual Device

As I mentioned earlier, we have to create an appropriate Android Virtual Device (AVD) to run our application.

Open Android SDK and AVD manager.

And create AVD with the following capabilities:

  1. Target platform Android 2.1 or higher
  2. With accelerometer support (we will add support for screen rotation detection)
  3. Touch-screen support

Resolution might be any. Our application will detect screen resolution and rescale graphic elements if necessary.

2. Creating Project Files

I named the app as LiveWallpaper.

When creating Android project, set Build Target as Android 2.1.

By default, project will be created with the following files:

We have to change them slightly and add new files that would contain values for application's variables.

First, delete layout folder and main.xml file in res directory. This file is used for creating layout for application controls which we won't use in our project.

Instead of this, create folder xml where we will create two files livewallpaper.xml and livewallpaper_settings.xml that will contain values for live wallpaper service and settings dialog.

Livewallpaper.xml contains the following data:

<?xml version="1.0" encoding="utf-8"?>
<wallpaper xmlns:android="http://schemas.android.com/apk/res/android"
    android:settingsActivity="ca.jvsh.livewallpaper.LiveWallpaperSettings"
    android:thumbnail="@drawable/icon"/>

Where wallpaper tag says that we are creating live wallpaper service. This file will be processed during apk file creation.

Livewallpaper_settings.xml contains description of available settings for our live wallpaper:

<?xml version="1.0" encoding="utf-8"?>
<PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android"
    android:title="@string/livewallpaper_settings"
    android:key="livewallpaper_settings">

    <ListPreference
        android:key="livewallpaper_testpattern"
        android:title="@string/livewallpaper_settings_title"
        android:summary="@string/livewallpaper_settings_summary"
        android:entries="@array/livewallpaper_testpattern_names"
        android:entryValues="@array/livewallpaper_testpattern_prefix"/>
    <CheckBoxPreference android:key="livewallpaper_movement"
        android:summary="@string/livewallpaper_movement_summary"
        android:title="@string/livewallpaper_movement_title"
        android:summaryOn="Moving test pattern"
        android:summaryOff="Still test pattern"/>
</PreferenceScreen>

Where tag ListPreference shows that we provide user option to choose between several items and the tag CheckBoxPreference shows that we have check box (Yes/No) option.

File strings.xml in values folder contains all strings values that we are using in our project.

<?xml version="1.0" encoding="utf-8"?>
<resources xmlns:xliff="urn:oasis:names:tc:xliff:document:1.2">
    <!-- General -->
    <skip />
    <!-- Application name -->
    <string name="app_name">Live Wallpaper</string>

    <string name="livewallpaper_settings">Settings</string>
    <string name="livewallpaper_settings_title">Select test pattern</string>
    <string name="livewallpaper_settings_summary">
		Choose which test pattern to display</string>
    <string name="livewallpaper_movement_title">Motion</string>
    <string name="livewallpaper_movement_summary">
		Apply movement to test pattern</string>
</resources>

You can modify this file during localization of your software.

Also in project, you will find testpattern.xml file. This file contains TV test patterns names and colors that they are using (TV test patterns mostly consist of rectangles).

3. Let's Explore the Code!

You can check the code in the project file I've provided. I will just show the important points.

How to detect screen size and orientation?

You have to use DisplayMetrics class!

DisplayMetrics metrics = new DisplayMetrics();
Display display = ((WindowManager) getSystemService(WINDOW_SERVICE)).getDefaultDisplay();
display.getMetrics(metrics);

mRectFrame = new Rect(0, 0, metrics.widthPixels, metrics.heightPixels);


int rotation = display.getOrientation();
if(rotation == Surface.ROTATION_0 || rotation == Surface.ROTATION_180)
    mHorizontal = false;
else
    mHorizontal = true;

How to draw a gradient?

You should use GradientDrawable class!

private Rect                mGradientRect;
GradientDrawable            mGradient;

mGradientRect = new Rect(10,10, 40, 40);
mGradient = new GradientDrawable(Orientation.LEFT_RIGHT, new int[] 
		{ 0xff050505, 0xfffdfdfd });
mGradient.setBounds(mGradientRect);
mGradient.draw(c);

Check out this code:

public void onSharedPreferenceChanged(SharedPreferences prefs,
        String key)
{
    mShape = prefs.getString("livewallpaper_testpattern", "smpte");
    mMotion = prefs.getBoolean("livewallpaper_movement", true);
    readColors();
}

private void readColors()
{
    int pid = getResources().getIdentifier(mShape + "colors", "array", getPackageName());

    rectColor = getResources().getIntArray(pid);
    mRectCount = rectColor.length;
    mColorRectangles = new Rect[mRectCount];

    System.out.println("mRectCount "+mRectCount);
    initFrameParams();
}

Those functions are called when we change our settings.

In readColors() function, we are reading color values from resources (testpatterns.xml file).

4. Editing AndroidManifest.xml

Proving a proper AndroidManifest.xml file is a crucial point if you want your app to be accepted at Android Market.

In our project, Android Manifest looks as follows:

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="ca.jvsh.livewallpaper"
    android:versionName="1.0.20100908.1"
    android:versionCode="1">

    <uses-sdk android:minSdkVersion="7" />
    <uses-feature android:name="android.software.live_wallpaper" />

    <application android:icon="@drawable/icon"
        android:label="@string/app_name"
        android:permission="android.permission.BIND_WALLPAPER">

        <service android:name=".LiveWallpaper"
            android:label="@string/app_name"
            android:icon="@drawable/icon">

            <intent-filter>
                <action android:name="android.service.wallpaper.WallpaperService" />
            </intent-filter>
            <meta-data android:name="android.service.wallpaper"
                android:resource="@xml/livewallpaper" />

        </service>

        <activity android:label="@string/livewallpaper_settings"
            android:name=".LiveWallpaperSettings"
            android:theme="@android:style/Theme.Light.WallpaperSettings"
            android:exported="true"
            android:icon="@drawable/icon">
        </activity>

    </application>
</manifest>

It is very important to set up android:permission="android.permission.BIND_WALLPAPER" because this will allow the wallpaper to stay on your home screen.

5. Result

 

Points of Interest

Android live wallpapers are supported only on Android 2.1. (API level 7) and higher versions of the platform. To ensure that your application can only be installed on devices that support live wallpapers, remember to add to the applications's manifest before publishing to Android Market which indicates to Android Market and the platform that your app requires Android 2.1 or higher.

<uses-feature android:name="android.software.live_wallpaper" />

which tells Android Market that your application includes a live wallpaper.

History

  • 2010.08.09 Initial sample commit

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Evgeny Vinnik
Software Developer Darim Vision
Canada Canada
No Biography provided

Comments and Discussions

 
Questiongalaxy s3/s4 live wallpaper PinmemberAbbas Yousaf14-Aug-14 6:06 
QuestionKinde eBook: Creating Live Wallpapers With Parallax Layers and Images PinmemberMember 1080958510-May-14 18:09 
GeneralMy vote of 5 Pinprofessionalridoy27-Nov-13 3:36 
Questiongood job PinmemberMember 1040937018-Nov-13 5:47 
GeneralMy vote of 5 Pinmemberarashmd4-Jul-13 12:02 
QuestionMy Vote 4 PinmemberToywarrior12-Jun-13 16:19 
GeneralMy vote of 2 [modified] PinmemberVenson25-Jun-13 9:31 
GeneralMy vote of 5 PinmemberOtto Castillo31-May-13 11:10 
QuestionGreat Job Dude ! Pinmemberplus34724-May-13 9:27 
GeneralThanks PinmemberMember 100289734-May-13 10:15 
QuestionERROR PinmemberMember 99751809-Apr-13 21:25 
GeneralMy vote of 1 PinmemberMember 841045031-Mar-13 5:17 
QuestionHow to run source code? Pinmemberkrewelfow16-Mar-13 11:06 
Questioncannot run [modified] Pinmembermaitung31-Jan-13 1:21 
GeneralMy vote of 5 Pinmemberkksrinivasan8929-Jan-13 23:02 
Questionerror in usin @string or @array PinmemberMember 97335576-Jan-13 21:10 
Questionwallpaper PinmemberMember 967820811-Dec-12 22:06 
GeneralThanks! Pinmemberriyadoll21-Nov-12 8:23 
Helpful article! thanks!
Questioncan i use this live wallpaper as a background in my app . Pinmembermanohar37879-Sep-12 20:18 
Questioncreate app software PinmemberMember 93468289-Aug-12 5:39 
AnswerRe: create app software PinmemberMember 961428419-Nov-12 22:24 
BugFile not Found PinmemberRishav Jalan22-May-12 4:08 
GeneralRe: File not Found PinmemberEvgeny Vinnik22-May-12 4:57 
Question"Settings" show error message : "Live Wallpaper Picker has stopped" PinmemberMember 896834213-May-12 3:02 
Questioni cannot download, blank page PinmemberMember 883855017-Apr-12 1:10 
QuestionArticle missing pictures? Pinmemberwildwestgoh16-Feb-12 18:45 
AnswerRe: Article missing pictures? PinmemberEvgeny Vinnik16-Feb-12 19:15 
QuestionError Pinmembersmilieegurl2-Jan-12 13:24 
AnswerRe: Error with xml PinmemberEvgeny Vinnik3-Jan-12 7:38 
AnswerRe: Error PinmemberIsaac Gittins27-Aug-12 14:14 
GeneralMy vote of 3 PinmemberMember 82974586-Oct-11 21:48 
Questionhow do I open the samples? PinmemberDiamagin18-Sep-11 10:06 
GeneralRe: how do I open the samples? PinmemberJaydeep Jadav24-Nov-11 17:23 
AnswerRe: how do I open the samples? PinmemberTH3ORY2-Feb-12 13:46 
Generalhelp on livewall PinmemberMember 78453479-May-11 6:39 
GeneralRe: help on livewall PinmemberEvgeny Vinnik9-May-11 11:21 
QuestionCan we use the SDK's "View Animation" package from within Live Wallpaper? PinmemberMember 77175803-Mar-11 21:11 
AnswerRe: Can we use the SDK's "View Animation" package from within Live Wallpaper? PinmemberEvgeny Vinnik4-Mar-11 9:47 
GeneralRe: Can we use the SDK's "View Animation" package from within Live Wallpaper? PinmemberGeorgeFreeman15-Mar-11 6:15 
GeneralConfigure crashes this live wallpaper Pinmembertimverhoeven13-Feb-11 7:28 
GeneralRe: Configure crashes this live wallpaper PinmemberEvgeny Vinnik13-Feb-11 12:57 
GeneralRe: Configure crashes this live wallpaper Pinmembertimverhoeven14-Feb-11 1:36 
GeneralRe: Configure crashes this live wallpaper PinmemberEvgeny Vinnik14-Feb-11 8:31 
GeneralRe: Configure crashes this live wallpaper PinmemberEvgeny Vinnik30-Mar-11 6:56 
GeneralRe: Configure crashes this live wallpaper Pinmembertimverhoeven30-Mar-11 8:48 
GeneralRe: Configure crashes this live wallpaper PinmemberMember 852201531-Dec-11 14:13 
GeneralRe: Configure crashes this live wallpaper PinmemberEvgeny Vinnik3-Jan-12 7:27 
GeneralRe: Configure crashes this live wallpaper - thanks for update PinmemberMember 85220156-Feb-12 16:11 
Question??? PinmemberPedropassos24-Jan-11 9:37 
AnswerRe: ??? PinmemberEvgeny Vinnik24-Jan-11 9:59 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web01 | 2.8.140827.1 | Last Updated 20 Mar 2012
Article Copyright 2010 by Evgeny Vinnik
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid