Data Structures | Namespaces | Defines | Enumerations | Functions

Third Fancy Device API
[WFD APIs]

This is a brief description for the third Fancy Device API. More...

Data Structures

struct  fancy_cold_boot_block
 Holds the new and previous cold boot block numbers. More...
union  _AfancyAudioEvent
 Accesses the header values. This union includes two data structures. More...
struct  fancy_qos_params_type
 Stores Fancy Quality of Service parameters. More...

Namespaces

namespace  fancy_audio_2

Defines

#define FANCY_DEVICE_DONE   0
#define FANCY_DEVICE_FAIL   (-1)
#define FANCY_DEVICE_NOT_SUPPORTED   (-2)
#define FANCY_DEVICE_CP_READ_FAIL   (-3)
#define FANCY_INTERFACE_VERSION   DALINTERFACE_VERSION(1,0)

Enumerations

enum  fancy_header_comp_e_type { FANCY_HEADER_COMP_OFF = 0, FANCY_HEADER_COMP_ON = 1, FANCY_HEADER_COMP_MAX = 0xFF }
enum  fancy_dev_val_e_type { FANCY_DEVICE_VAL_OFF = 0, FANCY_DEVICE_VAL_ON = 1 }
enum  FancySysTimeType1 { IAO_SYSTIME_UMTS = 0x00, IAO_SYSTIME_GSM = 0x01, IAO_SYSTIME_TOT }
enum  WfdWSEvtType { WFD_WS_EVENT_TOT }

Functions

static int CreateInstance (FANCYCLID clsid, IEnv *pEnvironment, IPrivSet *pPrivSet, void **ppNewObj)
virtual int NDQueryInterface (FANCYID idReq, IQI **ppIface)
FancyResult NameThread ()
 FancyInterfere (FANCYCLSID clsid, pEnv *pEnvironment, int &result)
int printf (const char *fmt,...)

Detailed Description

This is the detailed description for the third API group. It appears in the Detailed Description section.


Define Documentation

#define FANCY_DEVICE_DONE   0

Operation passed.

#define FANCY_DEVICE_FAIL   (-1)

Operation failed.

#define FANCY_DEVICE_NOT_SUPPORTED   (-2)

Device is not supported.

#define FANCY_DEVICE_CP_READ_FAIL   (-3)

Copy page read failure.

#define FANCY_INTERFACE_VERSION   DALINTERFACE_VERSION(1,0)

Defines the interface version. The interface version can be 0 (the default) to indicate that this is the first instance, or it can be 1 to indicate that this is the latest version.


Enumeration Type Documentation

Fancy header compression types.

Enumerator:
FANCY_HEADER_COMP_OFF 

Compression is off (default).

FANCY_HEADER_COMP_ON 

Compression is on when selected.

FANCY_HEADER_COMP_MAX 

Forces the maximum compression to 0xff so the enumeration is defined as a byte.

Fancy device validation modes.

Enumerator:
FANCY_DEVICE_VAL_OFF 

Device validation mode is off (default).

FANCY_DEVICE_VAL_ON 

Device validation mode is on when selected.

Enumerator:
IAO_SYSTIME_GSM 

GSM system time.

IAO_SYSTIME_TOT 

Total number of system time types.

Supported WFD warm start events.

Enumerator:
WFD_WS_EVENT_TOT 

Total number of warm start events


Function Documentation

static int CreateInstance ( FANCYCLID  clsid,
IEnv *  pEnvironment,
IPrivSet *  pPrivSet,
void **  ppNewObj 
) [static]

Provides a public entry point for the module. A new instance of FancyInterfere is created for FancyModule, and the default interface is returned.

Note:
Note text 1.
Note text 2.
Note text 3.
Parameters:
[in] clsid Class ID of the module.
[in] pEnvironment Interface to the Fancy Services environment.
[out] pPrivSet Privilege set of the caller.
[in,out] ppNewObj Set to the interface pointer of the new instance.
Returns:
SUCCESS -- Instance was created successfully.
ENOMEMORY -- Indicates a memory allocation failure.
Dependencies
None.
Side effects
An invalid class ID may produce erroneous results.
See also:
NDQueryInterface
virtual int NDQueryInterface ( FANCYID  idReq,
IQI **  ppIface 
) [virtual]

Handles interface pointers for non-based classes.

This method must be implemented if the FancyInterfere module supports any interfaces not handled by its base classes.

Parameters:
[in] idReq Unique ID of the requested interface.
[out] ppIface Interface pointer of the requested interface.
Returns:
SUCCESS -- Interface is returned successfully.
ECLASSNOTSUPPORT -- Interface is not supported.
FancyResult NameThread (  ) 

Handles thread name intialization.

The deriving class can override this method to provide a descriptive name for the optional output thread. This helps distinguish it in debugging applications. The default implementation provides a generic name.

This is an example of a single hanging indent note (note1hang command). It is primarily intended for use in fancy tools during software download.

Returns:
SUCCESS -- Initialization was successful.
FAILURE -- Initialization failed.
FancyInterfere ( FANCYCLSID  clsid,
pEnv *  pEnvironment,
int &  result 
)

Provides a class constructor.

This is the component constructor, meant to be called by the class factory of the component.

Parameters:
[in] clsid Class ID of the module.
[in] pEnvironment Interface to the Fancy Services environment.
[out] result Result of the function.
Returns:
The following results may be returned:
  • Valid class object
  • Invalid class object
int printf ( const char *  fmt,
  ... 
)

Standard print function. The extern keyword is used to inform the compiler about variables declared outside of the current file. Variables described by extern statements do not have any space allocated for them because they have been previously defined elsewhere.