AudioOutput Class Reference

Defines an audio output when reading from an Audio CD. More...

#include <PrimoBurner.h>

Inherits Reference.

List of all members.

Public Member Functions
virtual AudioOutput *	clone () const =0
	Creates a copy of the AudioOutput object.
virtual const char_t *	filePath () const =0
	Gets the path set with setFilePath.
virtual void	setFilePath (const char_t *path)=0
	Sets the full path to the file to which AudioCD should write data when reading from an Audio CD.
virtual void	setStorageType (AudioStorage::Enum storage)=0
	Sets the audio storage type.
virtual void	setStream (primo::Stream *stream)=0
	Set the output stream that should be used for writing audio data during audio track ripping.
virtual AudioStorage::Enum	storageType () const =0
	Gets the audio storage type.
virtual primo::Stream *	stream () const =0
	Gets the audio stream set with setStream.

---

Detailed Description

Defines an audio output when reading from an Audio CD.

---

Member Function Documentation

virtual AudioOutput* clone

(

)

const [pure virtual]

Creates a copy of the AudioOutput object.

Returns:

A copy of the AudioOutput. The new object should be released when it is not needed anymore.

see Object Management

virtual const char_t* filePath

(

)

const [pure virtual]

Gets the path set with setFilePath.

Returns:

A null-terminated string or NULL if no file path is set.

virtual void setFilePath

(

const char_t *

path

)

[pure virtual]

Sets the full path to the file to which AudioCD should write data when reading from an Audio CD.

Parameters:

path	The full path to the audio output file.

The file extension implicitly specifies the output type regardless of the storage type. NOTE: Even when the storage type is AudioStorage::Stream the file path is still required in order to specify the Stream type. If the stream represents a wav output the file path can be set to ".wav".

virtual void setStorageType

(

AudioStorage::Enum

storage

)

[pure virtual]

Sets the audio storage type.

Parameters:

storage

A constant from the AudioStorage enumeration.

If you do not set the audio storage, the default value of AudioStorage::File will be used.

If the audio output is in a CD Audio format (raw PCM, 44100 Hz, 16-bit, stereo) it is directly written and no plug-in is needed to 'encode' the audio output. The CD Audio format is indicated by the extension (.cd-audio).

See also:

AudioStorage::Enum

AudioOutput::setAudioStream

AudioOutput::setFilePath

virtual void setStream

(

primo::Stream *

stream

)

[pure virtual]

Set the output stream that should be used for writing audio data during audio track ripping.

In order for this method to work AudioStorage::Stream should be set as an audio storage using the setStorageType method.

Parameters:

stream

[in] a pointer to an object that implements primo::Stream.

virtual AudioStorage::Enum storageType

(

)

const [pure virtual]

Gets the audio storage type.

Returns:

A constant from the AudioStorage enumeration.

See also:

AudioStorage::Enum

AudioOutput::audioStream

AudioOutput::filePath

AudioOutput::storageType

virtual primo::Stream* stream

(

)

const [pure virtual]

Gets the audio stream set with setStream.

Returns:

A pointer to an object that implements primo::Stream or NULL if no stream is set.