CMdaAudioRecorderUtility Class Reference

class CMdaAudioRecorderUtility : public CMdaAudioClipUtility

Plays back, records and edits audio sample data.

The class offers an interface to play, record and edit audio sample data. This data can be supplied either in a file or as a descriptor. The functions that start and stop playback and recording are defined in the base class CMdaAudioClipUtility.

While this class is abstract, the static NewL() function constructs, initialises and returns a pointer to an instance of a concrete class derived from this abstract class. This concrete class is part of the MMF implementation and is private.

Inherits from

Public Member Functions
~CMdaAudioRecorderUtility()
IMPORT_C voidAddMetaDataEntryL(CMMFMetaDataEntry &)
IMPORT_C const CMMFControllerImplementationInformation &AudioPlayControllerImplementationInformationL()
IMPORT_C const CMMFControllerImplementationInformation &AudioRecorderControllerImplementationInformationL()
IMPORT_C TIntCancelRegisterAudioResourceNotification(TUid)
voidClearPlayWindow()
voidClose()
voidCropFromBeginningL()
voidCropL()
IMPORT_C TUintDestinationBitRateL()
IMPORT_C TFourCCDestinationDataTypeL()
IMPORT_C TUidDestinationFormatL()
IMPORT_C TUintDestinationNumberOfChannelsL()
IMPORT_C TUintDestinationSampleRateL()
const TTimeIntervalMicroSeconds &Duration()
IMPORT_C TMMFDurationInfoDuration(TTimeIntervalMicroSeconds &)
IMPORT_C voidGetAudioLoadingProgressL(TInt &)
IMPORT_C MMMFDRMCustomCommand *GetDRMCustomCommand()
IMPORT_C TIntGetGain(TInt &)
IMPORT_C CMMFMetaDataEntry *GetMetaDataEntryL(TInt)
IMPORT_C TIntGetNumberOfMetaDataEntries(TInt &)
IMPORT_C TIntGetPlaybackBalance(TInt &)
IMPORT_C TIntGetRecordBalance(TInt &)
IMPORT_C voidGetSupportedBitRatesL(RArray< TUint > &)
IMPORT_C voidGetSupportedDestinationDataTypesL(RArray< TFourCC > &)
IMPORT_C voidGetSupportedNumberOfChannelsL(RArray< TUint > &)
IMPORT_C voidGetSupportedSampleRatesL(RArray< TUint > &)
IMPORT_C TIntGetVolume(TInt &)
TInt MaxGain()
TInt MaxVolume()
IMPORT_C CMdaAudioRecorderUtility *NewL(MMdaObjectStateChangeObserver &, CMdaServer *, TInt, TInt)
voidOpenDesL(const TDesC8 &)
IMPORT_C voidOpenDesL(TDes8 &)
IMPORT_C voidOpenDesL(TDes8 &, TUid, TUid, TUid, TFourCC)
voidOpenFileL(const TDesC &)
IMPORT_C voidOpenFileL(const RFile &)
IMPORT_C voidOpenFileL(const TMMSource &)
IMPORT_C voidOpenFileL(const TDesC &, TUid, TUid, TUid, TFourCC)
IMPORT_C voidOpenFileL(const RFile &, TUid, TUid, TUid, TFourCC)
IMPORT_C voidOpenFileL(const TMMSource &, TUid, TUid, TUid, TFourCC)
voidOpenL(TMdaClipLocation *, TMdaClipFormat *, TMdaPackage *, TMdaPackage *)
IMPORT_C voidOpenUrlL(const TDesC &, TInt, TUid, TUid, TUid, TFourCC)
IMPORT_C voidOpenUrlL(const TDesC &, TInt, const TDesC8 &)
IMPORT_C voidPlayControllerCustomCommandAsync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &, TDes8 &, TRequestStatus &)
IMPORT_C voidPlayControllerCustomCommandAsync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &, TRequestStatus &)
IMPORT_C TIntPlayControllerCustomCommandSync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &, TDes8 &)
IMPORT_C TIntPlayControllerCustomCommandSync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &)
voidPlayL()
const TTimeIntervalMicroSeconds &Position()
IMPORT_C voidRecordControllerCustomCommandAsync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &, TDes8 &, TRequestStatus &)
IMPORT_C voidRecordControllerCustomCommandAsync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &, TRequestStatus &)
IMPORT_C TIntRecordControllerCustomCommandSync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &, TDes8 &)
IMPORT_C TIntRecordControllerCustomCommandSync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &)
voidRecordL()
const TTimeIntervalMicroSeconds &RecordTimeAvailable()
IMPORT_C TIntRegisterAudioResourceNotification(MMMFAudioResourceNotificationCallback &, TUid, const TDesC8 &)
IMPORT_C voidRegisterForAudioLoadingNotification(MAudioLoadingObserver &)
IMPORT_C TIntRemoveMetaDataEntry(TInt)
IMPORT_C voidReplaceMetaDataEntryL(TInt, CMMFMetaDataEntry &)
voidSetAudioDeviceMode(TDeviceMode)
IMPORT_C voidSetDestinationBitRateL(TUint)
IMPORT_C voidSetDestinationDataTypeL(TFourCC)
IMPORT_C voidSetDestinationFormatL(TUid)
IMPORT_C voidSetDestinationNumberOfChannelsL(TUint)
IMPORT_C voidSetDestinationSampleRateL(TUint)
voidSetGain(TInt)
voidSetMaxWriteLength(TInt)
voidSetPlayWindow(const TTimeIntervalMicroSeconds &, const TTimeIntervalMicroSeconds &)
IMPORT_C TIntSetPlaybackBalance(TInt)
voidSetPosition(const TTimeIntervalMicroSeconds &)
IMPORT_C voidSetPriority(TInt, TInt)
IMPORT_C TIntSetRecordBalance(TInt)
voidSetRepeats(TInt, const TTimeIntervalMicroSeconds &)
IMPORT_C TIntSetThreadPriorityPlayback(const TThreadPriority &)
IMPORT_C TIntSetThreadPriorityRecord(const TThreadPriority &)
TInt SetVolume(TInt)
voidSetVolumeRamp(const TTimeIntervalMicroSeconds &)
IMPORT_C TUintSourceBitRateL()
TState State()
voidStop()
IMPORT_C voidUseSharedHeap()
IMPORT_C TIntWillResumePlay()
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CMdaAudioClipUtility::ClipUtil_Reserved3()
CMdaAudioClipUtility::ClipUtil_Reserved4()
CMdaAudioClipUtility::TypeL()
Public Member Enumerations
enumTDeviceMode { EDefault = 0, ETelephonyOrLocal = EDefault, ETelephonyMixed = 1, ETelephonyNonMixed = 2, ELocal = 3 }
Inherited Enumerations
CMdaAudioClipUtility:TState
Private Attributes
CMMFMdaAudioRecorderUtility *iProperties

Constructor & Destructor Documentation

~CMdaAudioRecorderUtility()

~CMdaAudioRecorderUtility()[virtual]

Member Functions Documentation

AddMetaDataEntryL(CMMFMetaDataEntry &)

IMPORT_C voidAddMetaDataEntryL(CMMFMetaDataEntry &aMetaDataEntry)

Parameters

CMMFMetaDataEntry & aMetaDataEntry

AudioPlayControllerImplementationInformationL()

IMPORT_C const CMMFControllerImplementationInformation &AudioPlayControllerImplementationInformationL()

AudioRecorderControllerImplementationInformationL()

IMPORT_C const CMMFControllerImplementationInformation &AudioRecorderControllerImplementationInformationL()

CancelRegisterAudioResourceNotification(TUid)

IMPORT_C TIntCancelRegisterAudioResourceNotification(TUidaNotificationEventId)

Parameters

TUid aNotificationEventId

ClearPlayWindow()

voidClearPlayWindow()[virtual]

Removes any window defined on the audio sample data.

All subsequent playing, position setting and position querying requests are mapped to the whole of the audio sample data.

5.0

Close()

voidClose()[virtual]

Releases any currently open audio sample data.

5.0

CropFromBeginningL()

voidCropFromBeginningL()[virtual]

Deletes all audio sample data from the beginning of the audio clip. The effects of the function cannot be undone.

The function is synchronous and can leave if there is a problem. The leave code depends on the configuration.

5.0

CropL()

voidCropL()[virtual]

Deletes all audio sample data after the current head position. The effects of the function cannot be undone.

The function is synchronous and can leave if there is a problem. The leave code depends on the configuration.

5.0

DestinationBitRateL()

IMPORT_C TUintDestinationBitRateL()

DestinationDataTypeL()

IMPORT_C TFourCCDestinationDataTypeL()

DestinationFormatL()

IMPORT_C TUidDestinationFormatL()

DestinationNumberOfChannelsL()

IMPORT_C TUintDestinationNumberOfChannelsL()

DestinationSampleRateL()

IMPORT_C TUintDestinationSampleRateL()

Duration()

const TTimeIntervalMicroSeconds &Duration()[virtual]

Returns the duration of the audio sample data.

5.0

Duration(TTimeIntervalMicroSeconds &)

IMPORT_C TMMFDurationInfoDuration(TTimeIntervalMicroSeconds &aDuration)

Parameters

TTimeIntervalMicroSeconds & aDuration

GetAudioLoadingProgressL(TInt &)

IMPORT_C voidGetAudioLoadingProgressL(TInt &aPercentageComplete)

Parameters

TInt & aPercentageComplete

GetDRMCustomCommand()

IMPORT_C MMMFDRMCustomCommand *GetDRMCustomCommand()

GetGain(TInt &)

IMPORT_C TIntGetGain(TInt &aGain)

Parameters

TInt & aGain

GetMetaDataEntryL(TInt)

IMPORT_C CMMFMetaDataEntry *GetMetaDataEntryL(TIntaMetaDataIndex)

Parameters

TInt aMetaDataIndex

GetNumberOfMetaDataEntries(TInt &)

IMPORT_C TIntGetNumberOfMetaDataEntries(TInt &aNumEntries)

Parameters

TInt & aNumEntries

GetPlaybackBalance(TInt &)

IMPORT_C TIntGetPlaybackBalance(TInt &aBalance)

Parameters

TInt & aBalance

GetRecordBalance(TInt &)

IMPORT_C TIntGetRecordBalance(TInt &aBalance)

Parameters

TInt & aBalance

GetSupportedBitRatesL(RArray< TUint > &)

IMPORT_C voidGetSupportedBitRatesL(RArray< TUint > &aSupportedBitRates)

Parameters

RArray< TUint > & aSupportedBitRates

GetSupportedDestinationDataTypesL(RArray< TFourCC > &)

IMPORT_C voidGetSupportedDestinationDataTypesL(RArray< TFourCC > &aSupportedDataTypes)

Parameters

RArray< TFourCC > & aSupportedDataTypes

GetSupportedNumberOfChannelsL(RArray< TUint > &)

IMPORT_C voidGetSupportedNumberOfChannelsL(RArray< TUint > &aSupportedNumChannels)

Parameters

RArray< TUint > & aSupportedNumChannels

GetSupportedSampleRatesL(RArray< TUint > &)

IMPORT_C voidGetSupportedSampleRatesL(RArray< TUint > &aSupportedSampleRates)

Parameters

RArray< TUint > & aSupportedSampleRates

GetVolume(TInt &)

IMPORT_C TIntGetVolume(TInt &aVolume)

Parameters

TInt & aVolume

MaxGain()

TInt MaxGain()[virtual]

MaxVolume()

TInt MaxVolume()[virtual]

NewL(MMdaObjectStateChangeObserver &, CMdaServer *, TInt, TInt)

IMPORT_C CMdaAudioRecorderUtility *NewL(MMdaObjectStateChangeObserver &aObserver,
CMdaServer *aServer = NULL,
TIntaPriority = EMdaPriorityNormal,
TIntaPref = EMdaPriorityPreferenceTimeAndQuality
)[static]

Parameters

MMdaObjectStateChangeObserver & aObserver
CMdaServer * aServer = NULL
TInt aPriority = EMdaPriorityNormal
TInt aPref = EMdaPriorityPreferenceTimeAndQuality

OpenDesL(const TDesC8 &)

voidOpenDesL(const TDesC8 &aDescriptor)[virtual]

Parameters

const TDesC8 & aDescriptor

OpenDesL(TDes8 &)

IMPORT_C voidOpenDesL(TDes8 &aDescriptor)

Parameters

TDes8 & aDescriptor

OpenDesL(TDes8 &, TUid, TUid, TUid, TFourCC)

IMPORT_C voidOpenDesL(TDes8 &aDescriptor,
TUidaRecordControllerUid,
TUidaPlaybackControllerUid = KNullUid,
TUidaDestinationFormatUid = KNullUid,
TFourCCaDestinationDataType =  KFourCCNULL
)

Parameters

TDes8 & aDescriptor
TUid aRecordControllerUid
TUid aPlaybackControllerUid = KNullUid
TUid aDestinationFormatUid = KNullUid
TFourCC aDestinationDataType =  KFourCCNULL

OpenFileL(const TDesC &)

voidOpenFileL(const TDesC &aFileName)[virtual]

Parameters

const TDesC & aFileName

OpenFileL(const RFile &)

IMPORT_C voidOpenFileL(const RFile &aFile)

Parameters

const RFile & aFile

OpenFileL(const TMMSource &)

IMPORT_C voidOpenFileL(const TMMSource &aSource)

Parameters

const TMMSource & aSource

OpenFileL(const TDesC &, TUid, TUid, TUid, TFourCC)

IMPORT_C voidOpenFileL(const TDesC &aFileName,
TUidaRecordControllerUid,
TUidaPlaybackControllerUid = KNullUid,
TUidaDestinationFormatUid = KNullUid,
TFourCCaDestinationDataType =  KFourCCNULL
)

Parameters

const TDesC & aFileName
TUid aRecordControllerUid
TUid aPlaybackControllerUid = KNullUid
TUid aDestinationFormatUid = KNullUid
TFourCC aDestinationDataType =  KFourCCNULL

OpenFileL(const RFile &, TUid, TUid, TUid, TFourCC)

IMPORT_C voidOpenFileL(const RFile &aFile,
TUidaRecordControllerUid,
TUidaPlaybackControllerUid = KNullUid,
TUidaDestinationFormatUid = KNullUid,
TFourCCaDestinationDataType =  KFourCCNULL
)

Parameters

const RFile & aFile
TUid aRecordControllerUid
TUid aPlaybackControllerUid = KNullUid
TUid aDestinationFormatUid = KNullUid
TFourCC aDestinationDataType =  KFourCCNULL

OpenFileL(const TMMSource &, TUid, TUid, TUid, TFourCC)

IMPORT_C voidOpenFileL(const TMMSource &aSource,
TUidaRecordControllerUid,
TUidaPlaybackControllerUid = KNullUid,
TUidaDestinationFormatUid = KNullUid,
TFourCCaDestinationDataType =  KFourCCNULL
)

Parameters

const TMMSource & aSource
TUid aRecordControllerUid
TUid aPlaybackControllerUid = KNullUid
TUid aDestinationFormatUid = KNullUid
TFourCC aDestinationDataType =  KFourCCNULL

OpenL(TMdaClipLocation *, TMdaClipFormat *, TMdaPackage *, TMdaPackage *)

voidOpenL(TMdaClipLocation *aLocation,
TMdaClipFormat *aFormat,
TMdaPackage *aArg1 = NULL,
TMdaPackage *aArg2 = NULL
)[virtual]

Parameters

TMdaClipLocation * aLocation
TMdaClipFormat * aFormat
TMdaPackage * aArg1 = NULL
TMdaPackage * aArg2 = NULL

OpenUrlL(const TDesC &, TInt, TUid, TUid, TUid, TFourCC)

IMPORT_C voidOpenUrlL(const TDesC &aUrl,
TIntaIapId,
TUidaRecordControllerUid,
TUidaPlaybackControllerUid = KNullUid,
TUidaDestinationFormatUid = KNullUid,
TFourCCaDestinationDataType =  KFourCCNULL
)

Parameters

const TDesC & aUrl
TInt aIapId
TUid aRecordControllerUid
TUid aPlaybackControllerUid = KNullUid
TUid aDestinationFormatUid = KNullUid
TFourCC aDestinationDataType =  KFourCCNULL

OpenUrlL(const TDesC &, TInt, const TDesC8 &)

IMPORT_C voidOpenUrlL(const TDesC &aUrl,
TIntaIapId =  KUseDefaultIap ,
const TDesC8 &aMimeType =  KNullDesC8
)

Parameters

const TDesC & aUrl
TInt aIapId =  KUseDefaultIap
const TDesC8 & aMimeType =  KNullDesC8

PlayControllerCustomCommandAsync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &, TDes8 &, TRequestStatus &)

IMPORT_C voidPlayControllerCustomCommandAsync(const TMMFMessageDestinationPckg &aDestination,
TIntaFunction,
const TDesC8 &aDataTo1,
const TDesC8 &aDataTo2,
TDes8 &aDataFrom,
TRequestStatus &aStatus
)

Parameters

const TMMFMessageDestinationPckg & aDestination
TInt aFunction
const TDesC8 & aDataTo1
const TDesC8 & aDataTo2
TDes8 & aDataFrom
TRequestStatus & aStatus

PlayControllerCustomCommandAsync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &, TRequestStatus &)

IMPORT_C voidPlayControllerCustomCommandAsync(const TMMFMessageDestinationPckg &aDestination,
TIntaFunction,
const TDesC8 &aDataTo1,
const TDesC8 &aDataTo2,
TRequestStatus &aStatus
)

Parameters

const TMMFMessageDestinationPckg & aDestination
TInt aFunction
const TDesC8 & aDataTo1
const TDesC8 & aDataTo2
TRequestStatus & aStatus

PlayControllerCustomCommandSync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &, TDes8 &)

IMPORT_C TIntPlayControllerCustomCommandSync(const TMMFMessageDestinationPckg &aDestination,
TIntaFunction,
const TDesC8 &aDataTo1,
const TDesC8 &aDataTo2,
TDes8 &aDataFrom
)

Parameters

const TMMFMessageDestinationPckg & aDestination
TInt aFunction
const TDesC8 & aDataTo1
const TDesC8 & aDataTo2
TDes8 & aDataFrom

PlayControllerCustomCommandSync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &)

IMPORT_C TIntPlayControllerCustomCommandSync(const TMMFMessageDestinationPckg &aDestination,
TIntaFunction,
const TDesC8 &aDataTo1,
const TDesC8 &aDataTo2
)

Parameters

const TMMFMessageDestinationPckg & aDestination
TInt aFunction
const TDesC8 & aDataTo1
const TDesC8 & aDataTo2

PlayL()

voidPlayL()[virtual]

Begins playback of audio sample data at the current playback position using the current volume, gain and priority settings.

5.0

Position()

const TTimeIntervalMicroSeconds &Position()[virtual]

Returns the current head position.

The head position is defined in terms of a time interval measured from the beginning of the audio sample data.

5.0

RecordControllerCustomCommandAsync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &, TDes8 &, TRequestStatus &)

IMPORT_C voidRecordControllerCustomCommandAsync(const TMMFMessageDestinationPckg &aDestination,
TIntaFunction,
const TDesC8 &aDataTo1,
const TDesC8 &aDataTo2,
TDes8 &aDataFrom,
TRequestStatus &aStatus
)

Parameters

const TMMFMessageDestinationPckg & aDestination
TInt aFunction
const TDesC8 & aDataTo1
const TDesC8 & aDataTo2
TDes8 & aDataFrom
TRequestStatus & aStatus

RecordControllerCustomCommandAsync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &, TRequestStatus &)

IMPORT_C voidRecordControllerCustomCommandAsync(const TMMFMessageDestinationPckg &aDestination,
TIntaFunction,
const TDesC8 &aDataTo1,
const TDesC8 &aDataTo2,
TRequestStatus &aStatus
)

Parameters

const TMMFMessageDestinationPckg & aDestination
TInt aFunction
const TDesC8 & aDataTo1
const TDesC8 & aDataTo2
TRequestStatus & aStatus

RecordControllerCustomCommandSync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &, TDes8 &)

IMPORT_C TIntRecordControllerCustomCommandSync(const TMMFMessageDestinationPckg &aDestination,
TIntaFunction,
const TDesC8 &aDataTo1,
const TDesC8 &aDataTo2,
TDes8 &aDataFrom
)

Parameters

const TMMFMessageDestinationPckg & aDestination
TInt aFunction
const TDesC8 & aDataTo1
const TDesC8 & aDataTo2
TDes8 & aDataFrom

RecordControllerCustomCommandSync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &)

IMPORT_C TIntRecordControllerCustomCommandSync(const TMMFMessageDestinationPckg &aDestination,
TIntaFunction,
const TDesC8 &aDataTo1,
const TDesC8 &aDataTo2
)

Parameters

const TMMFMessageDestinationPckg & aDestination
TInt aFunction
const TDesC8 & aDataTo1
const TDesC8 & aDataTo2

RecordL()

voidRecordL()[virtual]

Starts appending new audio sample data.

The new audio sample data is appended to the existing audio sample data in the same format as the existing audio sample data. If existing data is to be overwritten, then it should be cropped to the appropriate length before appending the new data.

Note, before starting to record, make sure that the gain is set by calling CMdaAudioRecorderUtility::SetGain(), as the initial gain is undefined. The gain might also have been modified by another client application.

5.0

CMdaAudioRecorderUtility

CMdaAudioRecorderUtility::SetGain()

RecordTimeAvailable()

const TTimeIntervalMicroSeconds &RecordTimeAvailable()[virtual]

Returns the recording time available for the selected file or descriptor and encoding format.

5.0

RegisterAudioResourceNotification(MMMFAudioResourceNotificationCallback &, TUid, const TDesC8 &)

IMPORT_C TIntRegisterAudioResourceNotification(MMMFAudioResourceNotificationCallback &aCallback,
TUidaNotificationEventUid,
const TDesC8 &aNotificationRegistrationData =  KNullDesC8
)

Parameters

MMMFAudioResourceNotificationCallback & aCallback
TUid aNotificationEventUid
const TDesC8 & aNotificationRegistrationData =  KNullDesC8

RegisterForAudioLoadingNotification(MAudioLoadingObserver &)

IMPORT_C voidRegisterForAudioLoadingNotification(MAudioLoadingObserver &aCallback)

Parameters

MAudioLoadingObserver & aCallback

RemoveMetaDataEntry(TInt)

IMPORT_C TIntRemoveMetaDataEntry(TIntaMetaDataIndex)

Parameters

TInt aMetaDataIndex

ReplaceMetaDataEntryL(TInt, CMMFMetaDataEntry &)

IMPORT_C voidReplaceMetaDataEntryL(TIntaMetaDataIndex,
CMMFMetaDataEntry &aMetaDataEntry
)

Parameters

TInt aMetaDataIndex
CMMFMetaDataEntry & aMetaDataEntry

SetAudioDeviceMode(TDeviceMode)

voidSetAudioDeviceMode(TDeviceModeaMode)[virtual]

Parameters

TDeviceMode aMode

SetDestinationBitRateL(TUint)

IMPORT_C voidSetDestinationBitRateL(TUintaBitRate)

Parameters

TUint aBitRate

SetDestinationDataTypeL(TFourCC)

IMPORT_C voidSetDestinationDataTypeL(TFourCCaDataType)

Parameters

TFourCC aDataType

SetDestinationFormatL(TUid)

IMPORT_C voidSetDestinationFormatL(TUidaFormatUid)

Parameters

TUid aFormatUid

SetDestinationNumberOfChannelsL(TUint)

IMPORT_C voidSetDestinationNumberOfChannelsL(TUintaNumberOfChannels)

Parameters

TUint aNumberOfChannels

SetDestinationSampleRateL(TUint)

IMPORT_C voidSetDestinationSampleRateL(TUintaSampleRate)

Parameters

TUint aSampleRate

SetGain(TInt)

voidSetGain(TIntaGain)[virtual]

Parameters

TInt aGain

SetMaxWriteLength(TInt)

voidSetMaxWriteLength(TIntaMaxWriteLength =  KMdaClipLocationMaxWriteLengthNone )[virtual]

Sets the maximum size for a file that is being recorded.

When this limit is reached, MMF stops recording and notifies the client application. Notification is caused by MMdaObjectStateChangeObserver::MoscoStateChangeEvent() with the error code KErrEof.

This function is provided so that applications such as recorders can limit the amount of file storage/memory that should be allocated.

5.0

Parameters

TInt aMaxWriteLength =  KMdaClipLocationMaxWriteLengthNone The maximum file size in kilobytes. If the default value is used, there is no maximum file size.

SetPlayWindow(const TTimeIntervalMicroSeconds &, const TTimeIntervalMicroSeconds &)

voidSetPlayWindow(const TTimeIntervalMicroSeconds &aStart,
const TTimeIntervalMicroSeconds &aEnd
)[virtual]

Defines a window on the audio sample data.

The window is defined in terms of a start and end position. When the current playback position reaches the window end position, or Stop() is called, the current playback position is set to the window start position and playback stops.

The current playback position is not affected by a call to SetPlayWindow() unless it is outside the new playback window, in which case it is set to the window start or end position depending on which one is closer.

The window persists until ClearPlayWindow() is called. Loading new audio sample data without adjusting or clearing the window will result in playback errors if the window is outside the new data.

5.0

Parameters

const TTimeIntervalMicroSeconds & aStartThe position defining the start of the window, measured in microseconds. If this value is less than zero, it is set to zero. If this value is greater than aEnd, then it is swapped with aEnd.
const TTimeIntervalMicroSeconds & aEndThe position defining the end of the window, measured in microseconds. If this value is greater than the value returned by Duration(), it is set to the value of Duration(). If this value is less than aStart, then it is swapped with aStart.

SetPlaybackBalance(TInt)

IMPORT_C TIntSetPlaybackBalance(TIntaBalance =  KMMFBalanceCenter )

Parameters

TInt aBalance =  KMMFBalanceCenter

SetPosition(const TTimeIntervalMicroSeconds &)

voidSetPosition(const TTimeIntervalMicroSeconds &aPosition)[virtual]

Sets the head position.

The playback head is moved to a position which is defined in terms of a time interval measured from the beginning of the audio sample data. A subsequent call to PlayL() starts from this new position.

5.0

Parameters

const TTimeIntervalMicroSeconds & aPosition

SetPriority(TInt, TInt)

IMPORT_C voidSetPriority(TIntaPriority,
TIntaPref
)

Parameters

TInt aPriority
TInt aPref

SetRecordBalance(TInt)

IMPORT_C TIntSetRecordBalance(TIntaBalance =  KMMFBalanceCenter )

Parameters

TInt aBalance =  KMMFBalanceCenter

SetRepeats(TInt, const TTimeIntervalMicroSeconds &)

voidSetRepeats(TIntaRepeatNumberOfTimes,
const TTimeIntervalMicroSeconds &aTrailingSilence
)[virtual]

Sets the number of times the audio sample is to be repeated during the PlayL() operation.

A period of silence can follow each playing of the audio sample. The audio sample can be repeated indefinitely or until stopped.

5.0

Parameters

TInt aRepeatNumberOfTimesThe number of times the audio sample, together with the trailing silence, is to be repeated. If this is set to KMdaRepeatForever, then the audio sample, together with the trailing silence, is repeated indefinitely. If this is set to zero, then the audio sample is not repeated.
const TTimeIntervalMicroSeconds & aTrailingSilenceThe length of the trailing silence in microseconds.

SetThreadPriorityPlayback(const TThreadPriority &)

IMPORT_C TIntSetThreadPriorityPlayback(const TThreadPriority &aThreadPriority)const

Parameters

const TThreadPriority & aThreadPriority

SetThreadPriorityRecord(const TThreadPriority &)

IMPORT_C TIntSetThreadPriorityRecord(const TThreadPriority &aThreadPriority)const

Parameters

const TThreadPriority & aThreadPriority

SetVolume(TInt)

TInt SetVolume(TIntaVolume)[virtual]

Parameters

TInt aVolume

SetVolumeRamp(const TTimeIntervalMicroSeconds &)

voidSetVolumeRamp(const TTimeIntervalMicroSeconds &aRampDuration)[virtual]

Parameters

const TTimeIntervalMicroSeconds & aRampDuration

SourceBitRateL()

IMPORT_C TUintSourceBitRateL()

State()

TState State()[virtual]

Returns the current state of the audio sample data.

The state of the audio sample data.

5.0

Stop()

voidStop()[virtual]

Stops the playback or recording operation.

The operation is stopped at the current location. For a playback operation, the head is positioned at the last played data.

5.0

UseSharedHeap()

IMPORT_C voidUseSharedHeap()

WillResumePlay()

IMPORT_C TIntWillResumePlay()

Member Enumerations Documentation

Enum TDeviceMode

Device mode. Used by SetAudioDeviceMode method which is not used from 7.0s 5.0

Enumerators

EDefault = 0

The default behaviour.

When recording: If a telephony call is in progress, an attempt is made to connect to the telephony downlink plus the device microphone. If there is no telephony call in progress or a connection to the telephony downlink fails, an attempt is made to connect to the device microphone only.

When playing: If a telephony call is in progress, an attempt is made to connect to the telephony uplink. If there is no telephony call in progress or a connection to the telephony uplink fails, an attempt is made to connect to the device speaker.

ETelephonyOrLocal = EDefault

See EDefault.

ETelephonyMixed = 1

When recording: If a telephony call is in progress the audio source is the telephony downlink mixed with the device microphone. If there is no telephony call in progress or a connection to the telephony downlink fails, no attempt is made to connect to the microphone.

When playing: If a telephony call is in progress the audio sample data is played to the telephony uplink and the device speaker. If there is no telephony call in progress or a connection to the telephony uplink fails, no attempt is made to connect to the device speaker.

ETelephonyNonMixed = 2

When recording, the audio source is the telephony downlink and is not mixed with the device microphone.

When playing, the audio sample data is played to the telephony uplink and is not mixed with the device speaker.

ELocal = 3

When recording, the audio source is the device microphone.

When playing, the audio sample data is played to the device speaker.

Member Data Documentation

CMMFMdaAudioRecorderUtility * iProperties

CMMFMdaAudioRecorderUtility *iProperties[private]
© Nokia 2010.