Default Constructor.

Destructor.

Deletes all objects and releases all resource owned by this instance.

Cancels the initialization process of a CMMFDevSound object

An error code indicating if the function call was successful. KErrNone on success, KerrNotReady if this is called before InitializeL() call or after the object has been initialized,

Cancels the Registered Notification.

An error code indicating if the function call was successful. KErrNone on success, KErrNotSupported if the event type is not supported otherwise another of the system-wide error codes.

Returns the supported Audio settings ie. encoding, sample rates, mono/stereo operation, buffer size etc.

The device settings.

Returns the current device configuration.

The device settings.

Second phase constructor.

Retrieves a custom interface to the device.

A pointer to the interface implementation, or NULL if the device does not implement the interface requested. The return value must be cast to the correct type by the user.The user should be careful while caching the custom interface pointer, as in some situations the lower level custom interface pointer may become NULL.

Empties the play buffers below DevSound without causing the codec to be deleted.

An error code indicating if the function call was successful. KErrNone on success, KErrNotSupported if called in a mode other than EMMFStatePlaying or if the function is otherwise not supported, KErrNotReady if this is called before playing, otherwise another of the system-wide error codes. If this function is not supported, it is advised to use Stop().

Returns the number of available pre-defined tone sequences.

This is the number of fixed sequence supported by DevSound by default.

The fixed sequence count. This value is implementation dependent but is always greater than or equal to zero.

Returns the name assigned to a specific pre-defined tone sequence.

This is the number of the fixed sequence supported by DevSound by default.

The function raises a panic if sequence number specified is invalid.

A reference to a Descriptor containing the fixed sequence name indexed by aSequenceNumber.

FixedSequenceCount()

Returns an integer representing the current gain.

The current gain level.

Returns the speaker balance set for playing.

Leaves on failure.

Returns the microphone gain balance set for recording.

Leaves on failure.

Returns the Notification data which the client needs to resume playing.

An error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

Returns a list of the supported input datatypes that can be sent to DevSound for playing audio. The datatypes returned are those that the DevSound supports given the priority settings passed in aPrioritySettings.

Note that if no supported data types are found this does not constitute failure, the function will return normally with no entries in aSupportedDataTypes.

Returns a list of the supported output dataypes that can be received from DevSound for recording audio. The datatypes returned are those that the DevSound supports given the priority settings passed in aPrioritySettings.

Note that if no supported data types are found this does not constitute failure, the function will return normally with no entries in aSupportedDataTypes.

Retrieves the current play time from the audio renderer

An error code indicating if the function call was successful. KErrNone on success, KErrNotSupported if the underlying devsound implementation or the HwDevice does not support this API, otherwise any of the system-wide error codes. If this function is not supported, SamplesPlayed() needs to be used instead.

IsGetTimePlayedSupported()

Initializes CMMFDevSound object to play and record PCM16 raw audio data with sampling rate of 8 KHz.

On completion of Initialization, calls InitializeComplete() on aDevSoundObserver.

Leaves on failure.

Initializes DevSound object for the mode aMode for processing audio data with hardware device aHWDev.

On completion of Initialization, the observer will be notified via call back InitializeComplete().

Leaves on failure.

Initializes DevSound object for the mode aMode for processing audio data with hardware device supporting FourCC aDesiredFourCC.

On completion of Initialization, the observer will be notified via call back InitializeComplete().

Leaves on failure.

This method can be used by devsound clients to check if the devsound implementation supports GetTimePlayed API. If this method returns EFalse, SamplesPlayed needs to be used.

ETrue if the underlying devsound implementation supports GetTimePlayed API, EFalse if the the underlying devsound implementation does not support GetTimePlayed API

GetTimePlayed()

This method can be used by devsound clients to check if current configuration supports resume This call is only valid when DevSound is initialized ETrue if current format does supports resume EFalse otherwise

Returns an integer representing the maximum gain the device supports.

This is the maximum value which can be passed to CMMFDevSound::SetGain.

The maximum gain. This value is platform dependent but is always greater than or equal to one.

Returns an integer representing the maximum volume device supports.

This is the maximum value which can be passed to CMMFDevSound::SetVolume.

The maximum volume. This value is platform dependent but is always greater than or equal to one.

Constructs, and returns a pointer to, a new CMMFDevSound object.

Leaves on failure.

Temporarily Stops the ongoing operation (Play, Record, TonePlay, Convert).

The behaviour of Pause() is currently undefined when the initialisation mode is not EMMFStateRecording, consequently different DevSound implementations exhibit different behaviour for pause during play. For this reason, it is recommended that when pausing of audio during playing is required, Stop() is used instead of the call to Pause(). To resume audio playing after Stop(), call PlayInitL(). Among other things, this will internally reset the SamplesPlayed() result and the calling code may need to remember the previous result to give the correct "samples played from start" value.

In the case of record, Pause is taken to mean halt any further recording but continue to call the MDevSoundObserver::BufferToBeEmptied() passing already recorded buffers. The last buffer flag should be set when all recorded buffers have been flushed.

CMMFDevSound::Stop()

CMMFDevSound::PlayInitL()

CMMFDevSound::SamplesPlayed()

Initializes the audio device and starts playing the DTMF string aDTMFString.

Leaves on failure.

Plays data in the buffer at the current volume.

The client should fill the buffer with audio data before calling this function. The observer gets a reference to the buffer along with the callback function BufferToBeFilled(). When playing of the audio sample is complete, successfully or otherwise, the function PlayError() on the observer is called.

The last buffer of the audio stream being played should have the last buffer flag set using CMMFBuffer::SetLastBuffer(TBool). If a subsequent attempt to play the clip is made, this flag will need resetting by the client.

MDevSoundObserver::PlayError()

Initializes audio device and starts playing a dual tone.

The generated tone consists of two sine waves of different frequencies summed together.

Dual Tone is played with the specified frequencies and for the specified duration.

Initializes the audio device and starts playing the specified pre-defined tone sequence.

Leaves on failure.

FixedSequenceCount()

Initializes the audio device and starts the play process.

This function queries and acquires the audio policy before initializing audio device. If there was an error during policy initialization, PlayError() function will be called on the observer with error code KErrAccessDenied, otherwise BufferToBeFilled() function will be called with a buffer reference. After reading data into the buffer reference passed, the client should call PlayData() to play data.

The amount of data that can be played is specified in CMMFBuffer::RequestSize(). Any data that is read into buffer beyond this size will be ignored.

Leaves on failure.

MDevSoundObserver::PlayError()

MDevSoundObserver::BufferToBeFilled()

Initializes the audio device and starts playing a tone. The tone is played with the frequency and duration specified.

Leaves on failure.

Initializes the audio device and starts playing a tone sequence.

Leaves on failure.

This method can be used by devsound clients to check if the devsound implementation ignores the underflow errors from the sound driver and does not propagate them to its clients.

ETrue if devsound ignores all the underflow errors from the sound driver except for the last buffer That means DevSound propagates the underflow error from sound driver to its clients only when client sets the last buffer flag on the CMMFBuffer type buffer. EFalse if devsound propagates the underflow errors from the sound driver in all the cases

Contine the process of recording.

Once the buffer is filled with recorded data, the Observer gets a reference to the buffer along with the callback function BufferToBeEmptied(). After processing the buffer (copying over to a different buffer or writing to file) the client should call this function to continue the recording process.

capability

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

Initializes audio device and starts the recording process.

This function queries and acquires the audio policy before initializing audio device. If there was an error during policy initialization, RecordError() function will be called on the observer with error code KErrAccessDenied, otherwise BufferToBeEmptied() function will be called with a buffer reference. This buffer contains recorded or encoded data. After processing data in the buffer reference passed, the client should call RecordData() to continue recording process.

The amount of data that is available is specified in CMMFBuffer::RequestSize().

Leaves on failure.

MDevSoundObserver::RecordError()

MDevSoundObserver::BufferToBeEmptied()

capability

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

Registers the client for notification of resource avalibility.

An error code indicating if the function call was successful. KErrNone on success, KErrNotSupported if the event type is not supported, KErrArgument if the notification data is not null otherwise another of the system-wide error codes.

Resume play back, recording or tone playing after this has been paused An error code indicating if the function call was successful. KErrNone on success, KErrNotSupported if current format configuration does not support this functionality KErrNotReady if DevSound is not paused

Returns the number of samples played so far.

The samples played.

Returns the number samples recorded so far.

The samples recorded.

Sets client thread info for devsound to make proper policy and routing decisions

capability

MultimediaDD A process requires MultimediaDD capability to make this call.

Configure CMMFDevSound object with the settings in aConfig.

Use this to set sampling rate, encoding and mono/stereo.

Defines the duration of tone on, tone off and tone pause to be used during the DTMF tone playback operation.

Supported only during tone playing.

Changes the current recording gain to a specified value.

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

Sets the speaker balance for playing.

The speaker balance can be changed before or during playback and is effective immediately.

Defines the priority settings that should be used for this instance.

Sets the microphone gain balance for recording.

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

Defines the number of times the audio is to be repeated during the tone playback operation.

A period of silence can follow each playing of a tone. The tone playing can be repeated indefinitely.

Changes the current playback volume to a specified value.

The volume can be changed before or during playback and is effective immediately.

Defines the period over which the volume level is to rise smoothly from nothing to the normal volume level.

The function is only available while the tone is playing.

Stops the ongoing operation (Play, Record, TonePlay, Convert).

This function should be synchronous and invoke no callbacks through MDevSoundObserver.

Returns an integer representing the current volume.

The current volume level.

Wait for the clients to resume play back even after the default timeout expires. Unless the client cancels the notification request or completes no other client gets notification.

An error code indicating if the function call was successful. KErrNone on success, KErrPermissionDenied if the client does not have MultimediaDD capaility, otherwise another of the system-wide error codes.

DevSound body