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()
voidClearPlayWindow()
voidClose()
IMPORT_C const CMMFControllerImplementationInformation &ControllerImplementationInformationL()
IMPORT_C voidConvertL()
voidCropFromBeginningL()
voidCropL()
IMPORT_C voidCustomCommandAsync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &, TDes8 &, TRequestStatus &)
IMPORT_C voidCustomCommandAsync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &, TRequestStatus &)
IMPORT_C TIntCustomCommandSync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &, TDes8 &)
IMPORT_C TIntCustomCommandSync(const TMMFMessageDestinationPckg &, TInt, const TDesC8 &, const TDesC8 &)
IMPORT_C TUintDestinationBitRateL()
IMPORT_C TFourCCDestinationDataTypeL()
IMPORT_C TUidDestinationFormatL()
IMPORT_C TUintDestinationNumberOfChannelsL()
IMPORT_C TUintDestinationSampleRateL()
const TTimeIntervalMicroSeconds &Duration()
IMPORT_C voidGetSupportedConversionBitRatesL(RArray< TUint > &)
IMPORT_C voidGetSupportedConversionNumberOfChannelsL(RArray< TUint > &)
IMPORT_C voidGetSupportedConversionSampleRatesL(RArray< TUint > &)
IMPORT_C voidGetSupportedDestinationDataTypesL(RArray< TFourCC > &)
IMPORT_C CMdaAudioConvertUtility *NewL(MMdaObjectStateChangeObserver &, CMdaServer *, TInt, TInt)
voidOpenL(const TDesC &, const TDesC &)
voidOpenL(const TDesC &, TMdaClipLocation *, TMdaClipFormat *, TMdaPackage *, TMdaPackage *)
voidOpenL(TMdaClipLocation *, TMdaClipLocation *, TMdaClipFormat *, TMdaClipFormat *, TMdaPackage *, TMdaPackage *, TMdaPackage *, TMdaPackage *)
IMPORT_C voidOpenL(TMdaClipLocation *, TMdaClipLocation *, TUid, TUid, TFourCC)
voidPlayL()
const TTimeIntervalMicroSeconds &Position()
voidRecordL()
const TTimeIntervalMicroSeconds &RecordTimeAvailable()
IMPORT_C voidSetDestinationBitRateL(TUint)
IMPORT_C voidSetDestinationDataTypeL(TFourCC)
IMPORT_C voidSetDestinationFormatL(TUid)
IMPORT_C voidSetDestinationNumberOfChannelsL(TUint)
IMPORT_C voidSetDestinationSampleRateL(TUint)
voidSetMaxWriteLength(TInt)
voidSetPlayWindow(const TTimeIntervalMicroSeconds &, const TTimeIntervalMicroSeconds &)
voidSetPosition(const TTimeIntervalMicroSeconds &)
voidSetRepeats(TInt, const TTimeIntervalMicroSeconds &)
IMPORT_C TIntSetThreadPriority(const TThreadPriority &)
IMPORT_C TIntSourceBitRateL()
IMPORT_C TFourCCSourceDataTypeL()
IMPORT_C TUidSourceFormatL()
IMPORT_C TUintSourceNumberOfChannelsL()
IMPORT_C TUintSourceSampleRateL()
TState State()
voidStop()
IMPORT_C voidUseSharedHeap()
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()

voidClearPlayWindow()[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()

voidClose()[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 voidConvertL()

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()

voidCropFromBeginningL()[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()

voidCropL()[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 voidCustomCommandAsync(const TMMFMessageDestinationPckg &aDestination,
TIntaFunction,
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 & aDestinationThe destination of the message, consisting of the UID of the interface of this message.
TInt aFunctionThe function number to indicate which function is to be called on the interface defined in the aDestination parameter.
const TDesC8 & aDataTo1A 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 & aDataTo2A 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 & aDataFromA 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 & aStatusThe 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 voidCustomCommandAsync(const TMMFMessageDestinationPckg &aDestination,
TIntaFunction,
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 & aDestinationThe destination of the message, consisting of the UID of the interface of this message.
TInt aFunctionThe function number to indicate which function is to be called on the interface defined in the aDestination parameter.
const TDesC8 & aDataTo1A 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 & aDataTo2A 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 & aStatusThe 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 TIntCustomCommandSync(const TMMFMessageDestinationPckg &aDestination,
TIntaFunction,
const TDesC8 &aDataTo1,
const TDesC8 &aDataTo2,
TDes8 &aDataFrom
)

Sends a synchronous custom command to the controller.

Since
7.0s

Parameters

const TMMFMessageDestinationPckg & aDestinationThe destination of the message, consisting of the UID of the interface of this message.
TInt aFunctionThe function number to indicate which function is to be called on the interface defined in the aDestination parameter.
const TDesC8 & aDataTo1A 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 & aDataTo2A 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 & aDataFromA 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 TIntCustomCommandSync(const TMMFMessageDestinationPckg &aDestination,
TIntaFunction,
const TDesC8 &aDataTo1,
const TDesC8 &aDataTo2
)

Sends a synchronous custom command to the controller.

Since
7.0s

Parameters

const TMMFMessageDestinationPckg & aDestinationThe destination of the message, consisting of the UID of the interface of this message.
TInt aFunctionThe function number to indicate which function is to be called on the interface defined in the aDestination parameter.
const TDesC8 & aDataTo1A 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 & aDataTo2A 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 TUintDestinationBitRateL()

Returns the bit rate of the destination audio clip.

Since
7.0s

DestinationDataTypeL()

IMPORT_C TFourCCDestinationDataTypeL()

Returns the data type of the destination audio clip.

Since
7.0s

DestinationFormatL()

IMPORT_C TUidDestinationFormatL()

Returns the format of the destination audio clip.

Since
7.0s

DestinationNumberOfChannelsL()

IMPORT_C TUintDestinationNumberOfChannelsL()

Returns the number of channels the destination audio clip contains.

Since
7.0s

DestinationSampleRateL()

IMPORT_C TUintDestinationSampleRateL()

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 voidGetSupportedConversionBitRatesL(RArray< TUint > &aSupportedBitRates)

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

Since
7.0s

Parameters

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

GetSupportedConversionNumberOfChannelsL(RArray< TUint > &)

IMPORT_C voidGetSupportedConversionNumberOfChannelsL(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 > & aSupportedNumChannelsA list of the number of channels supported for the conversion destination.

GetSupportedConversionSampleRatesL(RArray< TUint > &)

IMPORT_C voidGetSupportedConversionSampleRatesL(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 > & aSupportedSampleRatesA list of the sample rates that are supported for the conversion.

GetSupportedDestinationDataTypesL(RArray< TFourCC > &)

IMPORT_C voidGetSupportedDestinationDataTypesL(RArray< TFourCC > &aSupportedDestinationDataTypes)

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

Since
7.0s

Parameters

RArray< TFourCC > & aSupportedDestinationDataTypesA 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,
TIntaPriority = EMdaPriorityNormal,
TIntaPref = 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 & aObserverThe class to receive state change events from converter.
CMdaServer * aServer = NULLNo longer used, should be NULL.
TInt aPriority = EMdaPriorityNormalThe 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 = EMdaPriorityPreferenceTimeAndQualityThe 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 &)

voidOpenL(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 & aPrimaryFileThe full path and filename of a file containing audio sample data to be converted.
const TDesC & aSecondaryFileThe full path and filename of a file to which converted data is appended.

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

voidOpenL(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 & aPrimaryFileThe full path and filename of a file containing audio sample data to be converted.
TMdaClipLocation * aLocationThe target location for the audio data. This is normally a file (TMdaFileClipLocation) or a descriptor (TMdaDesClipLocation).
TMdaClipFormat * aFormatThe audio format for the target audio object.
TMdaPackage * aArg1 = NULLThe codec to use for the target audio object.
TMdaPackage * aArg2 = NULLThe audio settings for the target audio object.

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

voidOpenL(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 * aPriLocationThe source location for audio data. This is normally a file (TMdaFileClipLocation) or a descriptor (TMdaDesClipLocation).
TMdaClipLocation * aSecLocationThe target location for audio data. This is normally a file (TMdaFileClipLocation) or a descriptor (TMdaDesClipLocation).
TMdaClipFormat * aPriFormatThe audio format of the source audio object.
TMdaClipFormat * aSecFormatThe audio format for the target audio object.
TMdaPackage * aPriArg1 = NULLThe codec used by the source audio object.
TMdaPackage * aPriArg2 = NULLThe audio settings of the source audio object.
TMdaPackage * aSecArg1 = NULLThe codec to be used for the target audio object.
TMdaPackage * aSecArg2 = NULLThe audio settings for the target audio object.

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

IMPORT_C voidOpenL(TMdaClipLocation *aPriLocation,
TMdaClipLocation *aSecLocation,
TUidaControllerUid,
TUidaDestFormatUid,
TFourCCaDestDataType
)

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 * aPriLocationThe source location for audio data. This is normally a file (TMdaFileClipLocation) or a descriptor (TMdaDesClipLocation).
TMdaClipLocation * aSecLocationThe destination location for the converted audio data. This is normally a file (TMdaFileClipLocation) or a descriptor (TMdaDesClipLocation).
TUid aControllerUidThe UID of the controller to used for conversion.
TUid aDestFormatUidThe UID of the destination format.
TFourCC aDestDataTypeThe audio codec to use for the destination data sink.

PlayL()

voidPlayL()[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()

voidRecordL()[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 voidSetDestinationBitRateL(TUintaBitRate)

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 aBitRateThe destination bit rate in bits/second.

SetDestinationDataTypeL(TFourCC)

IMPORT_C voidSetDestinationDataTypeL(TFourCCaDataType)

Sets the data type of the destination audio clip.

Since
7.0s

Parameters

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

SetDestinationFormatL(TUid)

IMPORT_C voidSetDestinationFormatL(TUidaFormatUid)

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 aFormatUidThe UID of the destination format.

SetDestinationNumberOfChannelsL(TUint)

IMPORT_C voidSetDestinationNumberOfChannelsL(TUintaNumberOfChannels)

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 aNumberOfChannelsThe number of channels.

SetDestinationSampleRateL(TUint)

IMPORT_C voidSetDestinationSampleRateL(TUintaSampleRate)

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 aSampleRateThe sample rate of the conversion destination in samples per second.

SetMaxWriteLength(TInt)

voidSetMaxWriteLength(TIntaMaxWriteLength =  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 &)

voidSetPlayWindow(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 & aStartThe 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 & aEndThe 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 &)

voidSetPosition(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 & aPositionThe position in the audio clip, in microseconds.

SetRepeats(TInt, const TTimeIntervalMicroSeconds &)

voidSetRepeats(TIntaRepeatNumberOfTimes,
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 aRepeatNumberOfTimesThe 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 & aTrailingSilenceA delay to wait before each repetition.

SetThreadPriority(const TThreadPriority &)

IMPORT_C TIntSetThreadPriority(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 TIntSourceBitRateL()

Returns the bit rate of the source audio clip.

Since
7.0s

SourceDataTypeL()

IMPORT_C TFourCCSourceDataTypeL()

Returns the data type of the source audio clip.

Since
7.0s

SourceFormatL()

IMPORT_C TUidSourceFormatL()

Returns the format of the source audio clip.

Since
7.0s

SourceNumberOfChannelsL()

IMPORT_C TUintSourceNumberOfChannelsL()

Returns the number of channels used by the conversion source.

Since
7.0s

SourceSampleRateL()

IMPORT_C TUintSourceSampleRateL()

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()

voidStop()[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 voidUseSharedHeap()

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]