CMdaAudioInputStream Class Reference

Returns the maximum gain level.

Instantiates a new audio input stream using default priority preferences.

for use, when data has been copied to a specified descriptor and when input streaming is

stopped. The caller must create a callback class that implements this interface.

UserEnvironment capability.

Static NewL

Instantiates a new audio input stream.

use. The caller must create a callback class which implements this interface.

EMdaPriorityMax and represents a relative priority. A higher value indicates a more important request.

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.

UserEnvironment capability.

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.

Static NewL

Opens an input audio stream package.

The MMdaAudioInputStreamCallback::MaisOpenComplete() callback function is called when the stream has been

opened and is ready to record data. If the open was unsuccessful, this is indicated by the aError parameter

of the callback.

Returns the current position within the data stream in microseconds since the start of streaming.

Records streaming raw audio data.

If this is the first ReadL() after a successful Open() this function starts the audio recording process.

The MMdaAudioInputStreamCallback::MaisBufferCopied() callback function is called when the buffer has been successfully

filled. A pointer to the newly filled buffer is returned in the callback.

Note: The MMdaAudioInputStreamCallback::MaisBufferCopied() callback function is also called when a Stop() is issued, with a

pointer to the remaining recorded audio data and the aError parameter of the callback set to indicate recording has finished.

Requests a Stop of the recording process.

The device is requested to Stop and does so after all unprocessed buffers are processed and passed

back to the input stream. The device is actually Stopped when the final empty buffer indicating

buffer process completion is received.

See also: CMdaAudioInputStream::Stop()

Sets the sample rate and number of audio channels.

Sets the current audio balance.

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

being KMMFBalanceCenter.

Sets the bit rate to a new value.

Sets the data type. If the data type is not explicitly set it will assumed to be pcm16.

If it is set then the hardware must support the data type being set otherwise the

function leaves with KErrNotSupported.

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

MaxGain(). A value which is less than zero is set to zero. A value which is greater

than MaxGain() is set to MaxGain().

Sets the audio priority values.

This function cannot be used while the stream object is open. It is intended for use before an Open()

is issued, or between a previous Stop() and a new Open().

See also: CMdaAudioInputStream::NewL()

Indicates that the client wishes to use a single buffer to collect the data.

This buffer is passed via the ReadL api.

buffer, EFalse to indicate use of multiple buffers.

Stops the recording process.

The MMdaAudioInputStreamCallback::MaisRecordComplete() callback function is called when recording has been halted. Just prior

to issuing this callback, the FIFO buffers are read and the remaining audio data passed back by a final

MMdaAudioInputStreamCallback::MaisBufferCopied() callback with its aError parameter set to KErrAbort.

Any remaining FIFO buffers are also passed back, with their aError parameter set to KErrAbort.

Stop is immediate and best used for premature stops, for example within destructors.

If it is critical to receive all data buffers upto the point that Recording has Stopped,

we recommend using RequestStop instead. Otherwise some trailing buffers may be lost from the recording process.

If a Stop is issued after a RequestStop, Stop will take precedent.

See also: CMdaAudioInputStream::RequestStop()