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 void AddMetaDataEntryL ( CMMFMetaDataEntry &)
IMPORT_C const CMMFControllerImplementationInformation & AudioPlayControllerImplementationInformationL ()
IMPORT_C const CMMFControllerImplementationInformation & AudioRecorderControllerImplementationInformationL ()
IMPORT_C TInt CancelRegisterAudioResourceNotification ( TUid )
void ClearPlayWindow ()
void Close ()
void CropFromBeginningL ()
void CropL ()
IMPORT_C TUint DestinationBitRateL ()
IMPORT_C TFourCC DestinationDataTypeL ()
IMPORT_C TUid DestinationFormatL ()
IMPORT_C TUint DestinationNumberOfChannelsL ()
IMPORT_C TUint DestinationSampleRateL ()
const TTimeIntervalMicroSeconds & Duration ()
IMPORT_C TMMFDurationInfo Duration ( TTimeIntervalMicroSeconds &)
IMPORT_C void GetAudioLoadingProgressL ( TInt &)
IMPORT_C MMMFDRMCustomCommand * GetDRMCustomCommand ()
IMPORT_C TInt GetGain ( TInt &)
IMPORT_C CMMFMetaDataEntry * GetMetaDataEntryL ( TInt )
IMPORT_C TInt GetNumberOfMetaDataEntries ( TInt &)
IMPORT_C TInt GetPlaybackBalance ( TInt &)
IMPORT_C TInt GetRecordBalance ( TInt &)
IMPORT_C void GetSupportedBitRatesL ( RArray < TUint > &)
IMPORT_C void GetSupportedDestinationDataTypesL ( RArray < TFourCC > &)
IMPORT_C void GetSupportedNumberOfChannelsL ( RArray < TUint > &)
IMPORT_C void GetSupportedSampleRatesL ( RArray < TUint > &)
IMPORT_C TInt GetVolume ( TInt &)
TInt MaxGain ()
TInt MaxVolume ()
IMPORT_C CMdaAudioRecorderUtility * NewL ( MMdaObjectStateChangeObserver &, CMdaServer *, TInt , TInt )
void OpenDesL (const TDesC8 &)
IMPORT_C void OpenDesL ( TDes8 &)
IMPORT_C void OpenDesL ( TDes8 &, TUid , TUid , TUid , TFourCC )
void OpenFileL (const TDesC &)
IMPORT_C void OpenFileL (const RFile &)
IMPORT_C void OpenFileL (const TMMSource &)
IMPORT_C void OpenFileL (const TDesC &, TUid , TUid , TUid , TFourCC )
IMPORT_C void OpenFileL (const RFile &, TUid , TUid , TUid , TFourCC )
IMPORT_C void OpenFileL (const TMMSource &, TUid , TUid , TUid , TFourCC )
void OpenL ( TMdaClipLocation *, TMdaClipFormat *, TMdaPackage *, TMdaPackage *)
IMPORT_C void OpenUrlL (const TDesC &, TInt , TUid , TUid , TUid , TFourCC )
IMPORT_C void OpenUrlL (const TDesC &, TInt , const TDesC8 &)
IMPORT_C void PlayControllerCustomCommandAsync (const TMMFMessageDestinationPckg &, TInt , const TDesC8 &, const TDesC8 &, TDes8 &, TRequestStatus &)
IMPORT_C void PlayControllerCustomCommandAsync (const TMMFMessageDestinationPckg &, TInt , const TDesC8 &, const TDesC8 &, TRequestStatus &)
IMPORT_C TInt PlayControllerCustomCommandSync (const TMMFMessageDestinationPckg &, TInt , const TDesC8 &, const TDesC8 &, TDes8 &)
IMPORT_C TInt PlayControllerCustomCommandSync (const TMMFMessageDestinationPckg &, TInt , const TDesC8 &, const TDesC8 &)
void PlayL ()
const TTimeIntervalMicroSeconds & Position ()
IMPORT_C void RecordControllerCustomCommandAsync (const TMMFMessageDestinationPckg &, TInt , const TDesC8 &, const TDesC8 &, TDes8 &, TRequestStatus &)
IMPORT_C void RecordControllerCustomCommandAsync (const TMMFMessageDestinationPckg &, TInt , const TDesC8 &, const TDesC8 &, TRequestStatus &)
IMPORT_C TInt RecordControllerCustomCommandSync (const TMMFMessageDestinationPckg &, TInt , const TDesC8 &, const TDesC8 &, TDes8 &)
IMPORT_C TInt RecordControllerCustomCommandSync (const TMMFMessageDestinationPckg &, TInt , const TDesC8 &, const TDesC8 &)
void RecordL ()
const TTimeIntervalMicroSeconds & RecordTimeAvailable ()
IMPORT_C TInt RegisterAudioResourceNotification ( MMMFAudioResourceNotificationCallback &, TUid , const TDesC8 &)
IMPORT_C void RegisterForAudioLoadingNotification ( MAudioLoadingObserver &)
IMPORT_C TInt RemoveMetaDataEntry ( TInt )
IMPORT_C void ReplaceMetaDataEntryL ( TInt , CMMFMetaDataEntry &)
void SetAudioDeviceMode ( TDeviceMode )
IMPORT_C void SetDestinationBitRateL ( TUint )
IMPORT_C void SetDestinationDataTypeL ( TFourCC )
IMPORT_C void SetDestinationFormatL ( TUid )
IMPORT_C void SetDestinationNumberOfChannelsL ( TUint )
IMPORT_C void SetDestinationSampleRateL ( TUint )
void SetGain ( TInt )
void SetMaxWriteLength ( TInt )
void SetPlayWindow (const TTimeIntervalMicroSeconds &, const TTimeIntervalMicroSeconds &)
IMPORT_C TInt SetPlaybackBalance ( TInt )
void SetPosition (const TTimeIntervalMicroSeconds &)
IMPORT_C void SetPriority ( TInt , TInt )
IMPORT_C TInt SetRecordBalance ( TInt )
void SetRepeats ( TInt , const TTimeIntervalMicroSeconds &)
IMPORT_C TInt SetThreadPriorityPlayback (const TThreadPriority &)
IMPORT_C TInt SetThreadPriorityRecord (const TThreadPriority &)
TInt SetVolume ( TInt )
void SetVolumeRamp (const TTimeIntervalMicroSeconds &)
IMPORT_C TUint SourceBitRateL ()
TState State ()
void Stop ()
IMPORT_C void UseSharedHeap ()
IMPORT_C TInt WillResumePlay ()
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
enum TDeviceMode { EDefault  = 0, ETelephonyOrLocal  = EDefault, ETelephonyMixed  = 1, ETelephonyNonMixed  = 2, ELocal  = 3 }
Inherited Enumerations
CMdaAudioClipUtility:TState
Private Attributes
CMMFMdaAudioRecorderUtility * iProperties

Constructor & Destructor Documentation

~CMdaAudioRecorderUtility()

~CMdaAudioRecorderUtility ( ) [virtual]

Destructor. Closes the audio clip and frees resources.

Since
5.0

Member Functions Documentation

AddMetaDataEntryL(CMMFMetaDataEntry &)

IMPORT_C void AddMetaDataEntryL ( CMMFMetaDataEntry & aMetaDataEntry )

Adds a meta data entry to the audio clip.

Since
7.0s

Parameters

CMMFMetaDataEntry & aMetaDataEntry The new meta data entry to add to the clip.

AudioPlayControllerImplementationInformationL()

IMPORT_C const CMMFControllerImplementationInformation & AudioPlayControllerImplementationInformationL ( )

Returns the controller implementation information associated with the playback controller

Since
7.0s

AudioRecorderControllerImplementationInformationL()

IMPORT_C const CMMFControllerImplementationInformation & AudioRecorderControllerImplementationInformationL ( )

Returns the controller implementation information associated with the recording controller.

Since
7.0s

CancelRegisterAudioResourceNotification(TUid)

IMPORT_C TInt CancelRegisterAudioResourceNotification ( TUid aNotificationEventId )

Cancels the registered notification event.

Parameters

TUid aNotificationEventId The Event to notify the client.

ClearPlayWindow()

void ClearPlayWindow ( ) [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.

Since
5.0

Close()

void Close ( ) [virtual]

Close the current audio clip.

Since
5.0

CropFromBeginningL()

void CropFromBeginningL ( ) [virtual]

Deletes all audio sample data from the beginning of the audio clip to the current 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.

Since
7.0s

CropL()

void CropL ( ) [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.

Since
5.0

DestinationBitRateL()

IMPORT_C TUint DestinationBitRateL ( )

Returns the bit rate in bits per second that the data sink is currently set to.

Since
7.0s

DestinationDataTypeL()

IMPORT_C TFourCC DestinationDataTypeL ( )

Returns the codec that is currently set for the destination audio clip.

Since
7.0s

DestinationFormatL()

IMPORT_C TUid DestinationFormatL ( )

Returns the format(UID) of the destination audio clip.

Since
7.0s

DestinationNumberOfChannelsL()

IMPORT_C TUint DestinationNumberOfChannelsL ( )

Returns the number of channels that the destination audio clip is currently configured to support.

Since
7.0s

DestinationSampleRateL()

IMPORT_C TUint DestinationSampleRateL ( )

Returns the sample rate in samples/second that the destination data sink is currently set to.

Since
7.0s

Duration()

const TTimeIntervalMicroSeconds & Duration ( ) [virtual]

Returns the duration of the audio clip.

Since
5.0

Duration(TTimeIntervalMicroSeconds &)

IMPORT_C TMMFDurationInfo Duration ( TTimeIntervalMicroSeconds & aDuration )

Returns the duration of the audio sample in microseconds, and the duration state.

The function raises a CMdaAudioPlayerUtility 1 panic if the audio player utility is not initialised.

Since
9.1

Parameters

TTimeIntervalMicroSeconds & aDuration The duration of the sample in microseconds.

GetAudioLoadingProgressL(TInt &)

IMPORT_C void GetAudioLoadingProgressL ( TInt & aPercentageComplete )

Returns the current progress of audio loading.

Since
7.0s

Parameters

TInt & aPercentageComplete The percentage of the audio clip loaded.

GetDRMCustomCommand()

IMPORT_C MMMFDRMCustomCommand * GetDRMCustomCommand ( )

Gets a controller's DRM custom command implementation.

GetGain(TInt &)

IMPORT_C TInt GetGain ( TInt & aGain )

Returns the current gain setting of the audio device.

Since
7.0s

Parameters

TInt & aGain On return contains the current gain setting for the audio device. Can be any value between zero and MaxGain().

GetMetaDataEntryL(TInt)

IMPORT_C CMMFMetaDataEntry * GetMetaDataEntryL ( TInt aMetaDataIndex )

Returns the specified meta data entry from the current audio clip.

Since
7.0s

Parameters

TInt aMetaDataIndex The index of the entry to retrieve. The index is between 0 and GetNumberOfMetaDataEntries()-1

GetNumberOfMetaDataEntries(TInt &)

IMPORT_C TInt GetNumberOfMetaDataEntries ( TInt & aNumEntries )

Returns the number of meta data entries associated with this clip.

Since
7.0s

Parameters

TInt & aNumEntries On return contains the number of meta data entries.

GetPlaybackBalance(TInt &)

IMPORT_C TInt GetPlaybackBalance ( TInt & aBalance )

Returns The current balance setting for the audio device. This function may not return the same value as passed to SetPlaybackBalance depending on the internal implementation in the underlying components.

Since
7.0s

Parameters

TInt & aBalance The playback balance, between KMMFBalanceMaxLeft and KMMFBalanceMaxRight

GetRecordBalance(TInt &)

IMPORT_C TInt GetRecordBalance ( TInt & aBalance )

Returns the current recording balance setting between the left and right stereo microphones.

Since
7.0s

Parameters

TInt & aBalance On return, contains the current recording balance between KMMFBalanceMaxLeft and KMMFBalanceMaxRight

GetSupportedBitRatesL(RArray< TUint > &)

IMPORT_C void GetSupportedBitRatesL ( RArray < TUint > & aSupportedBitRates )

Returns a list of the supported bit rates for recording to the data sink.

Since
7.0s

Parameters

RArray < TUint > & aSupportedBitRates List of bit rates supported for the data sink destination.

GetSupportedDestinationDataTypesL(RArray< TFourCC > &)

IMPORT_C void GetSupportedDestinationDataTypesL ( RArray < TFourCC > & aSupportedDataTypes )

Returns a list of the supported codecs for the conversion destination.

Since
7.0s

Parameters

RArray < TFourCC > & aSupportedDataTypes List of four character codes, representing supported data codecs for the conversion destination.

GetSupportedNumberOfChannelsL(RArray< TUint > &)

IMPORT_C void GetSupportedNumberOfChannelsL ( RArray < TUint > & aSupportedNumChannels )

Returns a list of the supported number of channels for recording. For example 1 for mono, 2 for stereo and so on.

Since
7.0s

Parameters

RArray < TUint > & aSupportedNumChannels On return, contains a list of the number of channels supported for recording

GetSupportedSampleRatesL(RArray< TUint > &)

IMPORT_C void GetSupportedSampleRatesL ( RArray < TUint > & aSupportedSampleRates )

If a destination sample rate has not been set then GetSupportedSampleRatesL() returns all valid sample rates

If a destination sample rate has been set then GetSupportedSampleRatesL() returns all valid sample rates less than or equal to the destination sample rate

Since
7.0s

Parameters

RArray < TUint > & aSupportedSampleRates On return, contains a list of the sample rates that are supported for recording.

GetVolume(TInt &)

IMPORT_C TInt GetVolume ( TInt & aVolume )

Returns the current volume setting for the audio device.

Since
7.0s

Parameters

TInt & aVolume On return contains the current volume setting of the audio device. Can be any value between zero and MaxVolume().

MaxGain()

TInt MaxGain ( ) [virtual]

Return the maximum value for the gain

Since
5.0

MaxVolume()

TInt MaxVolume ( ) [virtual]

Returns the maximum volume setting for the audio device.

Since
5.0

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

IMPORT_C CMdaAudioRecorderUtility * NewL ( MMdaObjectStateChangeObserver & aObserver,
CMdaServer * aServer = NULL,
TInt aPriority = EMdaPriorityNormal,
TInt aPref = EMdaPriorityPreferenceTimeAndQuality
) [static]

Constructs and initialises a new instance of the audio recorder for playing, recording and editing audio sample data.

The function leaves if the audio recorder object cannot be created.

Since
5.0
Note: The Priority Value and Priority Preference are used primarily when deciding what to do when several audio clients attempt to play or record simultaneously. In addition to the Priority Value and Preference, the adaptation may consider other parameters such as the SecureId and Capabilities of the client process. Whatever, the decision as to what to do in such situations is up to the audio adaptation, and may vary between different phones. Portable applications are advised not to assume any specific behaviour.

Parameters

MMdaObjectStateChangeObserver & aObserver Class to receive state change events from recorder
CMdaServer * aServer = NULL No longer used, should be NULL
TInt aPriority = EMdaPriorityNormal The Priority Value - this client's relative priority. This is a value between EMdaPriorityMin and EMdaPriorityMax and represents a relative priority. A higher value indicates a more important request.
TInt aPref = EMdaPriorityPreferenceTimeAndQuality The Priority Preference - an additional audio policy parameter. The suggested default is EMdaPriorityPreferenceNone. Further values are given by TMdaPriorityPreference, and additional values may be supported by given phones and/or platforms, but should not be depended upon by portable code.

OpenDesL(const TDesC8 &)

void OpenDesL ( const TDesC8 & aDescriptor ) [virtual]

Opens a descriptor to play back or record audio sample data (const version).

Since
5.0

Parameters

const TDesC8 & aDescriptor The descriptor which is a source of existing audio sample data. This descriptor must remain in existence for the lifetime of this audio clip recorder object.

OpenDesL(TDes8 &)

IMPORT_C void OpenDesL ( TDes8 & aDescriptor )

Opens a descriptor to play back or record audio sample data.

Since
7.0s

Parameters

TDes8 & aDescriptor The descriptor which is a source of existing audio sample data. This descriptor must remain in existence for the lifetime of this audio clip recorder object.

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

IMPORT_C void OpenDesL ( TDes8 & aDescriptor,
TUid aRecordControllerUid,
TUid aPlaybackControllerUid = KNullUid,
TUid aDestinationFormatUid = KNullUid,
TFourCC aDestinationDataType =  KFourCCNULL
)

Opens an audio clip from a descriptor to play back existing audio data from or to record new audio data to.

Since
7.0s

Parameters

TDes8 & aDescriptor The descriptor that contains or will contain the audio data.
TUid aRecordControllerUid The UID of the controller to use for recording.
TUid aPlaybackControllerUid = KNullUid The UID of the controller to use for playback. If KNullUid is used then the same controller is used for playback and recording.
TUid aDestinationFormatUid = KNullUid The UID of the audio record format
TFourCC aDestinationDataType =  KFourCCNULL Data type for recording.

OpenFileL(const TDesC &)

void OpenFileL ( const TDesC & aFileName ) [virtual]

Opens a file to play back or record audio sample data.

Since
5.0

Parameters

const TDesC & aFileName The full path and filename of the file which is a source of existing audio sample data.

OpenFileL(const RFile &)

IMPORT_C void OpenFileL ( const RFile & aFile )

Opens a file to play back or record audio sample data.

Parameters

const RFile & aFile The full path and filename of the file which is a source of existing audio sample data.

OpenFileL(const TMMSource &)

IMPORT_C void OpenFileL ( const TMMSource & aSource )

Opens a file to play or record audio sample data.

Parameters

const TMMSource & aSource

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

IMPORT_C void OpenFileL ( const TDesC & aFileName,
TUid aRecordControllerUid,
TUid aPlaybackControllerUid = KNullUid,
TUid aDestinationFormatUid = KNullUid,
TFourCC aDestinationDataType =  KFourCCNULL
)

Opens an audio clip from a file to play back existing audio data or to record new audio data.

Since
7.0s

Parameters

const TDesC & aFileName The full path and filename of the file that contains or will contain the audio data.
TUid aRecordControllerUid The UID of the controller to use for recording.
TUid aPlaybackControllerUid = KNullUid The UID of the controller to use for playback. If KNullUid is used the same controller is used for playback and recording.
TUid aDestinationFormatUid = KNullUid The UID of record audio format.
TFourCC aDestinationDataType =  KFourCCNULL Data type for recording

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

IMPORT_C void OpenFileL ( const RFile & aFile,
TUid aRecordControllerUid,
TUid aPlaybackControllerUid = KNullUid,
TUid aDestinationFormatUid = KNullUid,
TFourCC aDestinationDataType =  KFourCCNULL
)

Opens an audio clip from a file to play back existing audio data or to record new audio data.

Parameters

const RFile & aFile The full path and filename of the file that contains or will contain the audio data.
TUid aRecordControllerUid The UID of the controller to use for recording.
TUid aPlaybackControllerUid = KNullUid The UID of the controller to use for playback. If KNullUid is used the same controller is used for playback and recording.
TUid aDestinationFormatUid = KNullUid The UID of record audio format.
TFourCC aDestinationDataType =  KFourCCNULL Data type for recording

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

IMPORT_C void OpenFileL ( const TMMSource & aSource,
TUid aRecordControllerUid,
TUid aPlaybackControllerUid = KNullUid,
TUid aDestinationFormatUid = KNullUid,
TFourCC aDestinationDataType =  KFourCCNULL
)

Opens an audio clip from a filename or an open file handle to play back existing audio data or to record new audio data.

Parameters

const TMMSource & aSource The full path and filename of the file or a fiule handle that contains or will contain the audio data.
TUid aRecordControllerUid The UID of the controller to use for recording.
TUid aPlaybackControllerUid = KNullUid The UID of the controller to use for playback. If KNullUid is used the same controller is used for playback and recording.
TUid aDestinationFormatUid = KNullUid The UID of record audio format.
TFourCC aDestinationDataType =  KFourCCNULL Data type for recording

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

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

Opens a TMdaClipLocation package of audio data that can be played back or recorded to.

Since
5.0

Parameters

TMdaClipLocation * aLocation The location of a source of existing audio sample data or a target for new audio sample data. This is normally a file name (a TMdaFileClipLocation) or a descriptor (a TMdaDesClipLocation).
TMdaClipFormat * aFormat The format of the audio clip.
TMdaPackage * aArg1 = NULL The codec/data type to use.
TMdaPackage * aArg2 = NULL The audio settings

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

IMPORT_C void OpenUrlL ( const TDesC & aUrl,
TInt aIapId,
TUid aRecordControllerUid,
TUid aPlaybackControllerUid = KNullUid,
TUid aDestinationFormatUid = KNullUid,
TFourCC aDestinationDataType =  KFourCCNULL
)

Opens an audio clip from a URL to play back existing audio data from or to record new audio data to.

Since
7.0s

Parameters

const TDesC & aUrl The URL that contains or will contain the audio data.
TInt aIapId The ID of the internet access point to use. KUseDefaultIap selects the default Internet access point.
TUid aRecordControllerUid The UID of the controller to use for recording.
TUid aPlaybackControllerUid = KNullUid The UID of the controller to use for playback. If KNullUid is used then the same controller is used for playback and recording.
TUid aDestinationFormatUid = KNullUid The UID of the audio record format.
TFourCC aDestinationDataType =  KFourCCNULL Data type for recording.

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

IMPORT_C void OpenUrlL ( const TDesC & aUrl,
TInt aIapId =  KUseDefaultIap ,
const TDesC8 & aMimeType =  KNullDesC8
)

Opens an audio clip from a URL to play back or record audio sample data.

Since
7.0s

Parameters

const TDesC & aUrl The URL that contains or will contain the audio data.
TInt aIapId =  KUseDefaultIap The ID of the internet access point to use. KUseDefaultIap selects the default Internet access point.
const TDesC8 & aMimeType =  KNullDesC8 The MIME type of the data pointed to by aUrl.

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

IMPORT_C void PlayControllerCustomCommandAsync ( const TMMFMessageDestinationPckg & aDestination,
TInt aFunction,
const TDesC8 & aDataTo1,
const TDesC8 & aDataTo2,
TDes8 & aDataFrom,
TRequestStatus & aStatus
)

Send a asynchronous custom command to the recording controller.

Note: This method will return immediately. The RunL of the active object owning the aStatus parameter will be called when the command is completed by the controller framework.
Since
7.0s

Parameters

const TMMFMessageDestinationPckg & aDestination The destination of the message, consisting of the uid of the interface of this message.
TInt aFunction The function number to indicate which function is to be called on the interface defined in the aDestination parameter.
const TDesC8 & aDataTo1 A reference to the first chunk of data to be copied to the controller framework. The exact contents of the data are dependent on the interface being called. Can be KNullDesC8.
const TDesC8 & aDataTo2 A reference to the second chunk of data to be copied to the controller framework. The exact contents of the data are dependent on the interface being called. Can be KNullDesC8.
TDes8 & aDataFrom A reference to an area of memory to which the controller framework will write any data to be passed back to the client. Can't be KNullDesC8.
TRequestStatus & aStatus The TRequestStatus of an active object. This will contain the result of the request on completion. The exact range of result values is dependent on the interface.

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

IMPORT_C void PlayControllerCustomCommandAsync ( const TMMFMessageDestinationPckg & aDestination,
TInt aFunction,
const TDesC8 & aDataTo1,
const TDesC8 & aDataTo2,
TRequestStatus & aStatus
)

Send a asynchronous custom command to the recording controller.

Note: This method will return immediately. The RunL of the active object owning the aStatus parameter will be called when the command is completed by the controller framework.

Since
7.0s

Parameters

const TMMFMessageDestinationPckg & aDestination The destination of the message, consisting of the uid of the interface of this message.
TInt aFunction The function number to indicate which function is to be called on the interface defined in the aDestination parameter.
const TDesC8 & aDataTo1 A reference to the first chunk of data to be copied to the controller framework. The exact contents of the data are dependent on the interface being called. Can be KNullDesC8.
const TDesC8 & aDataTo2 A reference to the second chunk of data to be copied to the controller framework. The exact contents of the data are dependent on the interface being called. Can be KNullDesC8.
TRequestStatus & aStatus The TRequestStatus of an active object. This will contain the result of the request on completion. The exact range of result values is dependent on the interface.

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

IMPORT_C TInt PlayControllerCustomCommandSync ( const TMMFMessageDestinationPckg & aDestination,
TInt aFunction,
const TDesC8 & aDataTo1,
const TDesC8 & aDataTo2,
TDes8 & aDataFrom
)

Send a synchronous custom command to the playback controller

Since
7.0s

Parameters

const TMMFMessageDestinationPckg & aDestination The destination of the message, consisting of the uid of the interface of this message.
TInt aFunction The function number to indicate which function is to be called on the interface defined in the aDestination parameter.
const TDesC8 & aDataTo1 A reference to the first chunk of data to be copied to the controller framework. The exact contents of the data are dependent on the interface being called. Can be KNullDesC8.
const TDesC8 & aDataTo2 A reference to the second chunk of data to be copied to the controller framework. The exact contents of the data are dependent on the interface being called. Can be KNullDesC8.
TDes8 & aDataFrom A reference to an area of memory to which the controller framework will write any data to be passed back to the client. Can't be KNullDesC8.

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

IMPORT_C TInt PlayControllerCustomCommandSync ( const TMMFMessageDestinationPckg & aDestination,
TInt aFunction,
const TDesC8 & aDataTo1,
const TDesC8 & aDataTo2
)

Send a synchronous custom command to the playback controller.

Since
7.0s

Parameters

const TMMFMessageDestinationPckg & aDestination The destination of the message, consisting of the uid of the interface of this message.
TInt aFunction The function number to indicate which function is to be called on the interface defined in the aDestination parameter.
const TDesC8 & aDataTo1 A reference to the first chunk of data to be copied to the controller framework. The exact contents of the data are dependent on the interface being called. Can be KNullDesC8.
const TDesC8 & aDataTo2 A reference to the second chunk of data to be copied to the controller framework. The exact contents of the data are dependent on the interface being called. Can be KNullDesC8.

PlayL()

void PlayL ( ) [virtual]

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

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

Since
5.0

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

IMPORT_C void RecordControllerCustomCommandAsync ( const TMMFMessageDestinationPckg & aDestination,
TInt aFunction,
const TDesC8 & aDataTo1,
const TDesC8 & aDataTo2,
TDes8 & aDataFrom,
TRequestStatus & aStatus
)

Send a asynchronous custom command to the recording controller.

Note: This method will return immediately. The RunL of the active object owning the aStatus parameter will be called when the command is completed by the controller framework.

Since
7.0s

Parameters

const TMMFMessageDestinationPckg & aDestination The destination of the message, consisting of the uid of the interface of this message.
TInt aFunction The function number to indicate which function is to be called on the interface defined in the aDestination parameter.
const TDesC8 & aDataTo1 A reference to the first chunk of data to be copied to the controller framework. The exact contents of the data are dependent on the interface being called. Can be KNullDesC8.
const TDesC8 & aDataTo2 A reference to the second chunk of data to be copied to the controller framework. The exact contents of the data are dependent on the interface being called. Can be KNullDesC8.
TDes8 & aDataFrom A reference to an area of memory to which the controller framework will write any data to be passed back to the client. Can't be KNullDesC8.
TRequestStatus & aStatus The TRequestStatus of an active object. This will contain the result of the request on completion. The exact range of result values is dependent on the interface.

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

IMPORT_C void RecordControllerCustomCommandAsync ( const TMMFMessageDestinationPckg & aDestination,
TInt aFunction,
const TDesC8 & aDataTo1,
const TDesC8 & aDataTo2,
TRequestStatus & aStatus
)

Send a asynchronous custom command to the recording controller

Note: This method will return immediately. The RunL of the active object owning the aStatus parameter will be called when the command is completed by the controller framework.

Since
7.0s

Parameters

const TMMFMessageDestinationPckg & aDestination The destination of the message, consisting of the uid of the interface of this message.
TInt aFunction The function number to indicate which function is to be called on the interface defined in the aDestination parameter.
const TDesC8 & aDataTo1 A reference to the first chunk of data to be copied to the controller framework. The exact contents of the data are dependent on the interface being called. Can be KNullDesC8.
const TDesC8 & aDataTo2 A reference to the second chunk of data to be copied to the controller framework. The exact contents of the data are dependent on the interface being called. Can be KNullDesC8.
TRequestStatus & aStatus The TRequestStatus of an active object. This will contain the result of the request on completion. The exact range of result values is dependent on the interface.

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

IMPORT_C TInt RecordControllerCustomCommandSync ( const TMMFMessageDestinationPckg & aDestination,
TInt aFunction,
const TDesC8 & aDataTo1,
const TDesC8 & aDataTo2,
TDes8 & aDataFrom
)

Sends a synchronous custom command to the recording controller.

Since
7.0s

Parameters

const TMMFMessageDestinationPckg & aDestination The destination of the message, consisting of the uid of the interface of this message.
TInt aFunction The function number to indicate which function is to be called on the interface defined in the aDestination parameter.
const TDesC8 & aDataTo1 A reference to the first chunk of data to be copied to the controller framework. The exact contents of the data are dependent on the interface being called. Can be KNullDesC8.
const TDesC8 & aDataTo2 A reference to the second chunk of data to be copied to the controller framework. The exact contents of the data are dependent on the interface being called. Can be KNullDesC8.
TDes8 & aDataFrom A reference to an area of memory to which the controller framework will write any data to be passed back to the client. Can't be KNullDesC8.

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

IMPORT_C TInt RecordControllerCustomCommandSync ( const TMMFMessageDestinationPckg & aDestination,
TInt aFunction,
const TDesC8 & aDataTo1,
const TDesC8 & aDataTo2
)

Sends a synchronous custom command to the recording controller.

Since
7.0s

Parameters

const TMMFMessageDestinationPckg & aDestination The destination of the message, consisting of the uid of the interface of this message.
TInt aFunction The function number to indicate which function is to be called on the interface defined in the aDestination parameter.
const TDesC8 & aDataTo1 A reference to the first chunk of data to be copied to the controller framework. The exact contents of the data are dependent on the interface being called. Can be KNullDesC8.
const TDesC8 & aDataTo2 A reference to the second chunk of data to be copied to the controller framework. The exact contents of the data are dependent on the interface being called. Can be KNullDesC8.

RecordL()

void RecordL ( ) [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 SetGain() , as the initial gain is undefined. The gain might also have been modified by another client application.

Since
5.0
capability
UserEnvironment For recording - the requesting client process must have the UserEnvironment capability.

RecordTimeAvailable()

const TTimeIntervalMicroSeconds & RecordTimeAvailable ( ) [virtual]

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

Since
5.0

RegisterAudioResourceNotification(MMMFAudioResourceNotificationCallback &, TUid, const TDesC8 &)

IMPORT_C TInt RegisterAudioResourceNotification ( MMMFAudioResourceNotificationCallback & aCallback,
TUid aNotificationEventUid,
const TDesC8 & aNotificationRegistrationData =  KNullDesC8
)

Registers the Event for Notification when resource is avaliable.

Parameters

MMMFAudioResourceNotificationCallback & aCallback The audio outputstream observer interface..
TUid aNotificationEventUid The Event for which the client is registered.
const TDesC8 & aNotificationRegistrationData =  KNullDesC8 Notification registration specific data.

RegisterForAudioLoadingNotification(MAudioLoadingObserver &)

IMPORT_C void RegisterForAudioLoadingNotification ( MAudioLoadingObserver & aCallback )

Register to receive notifications of audio loading/rebuffering

Since
7.0s

Parameters

MAudioLoadingObserver & aCallback The object to receive audio loading notifications.

RemoveMetaDataEntry(TInt)

IMPORT_C TInt RemoveMetaDataEntry ( TInt aMetaDataIndex )

Removes a specified meta data entry from the audio clip.

Since
7.0s

Parameters

TInt aMetaDataIndex The index of the meta data entry to remove.

ReplaceMetaDataEntryL(TInt, CMMFMetaDataEntry &)

IMPORT_C void ReplaceMetaDataEntryL ( TInt aMetaDataIndex,
CMMFMetaDataEntry & aMetaDataEntry
)

Replaces the specified meta data entry with a new entry.

Since
7.0s

Parameters

TInt aMetaDataIndex The index of the meta data entry to replace.
CMMFMetaDataEntry & aMetaDataEntry The new meta data entry to replace the one pointed to by aMetaDataIndex.

SetAudioDeviceMode(TDeviceMode)

void SetAudioDeviceMode ( TDeviceMode aMode ) [virtual]

Sets the audio device mode. This function is provided for binary compatibility, but does not have any effect from 7.0s.

Since
5.0

Parameters

TDeviceMode aMode One of the TDeviceMode settings

SetDestinationBitRateL(TUint)

IMPORT_C void SetDestinationBitRateL ( TUint aBitRate )

Sets the bit rate of the data sink in bits per second.

The bit rate must be one of the supported bit rates of the data sink. Use GetSupportedBitRatesL() to retrieve a list of supported bit rates for the data sink.

Since
7.0s

Parameters

TUint aBitRate Destination bit rate in bits/second.

SetDestinationDataTypeL(TFourCC)

IMPORT_C void SetDestinationDataTypeL ( TFourCC aDataType )

Sets the codec to use with the record controller.

Since
7.0s

Parameters

TFourCC aDataType Four character code, representing the codec of the destination audio clip

SetDestinationFormatL(TUid)

IMPORT_C void SetDestinationFormatL ( TUid aFormatUid )

Sets the format of the audio clip. This can only be done if the audio clip does not exist.

Since
7.0s

Parameters

TUid aFormatUid UID of the audio clip format

SetDestinationNumberOfChannelsL(TUint)

IMPORT_C void SetDestinationNumberOfChannelsL ( TUint aNumberOfChannels )

Sets the number of channels for the recorded audio clip.

The number of channels must be one of the values returned by GetSupportedNumberOfChannelsL() .

Since
7.0s

Parameters

TUint aNumberOfChannels The number of channels to record

SetDestinationSampleRateL(TUint)

IMPORT_C void SetDestinationSampleRateL ( TUint aSampleRate )

Sets the sample rate for the conversion destination data sink.

The sample rate must be one of the supported sample rates of the data sink. Use GetSupportedSampleRatesL() to retrieve a list of supported sample rates for the data sink. This function should not be used if the audio clip already exists; that is, in the "Open and Append" scenario, when the function's behaviour is undefined.

Since
7.0s

Parameters

TUint aSampleRate The sample rate of the conversion destination.

SetGain(TInt)

void SetGain ( TInt aGain ) [virtual]

Sets the gain for the audio device to a specified value.

Since
5.0

Parameters

TInt aGain The gain setting. This can be any value from zero to the value returned by a call to MaxGain(). A value which is less than zero is set to zero. A value which is greater than MaxGain() is set to MaxGain().

SetMaxWriteLength(TInt)

void SetMaxWriteLength ( TInt aMaxWriteLength =  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.

Since
7.0

Parameters

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

SetPlayWindow(const TTimeIntervalMicroSeconds &, const TTimeIntervalMicroSeconds &)

void SetPlayWindow ( 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.

Since
5.0

Parameters

const TTimeIntervalMicroSeconds & aStart The 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 & aEnd The 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 TInt SetPlaybackBalance ( TInt aBalance =  KMMFBalanceCenter )

Sets the current playback balance.

The balance can be any value between KMMFBalanceMaxLeft and KMMFBalanceMaxRight, the default value being KMMFBalanceCenter.

Since
7.0s

Parameters

TInt aBalance =  KMMFBalanceCenter The playback balance to set.

SetPosition(const TTimeIntervalMicroSeconds &)

void SetPosition ( 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. This method's behaviour is undefined and dependent on the controller in use if it is called in the playing state and when a play window is set.
Since
5.0

Parameters

const TTimeIntervalMicroSeconds & aPosition The new head position measured in microseconds.

SetPriority(TInt, TInt)

IMPORT_C void SetPriority ( TInt aPriority,
TInt aPref
)

Sets the recording priority.

The priority is used to arbitrate between multiple objects simultaneously trying to access the sound hardware.

Parameters

TInt aPriority The Priority Value.
TInt aPref The Priority Preference.

SetRecordBalance(TInt)

IMPORT_C TInt SetRecordBalance ( TInt aBalance =  KMMFBalanceCenter )

Sets the current recording balance setting between the left and right stereo microphones

The microphone balance can be changed before or during recording and is effective immediately.

Since
7.0s

Parameters

TInt aBalance =  KMMFBalanceCenter The balance value to set. Any value between KMMFBalanceMaxLeft and KMMFBalanceMaxRight, the default value being KMMFBalanceCenter

SetRepeats(TInt, const TTimeIntervalMicroSeconds &)

void SetRepeats ( TInt aRepeatNumberOfTimes,
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.

Since
5.0

Parameters

TInt aRepeatNumberOfTimes The 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. The behaviour is undefined for negative values (other than KMdaRepeatForever).
const TTimeIntervalMicroSeconds & aTrailingSilence The length of the trailing silence in microseconds. Negative values will produce a panic USER 87.

SetThreadPriorityPlayback(const TThreadPriority &)

IMPORT_C TInt SetThreadPriorityPlayback ( const TThreadPriority & aThreadPriority ) const

Set the priority of the playback controller's sub thread.

This can be used to increase the responsiveness of the audio plugin to minimise any lag in processing. This function should be used with care as it may have knock-on effects elsewhere in the system.

Parameters

const TThreadPriority & aThreadPriority The TThreadPriority that the thread should run under. The default is EPriorityNormal.

SetThreadPriorityRecord(const TThreadPriority &)

IMPORT_C TInt SetThreadPriorityRecord ( const TThreadPriority & aThreadPriority ) const

Set the priority of the record controller's sub thread.

This can be used to increase the responsiveness of the audio plugin to minimise any lag in processing. This function should be used with care as it may have knock-on effects elsewhere in the system.

Parameters

const TThreadPriority & aThreadPriority The TThreadPriority that the thread should run under. The default is EPriorityNormal.

SetVolume(TInt)

TInt SetVolume ( TInt aVolume ) [virtual]

Sets the playback volume for the audio device to a specified value.

Since
5.0

Parameters

TInt aVolume The volume setting. This can be any value from zero to the value returned by a call to MaxVolume(). A value that is less than zero is set to zero. A value that is greater than MaxVolume() is set to MaxVolume(). Setting a zero value mutes the sound. Setting the maximum value results in the loudest possible sound. Values less than zero would be set to zero and the values greater than the maximum permitted volume would be set to the maximum volume.

SetVolumeRamp(const TTimeIntervalMicroSeconds &)

void SetVolumeRamp ( const TTimeIntervalMicroSeconds & aRampDuration ) [virtual]

Sets the volume increase gradient.

This defines the period over which the volume level of a played audio sample is to rise smoothly from nothing to the normal volume level.

Since
5.0

Parameters

const TTimeIntervalMicroSeconds & aRampDuration The period over which the volume is to rise. A zero value causes the audio sample to be played at the normal level for the full duration of the playback. A value which is longer than the duration of the audio sample means that the sample never reaches its normal volume level.

SourceBitRateL()

IMPORT_C TUint SourceBitRateL ( )

Returns the bit rate of the audio clip.

leave
KErrNotSupported Leaves with KErrNotSupported error, if no controllers are found
Since
7.0s

State()

TState State ( ) [virtual]

Returns the current state of the audio sample data.

Since
5.0

Stop()

void Stop ( ) [virtual]

Stops the current operation (playback/recording/conversion).

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

Since
5.0

UseSharedHeap()

IMPORT_C void UseSharedHeap ( )

Ensures that any subsequent calls to OpenXYZ() will create controllers that share a heap.

The default behaviour is that for each recorder utility a controller with its own heap is created. Each heap uses a chunk, so using this function avoids situations where the number of chunks per process is limited. The default behaviour is generally to be preferred, and should give lower overall memory usage. However, if many controllers are to be created for a particular thread, then this function should be used to prevent running out of heaps or chunks.

Since
9.2

WillResumePlay()

IMPORT_C TInt WillResumePlay ( )

Waits for the client to resume the play even after the default timer expires.

Member Enumerations Documentation

Enum TDeviceMode

Device mode. Used by SetAudioDeviceMode method which is not used from 7.0s
Since
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]