RMMFAudioRecordControllerCustomCommands Class Reference

#include <mmf/common/mmfstandardcustomcommands.h>

Link against: mmfstandardcustomcommands.lib

class RMMFAudioRecordControllerCustomCommands : public RMMFCustomCommandsBase, public RMMFCustomCommandsBase

Inherits from

Detailed 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.

Since
7.0s

Constructor & Destructor Documentation

RMMFAudioRecordControllerCustomCommands ( RMMFController & )

IMPORT_CRMMFAudioRecordControllerCustomCommands(RMMFController &aController)

Constructor.

Since
7.0s
Parameters
aControllerThe client side controller object to be used by this custom command interface.

Member Function Documentation

AddMetaDataEntryL ( const CMMFMetaDataEntry & )

IMPORT_C voidAddMetaDataEntryL(const CMMFMetaDataEntry &aNewEntry)

Adds meta data to the clip.

Since
7.0s
Parameters
aNewEntryThe details of the new entry to be added.

Crop ( TBool )

IMPORT_C TIntCrop(TBoolaToEnd)

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

current position to the end.

the beginning set to EFalse.

Since
7.0s
Parameters
aToEndA boolean indicating whether to crop to the end. Crops to the end if set to ETrue, to
Return Value
One of the system-wide error codes.

GetRecordTimeAvailable ( TTimeIntervalMicroSeconds & )

IMPORT_C TIntGetRecordTimeAvailable(TTimeIntervalMicroSeconds &aTime)const

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

Since
7.0s
Parameters
aTimeThe record time available, in microseconds.
Return Value
One of the system-wide error codes.

RemoveMetaDataEntry ( TInt )

IMPORT_C TIntRemoveMetaDataEntry(TIntaIndex)

Removes a meta data entry from the clip.

Since
7.0s
Parameters
aIndexThe ID of the meta data entry to delete.
Return Value
One of the system-wide error codes.

ReplaceMetaDataEntryL ( TInt, const CMMFMetaDataEntry & )

IMPORT_C voidReplaceMetaDataEntryL(TIntaIndex,
const CMMFMetaDataEntry &aNewEntry
)

Replaces a meta data in the clip.

Since
7.0s
Parameters
aIndexThe ID of the meta data entry to replace.
aNewEntryThe details of the new entry to be added.

SetMaxDuration ( const TTimeIntervalMicroSeconds & )

IMPORT_C TIntSetMaxDuration(const TTimeIntervalMicroSeconds &aMaxDuration)const

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

Since
7.0s
Parameters
aMaxDurationThe maximum duration of the recorded clip, in microseconds.
Return Value
One of the system-wide error codes.

SetMaxFileSize ( TInt )

IMPORT_C TIntSetMaxFileSize(TIntaMaxSize)const

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

Since
7.0s
Parameters
aMaxSizeThe maximum size of the recorded clip, in bytes.
Return Value
One of the system-wide error codes.