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

• MTaggedDataParserClient - No description.

• CBase - Base class for all classes to be instantiated on the heap.

• CMMFPluginImplementationInformation - Abstract class that contains basic information about ECom Multimedia plugins.

• CMMFFormatImplementationInformation - Contains format support information retrieved from the ECom registry.

Members

Defined in CMMFFormatImplementationInformation:

• ProcessTaggedDataL(const TDesC8 &,const TDesC8 &)from MTaggedDataParserClient
• SupportedFileExtensions()constReturns the array of supported file extensions.
• SupportedHeaderData()constReturns the array of supported header data matches.
• SupportedMimeTypes()constReturns the array of supported mime types.
• SupportsCustomInterfaces()constTests whether this format provides support for Custom Interfaces.
• SupportsFileExtension(const TDesC8 &)constTests whether this format provides support for the specified file extension, aFi...
• SupportsHeaderDataL(const TDesC8 &)constTests whether this format provides support for aHeaderData. aHeaderData is searc...
• SupportsMimeType(const TDesC8 &)constTests whether this format provides support for aMimeType.
• ~CMMFFormatImplementationInformation()Destructor

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Inherited from CMMFPluginImplementationInformation:

• DisplayName()constReturns the display name of this plugin implementation.
• Supplier()constReturns the name of the supplier of this plugin implementation, e.g. "Symbi...
• SupportedMediaIds()constReturns the array of media IDs supported by this plugin.
• SupportsMediaId(TUid)constTests whether this plugin supports aMediaId.
• SupportsSupplier(const TDesC &)constTests whether this plugin was supplied by aSupplier.
• Uid()constReturns the uid of this particular plugin implementation. This is the UID used t...
• Version()constReturns the version number of this plugin.
• iDisplayNameThe display name of this plugin.
• iMediaIdsThe media ids supported by this plugin.
• iSupplierThe supplier of this plugin.
• iUidThe UID of this plugin.
• iVersionThe version number of this plugin.

virtual ~CMMFFormatImplementationInformation();

Description

Destructor

IMPORT_C const CDesC8Array& SupportedFileExtensions() const;

Description

Returns the array of supported file extensions.

Return value

const CDesC8Array & The array of file extensions.

IMPORT_C const CDesC8Array& SupportedMimeTypes() const;

Description

Returns the array of supported mime types.

Return value

const CDesC8Array & The array of mime types.

IMPORT_C const CDesC8Array& SupportedHeaderData() const;

Description

Returns the array of supported header data matches.

Return value

const CDesC8Array & The array of header data.

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.

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.

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.

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.

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

Description

from MTaggedDataParserClient

Parameters

const TDesC8 &aTag const TDesC8 &aData