Class RMMFAudioRecordControllerCustomCommands

class RMMFAudioRecordControllerCustomCommands : public RMMFCustomCommandsBase;

Description

Client class to access functionality specific to an audio record controller.

The class uses the custom command function of the controller plugin, and removes the necessity for the client to formulate the custom commands.

Derivation

• RMMFCustomCommandsBase - Base class for client-side custom command classes.

• RMMFAudioRecordControllerCustomCommands - Client class to access functionality specific to an audio record controller.

Members

Defined in RMMFAudioRecordControllerCustomCommands:

• AddMetaDataEntryL(const CMMFMetaDataEntry &)Adds meta data to the clip.
• Crop(TBool)Removes a portion from the clip, either from the current position to the beginni...
• GetRecordTimeAvailable(TTimeIntervalMicroSeconds &)constGets the (possibly estimated) record time left in the clip.
• RMMFAudioRecordControllerCustomCommands(RMMFController &)Constructor.
• RemoveMetaDataEntry(TInt)Removes a meta data entry from the clip.
• ReplaceMetaDataEntryL(TInt,const CMMFMetaDataEntry &)Replaces a meta data in the clip.
• SetMaxDuration(const TTimeIntervalMicroSeconds &)constSets the maximum duration of the recorded clip, in microseconds.
• SetMaxFileSize(TInt)constSets the maximum size of the recorded clip, in bytes.

Inherited from RMMFCustomCommandsBase:

• RMMFCustomCommandsBase(RMMFController &,TUid)Constructor.
• iControllerThe controller.
• iDestinationPckgThe destination package.

IMPORT_C RMMFAudioRecordControllerCustomCommands(RMMFController &aController);

Description

Constructor.

Parameters

RMMFController &aController The client side controller object to be used by this custom command interface.

IMPORT_C TInt GetRecordTimeAvailable(TTimeIntervalMicroSeconds &aTime) const;

Description

Gets the (possibly estimated) record time left in the clip.

Parameters

TTimeIntervalMicroSeconds &aTime The record time available, in microseconds.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt SetMaxDuration(const TTimeIntervalMicroSeconds &aMaxDuration) const;

Description

Sets the maximum duration of the recorded clip, in microseconds.

Parameters

const TTimeIntervalMicroSeconds &aMaxDuration The maximum duration of the recorded clip, in microseconds.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt SetMaxFileSize(TInt aMaxSize) const;

Description

Sets the maximum size of the recorded clip, in bytes.

Parameters

TInt aMaxSize The maximum size of the recorded clip, in bytes.

Return value

TInt One of the system-wide error codes.

IMPORT_C TInt Crop(TBool aToEnd);

Description

Removes a portion from the clip, either from the current position to the beginning or the current position to the end.

Parameters

TBool aToEnd A boolean indicating whether to crop to the end. Crops to the end if set to ETrue, to the beginning set to EFalse.

Return value

TInt One of the system-wide error codes.

IMPORT_C void AddMetaDataEntryL(const CMMFMetaDataEntry &aNewEntry);

Description

Adds meta data to the clip.

Parameters

const CMMFMetaDataEntry &aNewEntry The details of the new entry to be added.

IMPORT_C TInt RemoveMetaDataEntry(TInt aIndex);

Description

Removes a meta data entry from the clip.

Parameters

TInt aIndex The ID of the meta data entry to delete.

Return value

TInt One of the system-wide error codes.

IMPORT_C void ReplaceMetaDataEntryL(TInt aIndex, const CMMFMetaDataEntry &aNewEntry);

Description

Replaces a meta data in the clip.

Parameters

TInt aIndex The ID of the meta data entry to replace. const CMMFMetaDataEntry &aNewEntry The details of the new entry to be added.