#include <mdaaudiosampleeditor.h>
class CMdaAudioRecorderUtility : public CMdaAudioClipUtility |
Public Member Enumerations | |
---|---|
enum | TDeviceMode { EDefault, ETelephonyOrLocal, ETelephonyMixed, ETelephonyNonMixed, ELocal } |
Inherited Enumerations | |
---|---|
CMdaAudioClipUtility:TState |
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.
~CMdaAudioRecorderUtility | ( | ) | [virtual] |
Destructor. Closes the audio clip and frees resources.
IMPORT_C void | AddMetaDataEntryL | ( | CMMFMetaDataEntry & | aMetaDataEntry | ) |
Adds a meta data entry to the audio clip.
Parameter | Description |
---|---|
aMetaDataEntry | The new meta data entry to add to the clip. |
IMPORT_C const CMMFControllerImplementationInformation & | AudioPlayControllerImplementationInformationL | ( | ) |
Returns the controller implementation information associated with the playback controller
Returns: The controller implementation structure associated with the controller
IMPORT_C const CMMFControllerImplementationInformation & | AudioRecorderControllerImplementationInformationL | ( | ) |
Returns the controller implementation information associated with the recording controller.
Returns: The controller implementation structure associated with the controller
Cancels the registered notification event.
Parameter | Description |
---|---|
aNotificationEventId | The Event to notify the client. |
Returns: An error code indicating if the registration was successful. KErrNone on success, otherwise another of the system-wide error codes.
void | ClearPlayWindow | ( | ) | [virtual] |
Reimplemented from CMdaAudioClipUtility::ClearPlayWindow()
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.
void | Close | ( | ) | [virtual] |
Reimplemented from CMdaAudioClipUtility::Close()
Close the current audio clip.
void | CropFromBeginningL | ( | ) | [virtual] |
Reimplemented from CMdaAudioClipUtility::CropFromBeginningL()
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.
void | CropL | ( | ) | [virtual] |
Reimplemented from CMdaAudioClipUtility::CropL()
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.
IMPORT_C TUint | DestinationBitRateL | ( | ) |
Returns the bit rate in bits per second that the data sink is currently set to.
Returns: Bit rate of data sink in bits/second.
IMPORT_C TFourCC | DestinationDataTypeL | ( | ) |
Returns the codec that is currently set for the destination audio clip.
Returns: Four character code, representing the codec of the destination audio clip.
IMPORT_C TUid | DestinationFormatL | ( | ) |
Returns the format(UID) of the destination audio clip.
Returns: UID of the audio clip format.
IMPORT_C TUint | DestinationNumberOfChannelsL | ( | ) |
Returns the number of channels that the destination audio clip is currently configured to support.
Returns: The number of channels supported by audio clip
IMPORT_C TUint | DestinationSampleRateL | ( | ) |
Returns the sample rate in samples/second that the destination data sink is currently set to.
Returns: The sample rate of the conversion destination
const TTimeIntervalMicroSeconds & | Duration | ( | ) | [virtual] |
Reimplemented from CMdaAudioClipUtility::Duration()
Returns the duration of the audio clip.
Returns: The duration in microseconds.
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.
Parameter | Description |
---|---|
aDuration | The duration of the sample in microseconds. |
Returns: The duration state
IMPORT_C void | GetAudioLoadingProgressL | ( | TInt & | aPercentageComplete | ) |
Returns the current progress of audio loading.
Parameter | Description |
---|---|
aPercentageComplete | The percentage of the audio clip loaded. |
IMPORT_C MMMFDRMCustomCommand * | GetDRMCustomCommand | ( | ) |
Gets a controller's DRM custom command implementation.
Returns: A pointer to a controller's DRM custom command implementation, or NULL if the controller does not support it.
Returns the current gain setting of the audio device.
Parameter | Description |
---|---|
aGain | On return contains the current gain setting for the audio device. Can be any value between zero and MaxGain(). |
Returns: An error code indicating if the call was successful. KErrNone on success, otherwise another of the system-wide error codes.
IMPORT_C CMMFMetaDataEntry * | GetMetaDataEntryL | ( | TInt | aMetaDataIndex | ) |
Returns the specified meta data entry from the current audio clip.
Parameter | Description |
---|---|
aMetaDataIndex | The index of the entry to retrieve. The index is between 0 and GetNumberOfMetaDataEntries()-1 |
Returns: The meta data entry requested
Returns the number of meta data entries associated with this clip.
Parameter | Description |
---|---|
aNumEntries | On return contains the number of meta data entries. |
Returns: An error code indicating if the call was successful. KErrNone on success, otherwise another of the system-wide error codes.
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.
Parameter | Description |
---|---|
aBalance | The playback balance, between KMMFBalanceMaxLeft and KMMFBalanceMaxRight |
Returns: An error code indicating if the call was successful. KErrNone on success, otherwise another of the system-wide error codes.
Returns the current recording balance setting between the left and right stereo microphones.
Parameter | Description |
---|---|
aBalance | On return, contains the current recording balance between KMMFBalanceMaxLeft and KMMFBalanceMaxRight |
Returns: An error code indicating if the call was successful. KErrNone on success, otherwise another of the system-wide error codes.
Returns a list of the supported codecs for the conversion destination.
Parameter | Description |
---|---|
aSupportedDataTypes | List of four character codes, representing supported data codecs for the conversion destination. |
Returns a list of the supported number of channels for recording. For example 1 for mono, 2 for stereo and so on.
Parameter | Description |
---|---|
aSupportedNumChannels | On return, contains a list of the number of channels supported for recording |
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
Parameter | Description |
---|---|
aSupportedSampleRates | On return, contains a list of the sample rates that are supported for recording. |
Returns the current volume setting for the audio device.
Parameter | Description |
---|---|
aVolume | On return contains the current volume setting of the audio device. Can be any value between zero and MaxVolume(). |
Returns: An error code indicating if the call was successful. KErrNone on success, otherwise another of the system-wide error codes.
TInt | MaxGain | ( | ) | [virtual] |
Return the maximum value for the gain
Returns: The maximum gain. For devices where automatic gain control is used, this value may be zero.
TInt | MaxVolume | ( | ) | [virtual] |
Returns the maximum volume setting for the audio device.
Returns: The maximum volume. This value is platform dependent but is always greater than or equal to one.
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.
Parameter | Description |
---|---|
aObserver | Class to receive state change events from recorder |
aServer | No longer used, should be NULL |
aPriority | 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. |
aPref | 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. |
Returns: A pointer to the new audio recorder object
void | OpenDesL | ( | const TDesC8 & | aDescriptor | ) | [virtual] |
Opens a descriptor to play back or record audio sample data (const version).
Parameter | Description |
---|---|
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. |
IMPORT_C void | OpenDesL | ( | TDes8 & | aDescriptor | ) |
Opens a descriptor to play back or record audio sample data.
Parameter | Description |
---|---|
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. |
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.
Parameter | Description |
---|---|
aDescriptor | The descriptor that contains or will contain the audio data. |
aRecordControllerUid | The UID of the controller to use for recording. |
aPlaybackControllerUid | The UID of the controller to use for playback. If KNullUid is used then the same controller is used for playback and recording. |
aDestinationFormatUid | The UID of the audio record format |
aDestinationDataType | Data type for recording. |
void | OpenFileL | ( | const TDesC & | aFileName | ) | [virtual] |
Opens a file to play back or record audio sample data.
Parameter | Description |
---|---|
aFileName | The full path and filename of the file which is a source of existing audio sample data. |
IMPORT_C void | OpenFileL | ( | const RFile & | aFile | ) |
Opens a file to play back or record audio sample data.
Parameter | Description |
---|---|
aFile | The full path and filename of the file which is a source of existing audio sample data. |
IMPORT_C void | OpenFileL | ( | const TMMSource & | aSource | ) |
Opens a file to play or record audio sample data.
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.
Parameter | Description |
---|---|
aFileName | The full path and filename of the file that contains or will contain the audio data. |
aRecordControllerUid | The UID of the controller to use for recording. |
aPlaybackControllerUid | The UID of the controller to use for playback. If KNullUid is used the same controller is used for playback and recording. |
aDestinationFormatUid | The UID of record audio format. |
aDestinationDataType | Data type for recording |
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.
Parameter | Description |
---|---|
aFile | The full path and filename of the file that contains or will contain the audio data. |
aRecordControllerUid | The UID of the controller to use for recording. |
aPlaybackControllerUid | The UID of the controller to use for playback. If KNullUid is used the same controller is used for playback and recording. |
aDestinationFormatUid | The UID of record audio format. |
aDestinationDataType | Data type for recording |
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.
Parameter | Description |
---|---|
aSource | The full path and filename of the file or a fiule handle that contains or will contain the audio data. |
aRecordControllerUid | The UID of the controller to use for recording. |
aPlaybackControllerUid | The UID of the controller to use for playback. If KNullUid is used the same controller is used for playback and recording. |
aDestinationFormatUid | The UID of record audio format. |
aDestinationDataType | Data type for recording |
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.
Parameter | Description |
---|---|
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). |
aFormat | The format of the audio clip. |
aArg1 | The codec/data type to use. |
aArg2 | The audio settings |
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.
Parameter | Description |
---|---|
aUrl | The URL that contains or will contain the audio data. |
aIapId | The ID of the internet access point to use. KUseDefaultIap selects the default Internet access point. |
aRecordControllerUid | The UID of the controller to use for recording. |
aPlaybackControllerUid | The UID of the controller to use for playback. If KNullUid is used then the same controller is used for playback and recording. |
aDestinationFormatUid | The UID of the audio record format. |
aDestinationDataType | Data type for recording. |
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.
Parameter | Description |
---|---|
aUrl | The URL that contains or will contain the audio data. |
aIapId | The ID of the internet access point to use. KUseDefaultIap selects the default Internet access point. |
aMimeType | The MIME type of the data pointed to by aUrl. |
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.
Parameter | Description |
---|---|
aDestination | The destination of the message, consisting of the uid of the interface of this message. |
aFunction | The function number to indicate which function is to be called on the interface defined in the aDestination parameter. |
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. |
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. |
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. |
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. |
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.
Parameter | Description |
---|---|
aDestination | The destination of the message, consisting of the uid of the interface of this message. |
aFunction | The function number to indicate which function is to be called on the interface defined in the aDestination parameter. |
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. |
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. |
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. |
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
Parameter | Description |
---|---|
aDestination | The destination of the message, consisting of the uid of the interface of this message. |
aFunction | The function number to indicate which function is to be called on the interface defined in the aDestination parameter. |
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. |
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. |
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. |
Returns: The result of the request. Exact range of values is dependent on the interface.
IMPORT_C TInt | PlayControllerCustomCommandSync | ( | const TMMFMessageDestinationPckg & | aDestination, |
TInt | aFunction, | |||
const TDesC8 & | aDataTo1, | |||
const TDesC8 & | aDataTo2 | |||
) |
Send a synchronous custom command to the playback controller.
Parameter | Description |
---|---|
aDestination | The destination of the message, consisting of the uid of the interface of this message. |
aFunction | The function number to indicate which function is to be called on the interface defined in the aDestination parameter. |
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. |
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. |
Returns: The result of the request. Exact range of values is dependent on the interface.
void | PlayL | ( | ) | [virtual] |
Reimplemented from CMdaAudioClipUtility::PlayL()
Begins playback of audio sample data at the current playback position using the current volume, gain and priority settings.
const TTimeIntervalMicroSeconds & | Position | ( | ) | [virtual] |
Reimplemented from CMdaAudioClipUtility::Position()
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.
Returns: The current position in the audio clip, in microseconds.
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.
Parameter | Description |
---|---|
aDestination | The destination of the message, consisting of the uid of the interface of this message. |
aFunction | The function number to indicate which function is to be called on the interface defined in the aDestination parameter. |
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. |
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. |
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. |
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. |
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.
Parameter | Description |
---|---|
aDestination | The destination of the message, consisting of the uid of the interface of this message. |
aFunction | The function number to indicate which function is to be called on the interface defined in the aDestination parameter. |
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. |
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. |
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. |
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.
Parameter | Description |
---|---|
aDestination | The destination of the message, consisting of the uid of the interface of this message. |
aFunction | The function number to indicate which function is to be called on the interface defined in the aDestination parameter. |
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. |
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. |
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. |
Returns: The result of the request. Exact range of values is dependent on the interface.
IMPORT_C TInt | RecordControllerCustomCommandSync | ( | const TMMFMessageDestinationPckg & | aDestination, |
TInt | aFunction, | |||
const TDesC8 & | aDataTo1, | |||
const TDesC8 & | aDataTo2 | |||
) |
Sends a synchronous custom command to the recording controller.
Parameter | Description |
---|---|
aDestination | The destination of the message, consisting of the uid of the interface of this message. |
aFunction | The function number to indicate which function is to be called on the interface defined in the aDestination parameter. |
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. |
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. |
Returns: The result of the request. Exact range of values is dependent on the interface.
void | RecordL | ( | ) | [virtual] |
Reimplemented from CMdaAudioClipUtility::RecordL()
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.
const TTimeIntervalMicroSeconds & | RecordTimeAvailable | ( | ) | [virtual] |
Reimplemented from CMdaAudioClipUtility::RecordTimeAvailable()
Returns the recording time available for the selected file or descriptor and encoding format.
Returns: The recording time available measured in microseconds.
IMPORT_C TInt | RegisterAudioResourceNotification | ( | MMMFAudioResourceNotificationCallback & | aCallback, |
TUid | aNotificationEventUid, | |||
const TDesC8 & | aNotificationRegistrationData = KNullDesC8 | |||
) |
Registers the Event for Notification when resource is avaliable.
Parameter | Description |
---|---|
aCallback | The audio outputstream observer interface.. |
aNotificationEventUid | The Event for which the client is registered. |
aNotificationRegistrationData | Notification registration specific data. |
Returns: An error code indicating if the registration was successful. KErrNone on success, otherwise another of the system-wide error codes.
IMPORT_C void | RegisterForAudioLoadingNotification | ( | MAudioLoadingObserver & | aCallback | ) |
Register to receive notifications of audio loading/rebuffering
Parameter | Description |
---|---|
aCallback | The object to receive audio loading notifications. |
Removes a specified meta data entry from the audio clip.
Parameter | Description |
---|---|
aMetaDataIndex | The index of the meta data entry to remove. |
Returns: An error code indicating if the call was successful. KErrNone on success, otherwise another of the system-wide error codes.
IMPORT_C void | ReplaceMetaDataEntryL | ( | TInt | aMetaDataIndex, |
CMMFMetaDataEntry & | aMetaDataEntry | |||
) |
Replaces the specified meta data entry with a new entry.
Parameter | Description |
---|---|
aMetaDataIndex | The index of the meta data entry to replace. |
aMetaDataEntry | The new meta data entry to replace the one pointed to by aMetaDataIndex. |
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.
Parameter | Description |
---|---|
aMode | One of the TDeviceMode settings |
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.
Parameter | Description |
---|---|
aBitRate | Destination bit rate in bits/second. |
IMPORT_C void | SetDestinationDataTypeL | ( | TFourCC | aDataType | ) |
Sets the codec to use with the record controller.
Parameter | Description |
---|---|
aDataType | Four character code, representing the codec of the destination audio clip |
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.
Parameter | Description |
---|---|
aFormatUid | UID of the audio clip format |
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().
Parameter | Description |
---|---|
aNumberOfChannels | The number of channels to record |
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.
Parameter | Description |
---|---|
aSampleRate | The sample rate of the conversion destination. |
void | SetGain | ( | TInt | aGain | ) | [virtual] |
Sets the gain for the audio device to a specified value.
Parameter | Description |
---|---|
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(). |
void | SetMaxWriteLength | ( | TInt | aMaxWriteLength = KMdaClipLocationMaxWriteLengthNone | ) | [virtual] |
Reimplemented from CMdaAudioClipUtility::SetMaxWriteLength(TInt)
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.
Parameter | Description |
---|---|
aMaxWriteLength | The maximum file size in bytes. If the default value is used, there is no maximum file size. |
void | SetPlayWindow | ( | const TTimeIntervalMicroSeconds & | aStart, |
const TTimeIntervalMicroSeconds & | aEnd | |||
) | [virtual] |
Reimplemented from CMdaAudioClipUtility::SetPlayWindow(const TTimeIntervalMicroSeconds &,const TTimeIntervalMicroSeconds &)
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.
Parameter | Description |
---|---|
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. |
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. |
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.
Parameter | Description |
---|---|
aBalance | The playback balance to set. |
Returns: An error code indicating if the call was successful. KErrNone on success, otherwise another of the system-wide error codes.
void | SetPosition | ( | const TTimeIntervalMicroSeconds & | aPosition | ) | [virtual] |
Reimplemented from CMdaAudioClipUtility::SetPosition(const TTimeIntervalMicroSeconds &)
Sets the head position.
Parameter | Description |
---|---|
aPosition | The new head position measured in microseconds. |
Sets the recording priority.
The priority is used to arbitrate between multiple objects simultaneously trying to access the sound hardware.
See also: CMdaAudioRecorderUtility::NewL()
Parameter | Description |
---|---|
aPriority | The Priority Value. |
aPref | The Priority Preference. |
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.
Parameter | Description |
---|---|
aBalance | The balance value to set. Any value between KMMFBalanceMaxLeft and KMMFBalanceMaxRight, the default value being KMMFBalanceCenter |
Returns: An error code indicating if the call was successful. KErrNone on success, otherwise another of the system-wide error codes.
void | SetRepeats | ( | TInt | aRepeatNumberOfTimes, |
const TTimeIntervalMicroSeconds & | aTrailingSilence | |||
) | [virtual] |
Reimplemented from CMdaAudioClipUtility::SetRepeats(TInt,const TTimeIntervalMicroSeconds &)
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.
Parameter | Description |
---|---|
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). |
aTrailingSilence | The length of the trailing silence in microseconds. Negative values will produce a panic USER 87. |
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.
Parameter | Description |
---|---|
aThreadPriority | The TThreadPriority that the thread should run under. The default is EPriorityNormal. |
Returns: TInt A standard error code: KErrNone if successful, KErrNotReady if the thread does not have a valid handle.
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.
Parameter | Description |
---|---|
aThreadPriority | The TThreadPriority that the thread should run under. The default is EPriorityNormal. |
Returns: TInt A standard error code: KErrNone if successful, KErrNotReady if the thread does not have a valid handle.
Sets the playback volume for the audio device to a specified value.
Parameter | Description |
---|---|
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. |
Returns: An error code indicating if the call was successful. KErrNone on success, otherwise another of the system-wide error codes. KErrNotReady indicates that the clip has not been sucessfully opened for play.
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.
Parameter | Description |
---|---|
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. |
IMPORT_C TUint | SourceBitRateL | ( | ) |
Returns the bit rate of the audio clip.
Returns: The bit rate of the audio clip
TState | State | ( | ) | [virtual] |
Reimplemented from CMdaAudioClipUtility::State()
Returns the current state of the audio sample data.
Returns: The state of the audio sample data.
void | Stop | ( | ) | [virtual] |
Reimplemented from CMdaAudioClipUtility::Stop()
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.
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.
IMPORT_C TInt | WillResumePlay | ( | ) |
Waits for the client to resume the play even after the default timer expires.
Returns: An error code indicating if the registration was successful. KErrNone on success, otherwise another of the system-wide error codes.