Class CMdaAudioRecorderUtility

class CMdaAudioRecorderUtility : public CMdaAudioClipUtility;

Description

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 CMdaAudioRecorderUtility::NewL(MMdaObjectStateChangeObserver &,CMdaServer *,TInt,TMdaPriorityPreference) 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.

Derivation

• MMMFClientUtility - No description.
• CBase - Base class for all classes to be instantiated on the heap.

• CMdaAudioClipUtility - ...

• CMdaAudioRecorderUtility - Plays back, records and edits audio sample data.

Members

Defined in CMdaAudioRecorderUtility:

• AddMetaDataEntryL(CMMFMetaDataEntry &)Adds a meta data entry to the audio clip.
• AudioPlayControllerImplementationInformationL()Returns the controller implementation information associated with the playback c...
• AudioRecorderControllerImplementationInformationL()Returns the controller implementation information associated with the recording ...
• CancelRegisterAudioResourceNotification(TUid)Cancels the registered notification event.
• ClearPlayWindow()Removes any window defined on the audio sample data.
• Close()Close the current audio clip.
• CropFromBeginningL()Deletes all audio sample data from the beginning of the audio clip to the curren...
• CropL()Deletes all audio sample data after the current head position. The effects of th...
• DestinationBitRateL()Returns the bit rate in bits per second that the data sink is currently set to.
• DestinationDataTypeL()Returns the codec that is currently set for the destination audio clip.
• DestinationFormatL()Returns the format(UID) of the destination audio clip.
• DestinationNumberOfChannelsL()Returns the number of channels that the destination audio clip is currently conf...
• DestinationSampleRateL()Returns the sample rate in samples/second that the destination data sink is curr...
• Duration()Returns the duration of the audio clip.
• Duration(TTimeIntervalMicroSeconds &)Returns the duration of the audio sample in microseconds, and the duration state...
• EDefaultThe default behaviour.
• ELocalWhen recording, the audio source is the device microphone.
• ETelephonyMixedWhen recording: If a telephony call is in progress the audio source is the telep...
• ETelephonyNonMixedWhen recording, the audio source is the telephony downlink and is not mixed with...
• ETelephonyOrLocalSee EDefault.
• GetAudioLoadingProgressL(TInt &)Returns the current progress of audio loading.
• GetDRMCustomCommand()Gets a controller's DRM custom command implementation.
• GetGain(TInt &)Returns the current gain setting of the audio device.
• GetMetaDataEntryL(TInt)Returns the specified meta data entry from the current audio clip.
• GetNumberOfMetaDataEntries(TInt &)Returns the number of meta data entries associated with this clip.
• GetPlaybackBalance(TInt &)Returns The current balance setting for the audio device. This function may not ...
• GetRecordBalance(TInt &)Returns the current recording balance setting between the left and right stereo ...
• GetSupportedBitRatesL(RArray< TUint > &)Returns a list of the supported bit rates for recording to the data sink.
• GetSupportedDestinationDataTypesL(RArray< TFourCC > &)Returns a list of the supported codecs for the conversion destination.
• GetSupportedNumberOfChannelsL(RArray< TUint > &)Returns a list of the supported number of channels for recording. For example 1 ...
• GetSupportedSampleRatesL(RArray< TUint > &)If a destination sample rate has not been set then CMdaAudioRecorderUtility::Get...
• GetVolume(TInt &)Returns the current volume setting for the audio device.
• MaxGain()Return the maximum value for the gain
• MaxVolume()Returns the maximum volume setting for the audio device.
• NewL(MMdaObjectStateChangeObserver &,CMdaServer *,TInt,TMdaPriorityPreference)Constructs and initialises a new instance of the audio recorder for playing, rec...
• OpenDesL(TDes8 &)Opens a descriptor to play back or record audio sample data.
• OpenDesL(TDes8 &,TUid,TUid,TUid,TFourCC)Opens an audio clip from a descriptor to play back existing audio data from or t...
• OpenDesL(const TDesC8 &)Opens a descriptor to play back or record audio sample data (const version).
• OpenFileL(const RFile &)Opens a file to play back or record audio sample data.
• OpenFileL(const RFile &,TUid,TUid,TUid,TFourCC)Opens an audio clip from a file to play back existing audio data or to record ne...
• OpenFileL(const TDesC &)Opens a file to play back or record audio sample data.
• OpenFileL(const TDesC &,TUid,TUid,TUid,TFourCC)Opens an audio clip from a file to play back existing audio data or to record ne...
• OpenFileL(const TMMSource &)Opens a file to play or record audio sample data.
• OpenFileL(const TMMSource &,TUid,TUid,TUid,TFourCC)Opens an audio clip from a filename or an open file handle to play back existing...
• OpenL(TMdaClipLocation *,TMdaClipFormat *,TMdaPackage *,TMdaPackage *)Opens a TMdaClipLocation package of audio data that can be played back or record...
• OpenUrlL(const TDesC &,TInt,TUid,TUid,TUid,TFourCC)Opens an audio clip from a URL to play back existing audio data from or to recor...
• OpenUrlL(const TDesC &,TInt,const TDesC8 &)Opens an audio clip from a URL to play back or record audio sample data.
• PlayControllerCustomCommandAsync(const TMMFMessageDestinationPckg &,TInt,const TDesC8 &,const TDesC8 &,TDes8 &,TRequestStatus &)Send a asynchronous custom command to the recording controller.
• PlayControllerCustomCommandAsync(const TMMFMessageDestinationPckg &,TInt,const TDesC8 &,const TDesC8 &,TRequestStatus &)Send a asynchronous custom command to the recording controller.
• PlayControllerCustomCommandSync(const TMMFMessageDestinationPckg &,TInt,const TDesC8 &,const TDesC8 &)Send a synchronous custom command to the playback controller.
• PlayControllerCustomCommandSync(const TMMFMessageDestinationPckg &,TInt,const TDesC8 &,const TDesC8 &,TDes8 &)Send a synchronous custom command to the playback controller
• PlayL()Begins playback of audio sample data at the current playback position using the ...
• Position()Returns the current head position.
• RecordControllerCustomCommandAsync(const TMMFMessageDestinationPckg &,TInt,const TDesC8 &,const TDesC8 &,TDes8 &,TRequestStatus &)Send a asynchronous custom command to the recording controller.
• RecordControllerCustomCommandAsync(const TMMFMessageDestinationPckg &,TInt,const TDesC8 &,const TDesC8 &,TRequestStatus &)Send a asynchronous custom command to the recording controller
• RecordControllerCustomCommandSync(const TMMFMessageDestinationPckg &,TInt,const TDesC8 &,const TDesC8 &)Sends a synchronous custom command to the recording controller.
• RecordControllerCustomCommandSync(const TMMFMessageDestinationPckg &,TInt,const TDesC8 &,const TDesC8 &,TDes8 &)Sends a synchronous custom command to the recording controller.
• RecordL()Starts appending new audio sample data.
• RecordTimeAvailable()Returns the recording time available for the selected file or descriptor and enc...
• RegisterAudioResourceNotification(MMMFAudioResourceNotificationCallback &,TUid,const TDesC8 &)Registers the Event for Notification when resource is avaliable.
• RegisterForAudioLoadingNotification(MAudioLoadingObserver &)Register to receive notifications of audio loading/rebuffering
• RemoveMetaDataEntry(TInt)Removes a specified meta data entry from the audio clip.
• ReplaceMetaDataEntryL(TInt,CMMFMetaDataEntry &)Replaces the specified meta data entry with a new entry.
• SetAudioDeviceMode(TDeviceMode)Sets the audio device mode. This function is provided for binary compatibility, ...
• SetDestinationBitRateL(TUint)Sets the bit rate of the data sink in bits per second.
• SetDestinationDataTypeL(TFourCC)Sets the codec to use with the record controller.
• SetDestinationFormatL(TUid)Sets the format of the audio clip. This can only be done if the audio clip does ...
• SetDestinationNumberOfChannelsL(TUint)Sets the number of channels for the recorded audio clip.
• SetDestinationSampleRateL(TUint)Sets the sample rate for the conversion destination data sink.
• SetGain(TInt)Sets the gain for the audio device to a specified value.
• SetMaxWriteLength(TInt)Sets the maximum size for a file that is being recorded.
• SetPlayWindow(const TTimeIntervalMicroSeconds &,const TTimeIntervalMicroSeconds &)Defines a window on the audio sample data.
• SetPlaybackBalance(TInt)Sets the current playback balance.
• SetPosition(const TTimeIntervalMicroSeconds &)Sets the head position.
• SetPriority(TInt,TMdaPriorityPreference)Sets the recording priority.
• SetRecordBalance(TInt)Sets the current recording balance setting between the left and right stereo mic...
• SetRepeats(TInt,const TTimeIntervalMicroSeconds &)Sets the number of times the audio sample is to be repeated during the CMdaAudio...
• SetThreadPriorityPlayback(const TThreadPriority &)constSet the priority of the playback controller's sub thread.
• SetThreadPriorityRecord(const TThreadPriority &)constSet the priority of the record controller's sub thread.
• SetVolume(TInt)Sets the playback volume for the audio device to a specified value.
• SetVolumeRamp(const TTimeIntervalMicroSeconds &)Sets the volume increase gradient.
• SourceBitRateL()Returns the bit rate of the audio clip.
• State()Returns the current state of the audio sample data.
• Stop()Stops the current operation (playback/recording/conversion).
• TDeviceModeDevice mode. Used by SetAudioDeviceMode method which is not used from 7.0s
• UseSharedHeap()Ensures that any subsequent calls to OpenXYZ() will create controllers that shar...
• WillResumePlay()Waits for the client to resume the play even after the default timer expires.
• ~CMdaAudioRecorderUtility()Destructor. Closes the audio clip and frees resources.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Inherited from CMdaAudioClipUtility:

• ENotReadyThe audio clip recorder or audio converter has been constructed but no file or d...
• EOpenFiles or descriptors are open but no playing or recording operation is in progre...
• EPlayingAudio sample data is playing.
• ERecordingNew audio sample data is being recorded.
• TStateDefines the possible state of the audio data sample.

virtual ~CMdaAudioRecorderUtility();

Description

Destructor. Closes the audio clip and frees resources.

IMPORT_C static CMdaAudioRecorderUtility* NewL(MMdaObjectStateChangeObserver &aObserver, CMdaServer *aServer=0, TInt aPriority=EMdaPriorityNormal, TMdaPriorityPreference aPref=EMdaPriorityPreferenceTimeAndQuality);

Description

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.

Parameters

Return value

virtual void OpenFileL(const TDesC &aFileName);

Description

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

Parameters

IMPORT_C void OpenFileL(const RFile &aFile);

Description

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

Parameters

IMPORT_C void OpenFileL(const TMMSource &aSource);

Description

Opens a file to play or record audio sample data.

Parameters

virtual void OpenDesL(const TDesC8 &aDescriptor);

Description

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

Parameters

IMPORT_C void OpenDesL(TDes8 &aDescriptor);

Description

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

Parameters

virtual void OpenL(TMdaClipLocation *aLocation, TMdaClipFormat *aFormat, TMdaPackage *aArg1=0, TMdaPackage *aArg2=0);

Description

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

Parameters

virtual void SetAudioDeviceMode(TDeviceMode aMode);

Description

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

Parameters

virtual TInt MaxVolume();

Description

Returns the maximum volume setting for the audio device.

Return value

virtual TInt MaxGain();

Description

Return the maximum value for the gain

Return value

virtual TInt SetVolume(TInt aVolume);

Description

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

Parameters

Return value

virtual void SetGain(TInt aGain);

Description

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

Parameters

virtual void SetVolumeRamp(const TTimeIntervalMicroSeconds &aRampDuration);

Description

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.

Parameters

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

Description

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

Parameters

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

Description

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

Parameters

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

Description

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

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

Description

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

Parameters

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

Description

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

Parameters

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

Description

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

Parameters

IMPORT_C TInt GetGain(TInt &aGain);

Description

Returns the current gain setting of the audio device.

Parameters

Return value

IMPORT_C TInt GetVolume(TInt &aVolume);

Description

Returns the current volume setting for the audio device.

Parameters

Return value

IMPORT_C TInt SetPlaybackBalance(TInt aBalance=KMMFBalanceCenter);

Description

Sets the current playback balance.

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

Parameters

Return value

IMPORT_C TInt GetPlaybackBalance(TInt &aBalance);

Description

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.

Parameters

Return value

IMPORT_C TInt SetRecordBalance(TInt aBalance=KMMFBalanceCenter);

Description

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.

Parameters

Return value

IMPORT_C TInt GetRecordBalance(TInt &aBalance);

Description

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

Parameters

Return value

IMPORT_C TInt GetNumberOfMetaDataEntries(TInt &aNumEntries);

Description

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

Parameters

Return value

IMPORT_C CMMFMetaDataEntry* GetMetaDataEntryL(TInt aMetaDataIndex);

Description

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

Parameters

Return value

IMPORT_C void AddMetaDataEntryL(CMMFMetaDataEntry &aMetaDataEntry);

Description

Adds a meta data entry to the audio clip.

Parameters

IMPORT_C TInt RemoveMetaDataEntry(TInt aMetaDataIndex);

Description

Removes a specified meta data entry from the audio clip.

Parameters

Return value

IMPORT_C void ReplaceMetaDataEntryL(TInt aMetaDataIndex, CMMFMetaDataEntry &aMetaDataEntry);

Description

Replaces the specified meta data entry with a new entry.

Parameters

IMPORT_C void SetPriority(TInt aPriority, TMdaPriorityPreference aPref);

Description

Sets the recording priority.

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

Parameters

IMPORT_C void GetSupportedDestinationDataTypesL(RArray< TFourCC > &aSupportedDataTypes);

Description

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

Parameters

IMPORT_C void SetDestinationDataTypeL(TFourCC aDataType);

Description

Sets the codec to use with the record controller.

Parameters

IMPORT_C TFourCC DestinationDataTypeL();

Description

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

Return value

IMPORT_C void SetDestinationBitRateL(TUint aBitRate);

Description

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 CMdaAudioRecorderUtility::GetSupportedBitRatesL(RArray< TUint > &) to retrieve a list of supported bit rates for the data sink.

Parameters

IMPORT_C TUint DestinationBitRateL();

Description

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

Return value

IMPORT_C TUint SourceBitRateL();

Description

Returns the bit rate of the audio clip.

Return value

Leave codes

IMPORT_C void GetSupportedBitRatesL(RArray< TUint > &aSupportedBitRates);

Description

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

Parameters

IMPORT_C void SetDestinationSampleRateL(TUint aSampleRate);

Description

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 CMdaAudioRecorderUtility::GetSupportedSampleRatesL(RArray< TUint > &) 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.

Parameters

IMPORT_C TUint DestinationSampleRateL();

Description

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

Return value

IMPORT_C void GetSupportedSampleRatesL(RArray< TUint > &aSupportedSampleRates);

Description

If a destination sample rate has not been set then CMdaAudioRecorderUtility::GetSupportedSampleRatesL(RArray< TUint > &) returns all valid sample rates

If a destination sample rate has been set then CMdaAudioRecorderUtility::GetSupportedSampleRatesL(RArray< TUint > &) returns all valid sample rates less than or equal to the destination sample rate

Parameters

IMPORT_C void SetDestinationFormatL(TUid aFormatUid);

Description

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

Parameters

IMPORT_C TUid DestinationFormatL();

Description

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

Return value

IMPORT_C void SetDestinationNumberOfChannelsL(TUint aNumberOfChannels);

Description

Sets the number of channels for the recorded audio clip.

The number of channels must be one of the values returned by CMdaAudioRecorderUtility::GetSupportedNumberOfChannelsL(RArray< TUint > &).

Parameters

IMPORT_C TUint DestinationNumberOfChannelsL();

Description

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

Return value

IMPORT_C void GetSupportedNumberOfChannelsL(RArray< TUint > &aSupportedNumChannels);

Description

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

Parameters

virtual TState State();

Description

Returns the current state of the audio sample data.

Return value

virtual void Close();

Description

Close the current audio clip.

virtual void PlayL();

Description

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

virtual void RecordL();

Description

Starts appending new audio sample data.

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

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

virtual void Stop();

Description

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.

virtual void CropL();

Description

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.

virtual void SetPosition(const TTimeIntervalMicroSeconds &aPosition);

Description

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 CMdaAudioRecorderUtility::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.

Parameters

virtual const TTimeIntervalMicroSeconds& Position();

Description

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.

Return value

virtual const TTimeIntervalMicroSeconds& RecordTimeAvailable();

Description

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

Return value

virtual const TTimeIntervalMicroSeconds& Duration();

Description

Returns the duration of the audio clip.

Return value

IMPORT_C TMMFDurationInfo Duration(TTimeIntervalMicroSeconds &aDuration);

Description

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.

Parameters

Return value

virtual void SetPlayWindow(const TTimeIntervalMicroSeconds &aStart, const TTimeIntervalMicroSeconds &aEnd);

Description

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 CMdaAudioRecorderUtility::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 CMdaAudioRecorderUtility::SetPlayWindow(const TTimeIntervalMicroSeconds &,const TTimeIntervalMicroSeconds &) 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 CMdaAudioRecorderUtility::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.

Parameters

virtual void ClearPlayWindow();

Description

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.

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

Description

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

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

Parameters

virtual void SetMaxWriteLength(TInt aMaxWriteLength=KMdaClipLocationMaxWriteLengthNone);

Description

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(CBase *,TInt,TInt,TInt) 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.

Parameters

virtual void CropFromBeginningL();

Description

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.

IMPORT_C void RegisterForAudioLoadingNotification(MAudioLoadingObserver &aCallback);

Description

Register to receive notifications of audio loading/rebuffering

Parameters

IMPORT_C void GetAudioLoadingProgressL(TInt &aPercentageComplete);

Description

Returns the current progress of audio loading.

Parameters

IMPORT_C const CMMFControllerImplementationInformation& AudioPlayControllerImplementationInformationL();

Description

Returns the controller implementation information associated with the playback controller

Return value

IMPORT_C const CMMFControllerImplementationInformation& AudioRecorderControllerImplementationInformationL();

Description

Returns the controller implementation information associated with the recording controller.

Return value

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

Description

Sends a synchronous custom command to the recording controller.

Parameters

Return value

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

Description

Sends a synchronous custom command to the recording controller.

Parameters

Return value

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

Description

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.

Parameters

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

Description

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.

Parameters

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

Description

Send a synchronous custom command to the playback controller

Parameters

Return value

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

Description

Send a synchronous custom command to the playback controller.

Parameters

Return value

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

Description

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.

Parameters

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

Description

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.

Parameters

IMPORT_C MMMFDRMCustomCommand* GetDRMCustomCommand();

Description

Gets a controller's DRM custom command implementation.

Return value

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

Description

Registers the Event for Notification when resource is avaliable.

Parameters

Return value

IMPORT_C TInt CancelRegisterAudioResourceNotification(TUid aNotificationEventId);

Description

Cancels the registered notification event.

Parameters

Return value

IMPORT_C TInt WillResumePlay();

Description

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

Return value

IMPORT_C TInt SetThreadPriorityPlayback(const TThreadPriority &aThreadPriority) const;

Description

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

Return value

IMPORT_C TInt SetThreadPriorityRecord(const TThreadPriority &aThreadPriority) const;

Description

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

Return value

IMPORT_C void UseSharedHeap();

Description

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.

TDeviceMode

Description

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