Please note that as of October 24, 2014, the Nokia Developer Wiki will no longer be accepting user contributions, including new entries, edits and comments, as we begin transitioning to our new home, in the Windows Phone Development Wiki. We plan to move over the majority of the existing entries. Thanks for all your past and future contributions.

Archived:Writing a screen saver for S60 3rd Edition devices

From Wiki
Jump to: navigation, search

Archived.pngArchived: This article is archived because it is not considered relevant for third-party developers creating commercial solutions today. If you think this article is still relevant, let us know by adding the template {{ReviewForRemovalFromArchive|user=~~~~|write your reason here}}.

Article Metadata
Code ExampleTested with
Devices(s): all, if screen saver feature supported
Platform(s): Symbian/S60 3.x, Symbian^1, Symbian^3
S60 3rd Edition (initial release)
Keywords: CScreensaverPluginInterfaceDefinition, KCScreensaverPluginInterfaceDefinitionUid, screen saver
Created: User:Technical writer 2 (05 Oct 2006)
Last edited: lpvalente (14 Oct 2012)


Writing a screen saver for S60 3rd Edition devices (and later)


This solution shows how to write a screen saver for Symbian/S60 3rd Edition (S60 3.0, 3.1 and 3.2), Symbian^1 and Symbian^3 devices.

General information:

- The example code is attached to this solution, as a Symbian C++ project, suitable to be built with Carbide.c++

- The included .sis file is not signed, you are expected to use a Developer Certificate and sign the file before installation. You can obtain a Developer Certificate from Symbian Signed (Publisher ID required) or from Ovi Publish (free).


This solution focuses on building screen savers for S60 3rd Edition (or later) phones; if you want to create a screen saver for S60 2nd Edition, see S60 2nd Edition: Screen Saver Example.

Important points: - Setting the TARGETTYPE directive to PLUGIN in your .mmp file: This is new in S60 3rd Edition and specifies that you are building an ECom plug-in. - 0x10009D8D is the ECom dll Recognition UID, while 0xE1EF299A is a unique dll UID. (The 0xE??????? UID range is safe to use for RD work, for release obtain a valid UID (in the 0x2??????? range) from Symbian Signed or Ovi Publish) - Due to the ReadDeviceData and WriteDeviceData capabilities requirement, you will not be able to write a screen saver without having a Developer Certificate, because only those DevCerts have the extended capability set required by the screen saver plug-in framework.

Plug-in registration resource file: As screen savers are now ECom plug-ins, you need to create a registration resource file called ExampleScreenSaver.rss (see source code).

Important points in this file: - dll_uid and implementation_uid are the dll UIDs. interface_uid comes straight from the screensaverpluginintdef.hrh file and identifies this plug-in as a plug-in for the screen saver engine. - display_name is the friendly name which will be displayed in the Themes application when you configure the current theme to use your screen saver (see more details below).

Source code: You need to inherit your screen saver class from CScreensaverPluginInterfaceDefinition that implements some ECom construction/destruction code and in turn inherits from MScreensaverPlugin, which defines the actual interface you will implement in order to make your screen saver work. The important functions you need to implement in order to have real functionality in your plug-in are: InitializeL(MScreensaverPluginHost *aHost) This is will be called once, when the plug-in is initialized for the first time, and it will pass you a pointer to the plug-in host (MScreensaverPluginHost class) which you can use for important things such as requesting the backlight to be on or off, setting the timer refresh value, and setting the active display area (so you save power by only activating screen areas where you are actually drawing something), among others. Draw(CWindowGc& aGc); This will be called each time the refresh timer expires, passing you a CWindowGc graphics context that you'll use to perform the actual drawing of your animations. HandleScreensaverEventL(TScreensaverEvent aEvent, TAny* aData); Here you can handle some screen saver events that interest you. See TScreensaverEvent class documentation in the S60 3rd Edition SDK. See ExampleScreenSaver.cpp for the implementations of these functions in the example. The last thing you need to do is to export a function that provides the mapping between the UID of the implementation and its respective creation function. This is pretty standard ECom code and it is documented in the ImplementationProxy.cpp source file.

Building, packaging, and installing the example If you use Carbide.c++ or CodeWarrior, just perform a full rebuild of the project. If you are building it from the command line, just cd to the group folder and type the command: abld build gcce urel This will build ExampleScreenSaver.rsc and ExampleScreenSaver.dll files, which will be copied to \resource\plugins and \sys\bin\ folders in the device, respectively. Next, create the .sis file that will be installed on the phone. Again, if you are using an IDE, the .sis file will be built (and signed, depending on your configuration) for you automatically. Otherwise, you must cd to the sis folder and build the package by typing: makesis ExampleScreenSaver.pkg which will build a ExampleScreenSaver.sis. Prior to installing, you need to sign it by using the following commsiand: signsis ExampleScreenSaver.sis ExampleScreenSaver.sisx your_cert_file.cer your_key_file.key where your_cert_file.cer is your Developer Certificate, obtained as described at the beginning of this topic, and your_key_file.key is the private key file for this certificate.

Installing your screen saver on the device is easy: Just transfer it via Bluetooth, cable (using Nokia PC Suite), or by downloading it over the Internet.


This page was last modified on 14 October 2012, at 20:55.
28 page views in the last 30 days.