×
Namespaces

Variants
Actions

Archived:Flash UI API

From Nokia Developer 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}}.

We do not recommend Flash Lite development on current Nokia devices, and all Flash Lite articles on this wiki have been archived. Flash Lite has been removed from all Nokia Asha and recent Series 40 devices and has limited support on Symbian. Specific information for Nokia Belle is available in Flash Lite on Nokia Browser for Symbian. Specific information for OLD Series 40 and Symbian devices is available in the Flash Lite Developers Library.

Article Metadata
CompatibilityArticle
Created: aaumala (03 Apr 2007)
Last edited: hamishwillee (14 May 2013)

S60 3rd Edition SDK for Symbian OS, Supporting Feature Pack 1, for C++ API Reference Guide

flash_ui.h File Reference Published in S60 3rd Ed FP 1



Capability Information Required capabilities: NetworkControl

Edit: This API does not need any capabilities, unless the Flash application needs some capabilites.



Detailed Description The API to start Viewer UI for playing Flash content file from a Viewer or a Stub application. The point here is to offer easy-of-use API for stubs applications which has dedicated set of platform security capabilities for rendering private SWF content. However, also standard Flash Viewer can utilize the same API as well.

Example usage of the API:


LOCAL_C CApaApplication* NewApplication( )
    {
          return new(ELeave) CFlashStubApplication;
          }
GLDEF_C TInt E32Main()
    {
    return EikStart::RunApplication(NewApplication);
    }

CFlashStubApplication::~CFlashStubApplication()
    {
    if (iFlashLibrary.Handle())
        {
        iFlashLibrary.Close();
        }
    }

const TUid KUidFlashStubApp = { 0x1027367B };

TUid CFlashStubApplication::AppDllUid() const
    {
    return KUidFlashStubApp;
    }


_LIT(KStubFlashContent, "C:\\Data\\Others\\example.swf");

const TUint32 KContentChecksum = 0;

CApaDocument* CFlashStubApplication::CreateDocumentL()
    {
    FlashUIConfig config;
    config.iIsMMI = EFalse;
    config.iIsStubApp = ETrue;
    config.iContentFileName.Copy(KStubFlashContent);
    config.iContentChecksum = KContentChecksum;
    config.iExtensions = NULL;

    if(!FlashStubsSupported())
              {
              User::Leave(KErrNotSupported);   
        } 
    return CreateFlashDocumentL(iFlashLibrary, this, config);
   }


  1. include <apparc.h>
  2. include <apgcli.h>


Go to the source code of this file.


Data Structures struct FlashUIConfig

 Structure containing configuration information for UI. More...


Typedefs typedef void *(* PFNC_CreateFlashDocumentL )(CEikApplication *aApp, const FlashUIConfig &aUIConfig)

 Pointer to a function that creates the document class. 


Functions

 _LIT (KFlashUILibraryName,"flash2ui.dll") 
 The Flash UI dll name. 

CApaDocument * CreateFlashDocumentL (RLibrary &aLibrary, CEikApplication *aApp, const FlashUIConfig &aUIConfig)

 CreateFlashDocumentL creates a Flash document for an application and starts playing the given SWF file. 

TBool FlashStubsSupported ()

 Checks whether S60 Flash Lite Viewer Framework DLL exist in device for Stub applications. 


Variables const TInt KFlashCreateDocumentOrdinal = 1

 The ordinal of the exported function in the flash ui dll. 



Typedef Documentation typedef void*(* PFNC_CreateFlashDocumentL)(CEikApplication *aApp, const FlashUIConfig &aUIConfig)

  Pointer to a function that creates the document class. 




Function Documentation _LIT ( KFlashUILibraryName ,

 "flash2ui.dll"   
)   

  The Flash UI dll name. 



CApaDocument* CreateFlashDocumentL ( RLibrary & aLibrary,

 CEikApplication *  aApp,  
 const FlashUIConfig &  aUIConfig 
)  [inline] 

  CreateFlashDocumentL creates a Flash document for an application and starts playing the given SWF file. 

If there is no S60 Flash Lite Viewer Framework DLL installed in the device, the function leaves with error code returned from the RLibrary::Load.


Parameters:

aLibrary Handle to the flash UI dll.  
aApp Instance of the application class.  
aUIConfig Instance of the class that contains the configuration for the UI.  

Returns: The new document object. Leave: KErrGeneral Error in using the successfully loaded Flash Viewer Framework DLL


TBool FlashStubsSupported ( ) [inline]

  Checks whether S60 Flash Lite Viewer Framework DLL exist in device for Stub applications. 


Returns: ETrue if Flash Lite Stub applications is suppported, EFalse otherwise.



Variable Documentation const TInt KFlashCreateDocumentOrdinal = 1

  The ordinal of the exported function in the flash ui dll. 




© Nokia 2006


This page was last modified on 14 May 2013, at 06:17.
50 page views in the last 30 days.
×