CMdaAudioOutputStream Class Reference

Destructor.

Frees all resources owned by the object prior to its destruction.

Cancels the registered notification event.

Retrieves a custom interface to the underlying device.

Returns the current data type.

Returns the current balance as an integer.

Returns the current number of bytes rendered by audio hardware.

When this method is called, AudioOutputStream goes into a different mode wherein it does not call MaoscPlayComplete() with KErrUnderflow when all the supplied data has been played. Instead client should signal the end of the play by calling RequestStop() or Stop() on AudioOutputStream. If the client calls RequestStop(), AudioOutputStream waits until all the queued data has been played out and then calls MaoscPlayComplete(). This behaviour is different from that of Stop(), which stops the play immediately by discarding all the queued data.

Client should call this method on CMdaAudioOutputStream just after its construction and its effect remains through out its lifetime.

Note: This feature is supported only on a DevSound which ignores the underflow errors in the middle of the play i.e which returns ETrue from QueryIgnoresUnderflow().

See also: CMdaAudioOutputStream::RequestStop() CMMFDevSound::QueryIgnoresUnderflow()

Returns the maximum volume level.

Allocates and constructs an audio stream player object.

Static NewL

Constructs and initialises a new instance of an audio streaming object.

The function leaves if the audio streaming object cannot be created.

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 output audio stream package.

The MMdaAudioOutputStreamCallback::MaoscOpenComplete() callback function is called when the stream has been opened and is ready to receive audio data. If the open was unsuccessful, this is indicated by the aError parameter of the callback.

Pause data rendering by audio hardware.

Returns the current position within the data stream.

Registers the Event for Notification when resource is avaliable. Registers the Event for Notification when resource is avaliable.

This method signals the end of play when the AudioOutputStream is in KeepOpenAtEnd mode i.e when client makes KeepOpenAtEnd call on it. When RequestStop is called, AudioOutputStream completes playing all the data that is supplied to it and calls MaoscPlayComplete() with KErrUnderflow.

Note: Before calling this method, client must have already called KeepOpenAtEnd() successfully, Otherwise, this method returns KErrNotSupported. It is recommended to use KeepOpenAtEnd and RequestStop calls to get a predictable behaviour during stopping.

See also: CMdaAudioOutputStream::KeepOpenAtEnd()

Resume data rendering by audio hardware.

Sets the sample rate and number of audio channels.

Sets the audio balance.

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 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: CMdaAudioOutputStream::NewL()

Sets the audio volume.

Set the volume to zero for "sound off" or any other value between 1 and MaxVolume().

Stops writing data to a stream.

Returns the current volume.

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

Writes (plays) streaming raw audio data.

This function is asynchronous. When aData has been received, the client is notified by a call to MMdaAudioOutputStreamCallback::MaoscBufferCopied(). The client can call WriteL() again before this notification takes place because the buffers are maintained in a client-side queue until they have been sent. An active object performs the notification, and copies the next item in the queue to the server. MMdaAudioOutputStreamCallback::MaoscPlayComplete() is called when all descriptors have been sent.