Flash Viewer Framework API Specification DocumentChanges in Flash Viewer Framework API documentation
Changes in Flash Viewer Framework API
PurposeThe purpose of this API is to provide an interface to play the flash content. This API provides ability to write a lightweight stub application. The stub application is a specialized host application visible in Shell UI with its own icons and caption texts, uses the private SWF attached to the stub and has the assigned set of platform security capabilities. This will provide Flash content authors to give application view to the users, e.g. a Flash content author can develop a Flash game and attach the stub application to this game. ConstraintsFlash Player Engine handles all the error conditions. It uses Symbian Leave mechanism for any critical errors. The stub application does not have control over the flash errors. There is no communication between the stub application and Flash Player Engine. The stub application is a lightweight application. Flash Player supports only SWF formats. It does not support FLA format. It handles OMA DRM v1.0 protected SWF content. Flash play-out is done in the application thread. There are no extra threads spawned. API descriptionFlash Viewer Framework API provides the ability to write lightweight stub applications for Symbian platform executing flash content. Flash Player Engine handles SWF format. The stub application is a specialized host application visible in Shell UI with its own icons and caption texts, uses the private SWF attached to the stub and has the assigned set of platform security capabilities. This will provide Flash content authors to give the application view to the users, e.g. a Flash content author can develop a Flash game and attach the stub application to this game. This API is a Framework API provided by Flash Viewer Framework. It provides uniform UI options for executing flash content in Symbian devices. This API is a method call invoking Flash Player engine. This uses application thread for rendering flash content. There are no extra threads spawned. Use casesThe use case of Flash Viewer Framework API is to develop stub application for Symbian devices. API class structureThis API provides single method
CreateFlashDocumentL method
Related APIs
FlashUIConfig structure
Related APIs
Related APIs
Using Flash Viewer Framework APIThis API is used to write stub applications for Symbian devices. Stub applicationThe stub application is a specialized host application visible in Shell UI with its own icons and caption texts, uses the private SWF attached to the stub and has the assigned set of platform security capabilities. This will provide Flash content authors to give application view to the users. For example, a Flash content author can develop a Flash game and attach the stub application to the content. Using FlashUIConfig structure to run Flash Lite application in stub modeFlashUIConfig defined in
flash_ui.h has to be used to configure
the application into stub mode. The FlashUIConfig.iIsStubApp member variable
has to be set to
Related APIs
Passing SWF for stub applicationFlashUIConfig defined in flash_ui.h has to be used to pass the SWF file to the stub application. This SWF has to be in private data caged area to protect from accidental deletion or replacing by malicious SWF content.
MMP fileFlash Stub applications require higher allocation of heap and stack size.
Related APIs
Writing source for stub applicationThe following example code demonstrates how to write a stub application:
Writing header for stub application
Writing resource fileA resource file has to be written to define the caption and icon for the stub application. Stub writers can write LOC files for all localizable resource string and provide resource Ids in the RSS file. Example Stub.rss file:
Writing registration fileExample Stub_reg.rss for registering stub application:
Writing PKG fileA PKG file can be written to create SIS package for the stub application. Here application writer can mention dependency on the Flash Lite application. This will make installation of stub application only on the mobile devices having Flash Lite installed. This PKG file can be used to create SIS package using the makesis tool provided with Symbian SDK. Example Stub.pkg file:
Example MMP fileExample Stub.mmp file:
Error handlingFlash Lite is an Adobe product. All Symbian devices may not have Flash Lite installed. flash2ui.dll should be present in the phone. If this DLL is not present in the phone, the stub application will exit. The stub application writer can add dependency to Flash Lite in PKG file during installation of the stub application. Flash Player Engine handles the errors. It uses Symbian Leave mechanism for any critical errors. GlossaryAbbreviations
Definitions
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. License: EPL
|