Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: mmfcontrollerpluginresolver.h
Link against: mmfcontrollerframework.lib

Class CMMFFormatImplementationInformation

class CMMFFormatImplementationInformation : public CMMFPluginImplementationInformation, private MTaggedDataParserClient;

Description

Contains format support information retrieved from the ECom registry.

An object of this type may describe either a concrete format plugin (ie a CMMFFormatEncode or a CMMFFormatDecode implementation) or a format supported by a controller plugin.

The object is created using a CImplementationInformation object retrieved from the ECom registry. All relevant data is copied out of the CImplementationInformation object, and its opaque data is parsed to provide the supplier, supported media ids, supported mime types, supported file extensions, and supported header data matches.

Notes for Format Plugin developers:

The opaque data section of the ECom plugin resource file must be in the format:

opaque_data = "<?>Data 1<?>Data 2<?>Data 3<?>Data 4[...]<?>Data N";

The <?> preceding the data determines the meaning of the data.  The following are the possible tags:

    <s> - Supplier
    <i> - Media Id
    <m> - Mime Type
    <e> - File Extension
    <h> - Header Data
    <c> - Custom Interfaces

UIDs must always be in hex in the format '0x12345678', must include the '0x' and be 10 characters long

Derivation

Members

Defined in CMMFFormatImplementationInformation:
ProcessTaggedDataL(), SupportedFileExtensions(), SupportedHeaderData(), SupportedMimeTypes(), SupportsCustomInterfaces(), SupportsFileExtension(), SupportsHeaderDataL(), SupportsMimeType(), ~CMMFFormatImplementationInformation()

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CMMFPluginImplementationInformation:
DisplayName(), Supplier(), SupportedMediaIds(), SupportsMediaId(), SupportsSupplier(), Uid(), Version(), iDisplayName, iMediaIds, iSupplier, iUid, iVersion


Construction and destruction


~CMMFFormatImplementationInformation()

virtual ~CMMFFormatImplementationInformation();

Description

Destructor

[Top]


Member functions


SupportedFileExtensions()

IMPORT_C const CDesC8Array &SupportedFileExtensions() const;

Description

Returns the array of supported file extensions.

Return value

const CDesC8Array &

The array of file extensions.


SupportedMimeTypes()

IMPORT_C const CDesC8Array &SupportedMimeTypes() const;

Description

Returns the array of supported mime types.

Return value

const CDesC8Array &

The array of mime types.


SupportedHeaderData()

IMPORT_C const CDesC8Array &SupportedHeaderData() const;

Description

Returns the array of supported header data matches.

Return value

const CDesC8Array &

The array of header data.


SupportsFileExtension()

IMPORT_C TBool SupportsFileExtension(const TDesC8 &aFileExtension) const;

Description

Tests whether this format provides support for the specified file extension, aFileExtension.

Parameters

const TDesC8 &aFileExtension

The requested file extension. Must be the extension only, and contain the dot '.'

Return value

TBool

A boolean indicating if the specified file extension is supported. ETrue if this format provides the required support, EFalse if it does not.


SupportsMimeType()

IMPORT_C TBool SupportsMimeType(const TDesC8 &aMimeType) const;

Description

Tests whether this format provides support for aMimeType.

Parameters

const TDesC8 &aMimeType

The requested mime type.

Return value

TBool

A boolean indicating if the format is supported. ETrue if this format provides the required support, EFalse if not.


SupportsHeaderDataL()

IMPORT_C TBool SupportsHeaderDataL(const TDesC8 &aHeaderData) const;

Description

Tests whether this format provides support for aHeaderData. aHeaderData is searched for each chunk supported by this format.

Parameters

const TDesC8 &aHeaderData

The requested header data.

Return value

TBool

A boolean indicating if aHeaderData is supported. ETrue if this format provides the required support, EFalse if not.


SupportsCustomInterfaces()

IMPORT_C TBool SupportsCustomInterfaces() const;

Description

Tests whether this format provides support for Custom Interfaces.

Return value

TBool

A boolean indicating if Custom Interfaces are supported. ETrue if this format provides the required support, EFalse if not.


ProcessTaggedDataL()

protected: virtual void ProcessTaggedDataL(const TDesC8 &aTag, const TDesC8 &aData);

Description

from MTaggedDataParserClient

Parameters

const TDesC8 &aTag

const TDesC8 &aData