Collapse all Symbian^3 Product Developer Library

RMMFAudioRecordControllerCustomCommands Class Reference

class RMMFAudioRecordControllerCustomCommands : public RMMFCustomCommandsBase

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

Inherits from

RMMFAudioRecordControllerCustomCommands
- RMMFCustomCommandsBase

Public Member Functions
	RMMFAudioRecordControllerCustomCommands(RMMFController &)
IMPORT_C void	AddMetaDataEntryL(const CMMFMetaDataEntry &)
IMPORT_C TInt	Crop(TBool)
IMPORT_C TInt	GetRecordTimeAvailable(TTimeIntervalMicroSeconds &)
IMPORT_C TInt	RemoveMetaDataEntry(TInt)
IMPORT_C void	ReplaceMetaDataEntryL(TInt, const CMMFMetaDataEntry &)
IMPORT_C TInt	SetMaxDuration(const TTimeIntervalMicroSeconds &)
IMPORT_C TInt	SetMaxFileSize(TInt)

Inherited Functions
	RMMFCustomCommandsBase::RMMFCustomCommandsBase(RMMFController &,TUid)

Inherited Attributes
	RMMFCustomCommandsBase::iController
	RMMFCustomCommandsBase::iDestinationPckg

Constructor & Destructor Documentation

RMMFAudioRecordControllerCustomCommands(RMMFController &)

IMPORT_C

RMMFAudioRecordControllerCustomCommands

(

RMMFController &

aController

)

Constructor.

Since: 7.0s

Parameters

RMMFController & aController

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

Member Functions Documentation

AddMetaDataEntryL(const CMMFMetaDataEntry &)

IMPORT_C void

AddMetaDataEntryL

(

const CMMFMetaDataEntry &

aNewEntry

)

Adds meta data to the clip.

Since: 7.0s

Parameters

const CMMFMetaDataEntry & aNewEntry

The details of the new entry to be added.

Crop(TBool)

IMPORT_C TInt

Crop

(

TBool

aToEnd

)

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

Since: 7.0s

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.

GetRecordTimeAvailable(TTimeIntervalMicroSeconds &)

IMPORT_C TInt

GetRecordTimeAvailable

(

TTimeIntervalMicroSeconds &

aTime

)

const

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

Since: 7.0s

Parameters

TTimeIntervalMicroSeconds & aTime

The record time available, in microseconds.

RemoveMetaDataEntry(TInt)

IMPORT_C TInt

RemoveMetaDataEntry

(

TInt

aIndex

)

Removes a meta data entry from the clip.

Since: 7.0s

Parameters

TInt aIndex

The ID of the meta data entry to delete.

ReplaceMetaDataEntryL(TInt, const CMMFMetaDataEntry &)

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

Replaces a meta data in the clip.

Since: 7.0s

Parameters

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

SetMaxDuration(const TTimeIntervalMicroSeconds &)

IMPORT_C TInt

SetMaxDuration

(

const TTimeIntervalMicroSeconds &

aMaxDuration

)

const

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

Since: 7.0s

Parameters

const TTimeIntervalMicroSeconds & aMaxDuration

The maximum duration of the recorded clip, in microseconds.

SetMaxFileSize(TInt)

IMPORT_C TInt

SetMaxFileSize

(

TInt

aMaxSize

)

const

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

Since: 7.0s

Parameters

TInt aMaxSize

The maximum size of the recorded clip, in bytes.