CMdaAudioConvertUtility Class Reference

class CMdaAudioConvertUtility : public CMdaAudioClipUtility

Converts the type, sample rate and format of audio data.

The audio sample data can be supplied either in a file or as a descriptor.

Inherits from

Public Member Functions
~CMdaAudioConvertUtility ()
void ClearPlayWindow ()
void Close ()
IMPORT_C const CMMFControllerImplementationInformation & ControllerImplementationInformationL ()
IMPORT_C void ConvertL ()
void CropFromBeginningL ()
void CropL ()
IMPORT_C void CustomCommandAsync (const TMMFMessageDestinationPckg &, TInt , const TDesC8 &, const TDesC8 &, TDes8 &, TRequestStatus &)
IMPORT_C void CustomCommandAsync (const TMMFMessageDestinationPckg &, TInt , const TDesC8 &, const TDesC8 &, TRequestStatus &)
IMPORT_C TInt CustomCommandSync (const TMMFMessageDestinationPckg &, TInt , const TDesC8 &, const TDesC8 &, TDes8 &)
IMPORT_C TInt CustomCommandSync (const TMMFMessageDestinationPckg &, TInt , const TDesC8 &, const TDesC8 &)
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 void GetSupportedConversionBitRatesL ( RArray < TUint > &)
IMPORT_C void GetSupportedConversionNumberOfChannelsL ( RArray < TUint > &)
IMPORT_C void GetSupportedConversionSampleRatesL ( RArray < TUint > &)
IMPORT_C void GetSupportedDestinationDataTypesL ( RArray < TFourCC > &)
IMPORT_C CMdaAudioConvertUtility * NewL ( MMdaObjectStateChangeObserver &, CMdaServer *, TInt , TInt )
void OpenL (const TDesC &, const TDesC &)
void OpenL (const TDesC &, TMdaClipLocation *, TMdaClipFormat *, TMdaPackage *, TMdaPackage *)
void OpenL ( TMdaClipLocation *, TMdaClipLocation *, TMdaClipFormat *, TMdaClipFormat *, TMdaPackage *, TMdaPackage *, TMdaPackage *, TMdaPackage *)
IMPORT_C void OpenL ( TMdaClipLocation *, TMdaClipLocation *, TUid , TUid , TFourCC )
void PlayL ()
const TTimeIntervalMicroSeconds & Position ()
void RecordL ()
const TTimeIntervalMicroSeconds & RecordTimeAvailable ()
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 SetMaxWriteLength ( TInt )
void SetPlayWindow (const TTimeIntervalMicroSeconds &, const TTimeIntervalMicroSeconds &)
void SetPosition (const TTimeIntervalMicroSeconds &)
void SetRepeats ( TInt , const TTimeIntervalMicroSeconds &)
IMPORT_C TInt SetThreadPriority (const TThreadPriority &)
IMPORT_C TInt SourceBitRateL ()
IMPORT_C TFourCC SourceDataTypeL ()
IMPORT_C TUid SourceFormatL ()
IMPORT_C TUint SourceNumberOfChannelsL ()
IMPORT_C TUint SourceSampleRateL ()
TState State ()
void Stop ()
IMPORT_C void UseSharedHeap ()
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()
Inherited Enumerations
CMdaAudioClipUtility:TState
Private Attributes
CMMFMdaAudioConvertUtility * iProperties

Constructor & Destructor Documentation

~CMdaAudioConvertUtility()

~CMdaAudioConvertUtility ( ) [virtual]

Destructor.

Closes the audio clip and frees resources.

Since
5.0

Member Functions Documentation

ClearPlayWindow()

void ClearPlayWindow ( ) [virtual]

Clears the playback window.

Playback returns to playing the entire clip. A subsequent call to ConvertL() results in the entire source audio being converted.

Since
5.0

Close()

void Close ( ) [virtual]

Closes the current audio clip.

Since
5.0

ControllerImplementationInformationL()

IMPORT_C const CMMFControllerImplementationInformation & ControllerImplementationInformationL ( )

Returns the controller implementation information associated with the current controller.

Since
7.0s

ConvertL()

IMPORT_C void ConvertL ( )

Performs the conversion from the source audio format to the destination.

When conversion is complete, successfully or otherwise, the client is notified by MMdaObjectStateChangeObserver::MoscoStateChangeEvent() . The callback is initiated by this function providing it with state change information and error codes.

Since
7.0s

CropFromBeginningL()

void CropFromBeginningL ( ) [virtual]

Crops the audio clip from the start of the file to the current position. The audio data prior to the current position is discarded.

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]

Crops the current clip from the current position. The remainder of the clip is discarded.

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

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

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

Send a asynchronous custom command to the 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.

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

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

Send a asynchronous custom command to the 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.

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

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

Sends a synchronous custom command to the 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.

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

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

Sends a synchronous custom command to the 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 controllert 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.

DestinationBitRateL()

IMPORT_C TUint DestinationBitRateL ( )

Returns the bit rate of the destination audio clip.

Since
7.0s

DestinationDataTypeL()

IMPORT_C TFourCC DestinationDataTypeL ( )

Returns the data type of the destination audio clip.

Since
7.0s

DestinationFormatL()

IMPORT_C TUid DestinationFormatL ( )

Returns the format of the destination audio clip.

Since
7.0s

DestinationNumberOfChannelsL()

IMPORT_C TUint DestinationNumberOfChannelsL ( )

Returns the number of channels the destination audio clip contains.

Since
7.0s

DestinationSampleRateL()

IMPORT_C TUint DestinationSampleRateL ( )

Returns the sample rate of the conversion destination.

Since
7.0s

Duration()

const TTimeIntervalMicroSeconds & Duration ( ) [virtual]

Returns the duration of the audio clip.

Since
5.0

GetSupportedConversionBitRatesL(RArray< TUint > &)

IMPORT_C void GetSupportedConversionBitRatesL ( RArray < TUint > & aSupportedBitRates )

Gets a list of the supported bit rates for the conversion destination.

Since
7.0s

Parameters

RArray < TUint > & aSupportedBitRates The list of bit rates supported for the conversion destination.

GetSupportedConversionNumberOfChannelsL(RArray< TUint > &)

IMPORT_C void GetSupportedConversionNumberOfChannelsL ( RArray < TUint > & aSupportedNumChannels )

Returns a list of the supported number of channels for conversion.

For example, 1 for mono, 2 for stereo and so on.

Since
7.0s

Parameters

RArray < TUint > & aSupportedNumChannels A list of the number of channels supported for the conversion destination.

GetSupportedConversionSampleRatesL(RArray< TUint > &)

IMPORT_C void GetSupportedConversionSampleRatesL ( RArray < TUint > & aSupportedSampleRates )

Gets a list of supported conversion sample rates. This is a list of the sample rates that the conversion destination can take.

Since
7.0s

Parameters

RArray < TUint > & aSupportedSampleRates A list of the sample rates that are supported for the conversion.

GetSupportedDestinationDataTypesL(RArray< TFourCC > &)

IMPORT_C void GetSupportedDestinationDataTypesL ( RArray < TFourCC > & aSupportedDestinationDataTypes )

Returns a list of the supported data types for the conversion destination.

Since
7.0s

Parameters

RArray < TFourCC > & aSupportedDestinationDataTypes A list of four character codes, representing the supported data encodings for the conversion destination.

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

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

Constructs and initialises a new instance of the audio converter for converting audio sample data from one format to another.

The function leaves if the audio converter 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 The class to receive state change events from converter.
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.

OpenL(const TDesC &, const TDesC &)

void OpenL ( const TDesC & aPrimaryFile,
const TDesC & aSecondaryFile
) [virtual]

Opens source and target files (both of which must already exist) so that audio sample data can be extracted from the source file, converted and appended to the target file.

When opening is complete, successfully or otherwise, the client is notified by MMdaObjectStateChangeObserver::MoscoStateChangeEvent() . The callback is initiated by this function providing it with state change information and error codes.

Since
5.0

Parameters

const TDesC & aPrimaryFile The full path and filename of a file containing audio sample data to be converted.
const TDesC & aSecondaryFile The full path and filename of a file to which converted data is appended.

OpenL(const TDesC &, TMdaClipLocation *, TMdaClipFormat *, TMdaPackage *, TMdaPackage *)

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

Opens an existing audio file so that audio sample data can be extracted from it, converted and placed into the target audio object.

When opening is complete, successfully or otherwise, the client is notified by MMdaObjectStateChangeObserver::MoscoStateChangeEvent() . The callback is initiated by this function providing it with state change information and error codes.

Since
5.0

Parameters

const TDesC & aPrimaryFile The full path and filename of a file containing audio sample data to be converted.
TMdaClipLocation * aLocation The target location for the audio data. This is normally a file (TMdaFileClipLocation) or a descriptor (TMdaDesClipLocation).
TMdaClipFormat * aFormat The audio format for the target audio object.
TMdaPackage * aArg1 = NULL The codec to use for the target audio object.
TMdaPackage * aArg2 = NULL The audio settings for the target audio object.

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

void OpenL ( TMdaClipLocation * aPriLocation,
TMdaClipLocation * aSecLocation,
TMdaClipFormat * aPriFormat,
TMdaClipFormat * aSecFormat,
TMdaPackage * aPriArg1 = NULL,
TMdaPackage * aPriArg2 = NULL,
TMdaPackage * aSecArg1 = NULL,
TMdaPackage * aSecArg2 = NULL
) [virtual]

Opens an audio clip for conversion.

Since
5.0

Parameters

TMdaClipLocation * aPriLocation The source location for audio data. This is normally a file (TMdaFileClipLocation) or a descriptor (TMdaDesClipLocation).
TMdaClipLocation * aSecLocation The target location for audio data. This is normally a file (TMdaFileClipLocation) or a descriptor (TMdaDesClipLocation).
TMdaClipFormat * aPriFormat The audio format of the source audio object.
TMdaClipFormat * aSecFormat The audio format for the target audio object.
TMdaPackage * aPriArg1 = NULL The codec used by the source audio object.
TMdaPackage * aPriArg2 = NULL The audio settings of the source audio object.
TMdaPackage * aSecArg1 = NULL The codec to be used for the target audio object.
TMdaPackage * aSecArg2 = NULL The audio settings for the target audio object.

OpenL(TMdaClipLocation *, TMdaClipLocation *, TUid, TUid, TFourCC)

IMPORT_C void OpenL ( TMdaClipLocation * aPriLocation,
TMdaClipLocation * aSecLocation,
TUid aControllerUid,
TUid aDestFormatUid,
TFourCC aDestDataType
)

Opens source and target audio objects and specifies controller and audio format and codec information.

When opening is complete, successfully or otherwise, the client is notified by MMdaObjectStateChangeObserver::MoscoStateChangeEvent() . The callback is initiated by this function providing it with state change information and error codes.

Since
7.0s

Parameters

TMdaClipLocation * aPriLocation The source location for audio data. This is normally a file (TMdaFileClipLocation) or a descriptor (TMdaDesClipLocation).
TMdaClipLocation * aSecLocation The destination location for the converted audio data. This is normally a file (TMdaFileClipLocation) or a descriptor (TMdaDesClipLocation).
TUid aControllerUid The UID of the controller to used for conversion.
TUid aDestFormatUid The UID of the destination format.
TFourCC aDestDataType The audio codec to use for the destination data sink.

PlayL()

void PlayL ( ) [virtual]

This function is mapped to ConvertL() . ConvertL() should be used instead.

ConvertL()
Since
5.0

Position()

const TTimeIntervalMicroSeconds & Position ( ) [virtual]

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

Since
5.0

RecordL()

void RecordL ( ) [virtual]

This function is mapped to ConvertL. ConvertL() should be used instead.

Since
5.0

RecordTimeAvailable()

const TTimeIntervalMicroSeconds & RecordTimeAvailable ( ) [virtual]

Returns the amount of recording time available to the current clip.

Since
5.0

SetDestinationBitRateL(TUint)

IMPORT_C void SetDestinationBitRateL ( TUint aBitRate )

Sets the bit rate of the destination audio clip.

The bit rate must be one of the supported bit rates of the audio target. Use GetSupportedConversionBitRatesL() to retrieve a list of supported bit rates.

Since
7.0s

Parameters

TUint aBitRate The destination bit rate in bits/second.

SetDestinationDataTypeL(TFourCC)

IMPORT_C void SetDestinationDataTypeL ( TFourCC aDataType )

Sets the data type of the destination audio clip.

Since
7.0s

Parameters

TFourCC aDataType The four character code, representing the encoding of the destination audio clip

SetDestinationFormatL(TUid)

IMPORT_C void SetDestinationFormatL ( TUid aFormatUid )

Sets the format of the destination audio clip.

The UID (aFormatUid) corresponds to the UID of the destination format to use.

Since
7.0s

Parameters

TUid aFormatUid The UID of the destination format.

SetDestinationNumberOfChannelsL(TUint)

IMPORT_C void SetDestinationNumberOfChannelsL ( TUint aNumberOfChannels )

Sets the number of channels the destination audio clip contains.

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

Since
7.0s

Parameters

TUint aNumberOfChannels The number of channels.

SetDestinationSampleRateL(TUint)

IMPORT_C void SetDestinationSampleRateL ( TUint aSampleRate )

Sets the sample rate for the conversion destination.

The sample rate must be one of the supported sample rates of the audio target. Use GetSupportedConversionSampleRatesL() to retrieve a list of supported sample rates. 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 in samples per second.

SetMaxWriteLength(TInt)

void SetMaxWriteLength ( TInt aMaxWriteLength =  KMdaClipLocationMaxWriteLengthNone ) [virtual]

Sets the maximum size of an audio clip.

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

Since
7.0

Parameters

TInt aMaxWriteLength =  KMdaClipLocationMaxWriteLengthNone The maximum size of the audio clip, 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]

Sets a window for playback.

The window is defined in terms of a start and end time. A subsequent call to ConvertL() results in just the data within the window being converted.

Since
5.0

Parameters

const TTimeIntervalMicroSeconds & aStart The position in the clip to start playback, in microseconds. This must be any value from zero to aEnd. If this value is less than zero or greater than aEnd, this function raises EMMFMediaClientPanicServerCommunicationProblem panic in debug version.
const TTimeIntervalMicroSeconds & aEnd The position in the clip to end playback, in microseconds. This must be any value from aStart to the value returned by Duration(). If this value is greater than the value returned by Duration() or less than aStart, this function raises EMMFMediaClientPanicServerCommunicationProblem panic in debug version.

SetPosition(const TTimeIntervalMicroSeconds &)

void SetPosition ( const TTimeIntervalMicroSeconds & aPosition ) [virtual]

Sets the current position in the audio clip.

A subsequent call to ConvertL() starts conversion from this new position.

Since
5.0

Parameters

const TTimeIntervalMicroSeconds & aPosition The position in the audio clip, in microseconds.

SetRepeats(TInt, const TTimeIntervalMicroSeconds &)

void SetRepeats ( TInt aRepeatNumberOfTimes,
const TTimeIntervalMicroSeconds & aTrailingSilence
) [virtual]

Sets the number of repetitions for playback. This is unsupported for CMdaConvertUtility as there is no playback facility. It is provided only for binary compatibility.

Since
5.0

Parameters

TInt aRepeatNumberOfTimes The number of times to repeat the audio clip, after the first playback. 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 & aTrailingSilence A delay to wait before each repetition.

SetThreadPriority(const TThreadPriority &)

IMPORT_C TInt SetThreadPriority ( const TThreadPriority & aThreadPriority ) const

Set the priority of the 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

SourceBitRateL()

IMPORT_C TInt SourceBitRateL ( )

Returns the bit rate of the source audio clip.

Since
7.0s

SourceDataTypeL()

IMPORT_C TFourCC SourceDataTypeL ( )

Returns the data type of the source audio clip.

Since
7.0s

SourceFormatL()

IMPORT_C TUid SourceFormatL ( )

Returns the format of the source audio clip.

Since
7.0s

SourceNumberOfChannelsL()

IMPORT_C TUint SourceNumberOfChannelsL ( )

Returns the number of channels used by the conversion source.

Since
7.0s

SourceSampleRateL()

IMPORT_C TUint SourceSampleRateL ( )

Returns the sample rate of the source audio clip.

Since
7.0s

State()

TState State ( ) [virtual]

Returns the current utility state.

Since
5.0

Stop()

void Stop ( ) [virtual]

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

When conversion has been stopped, successfully or otherwise, the client is notified by MMdaObjectStateChangeObserver::MoscoStateChangeEvent() . The callback is initiated by this function providing it with state change information and error codes.

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 converter 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

Member Data Documentation

CMMFMdaAudioConvertUtility * iProperties

CMMFMdaAudioConvertUtility * iProperties [private]