PrimoBurner(tm) for C++  4.6
CD, DVD and Blu-ray Software Development Kit
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Pages
AudioOutput Class Referenceabstract

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

#include <PrimoBurnerAPI.h>

Inherits Reference.

Public Member Functions

virtual AudioOutputclone () const =0
 Creates a copy of the AudioOutput object. More...
 
virtual const char_t * filePath () const =0
 Gets the path set with setFilePath. More...
 
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. More...
 
virtual void setStorageType (AudioStorage::Enum storage)=0
 Sets the audio storage type. More...
 
virtual void setStream (primo::Stream *stream)=0
 Set the output stream that should be used for writing audio data during audio track ripping. More...
 
virtual AudioStorage::Enum storageType () const =0
 Gets the audio storage type. More...
 
virtual primo::Streamstream () const =0
 Gets the audio stream set with setStream. More...
 
- Public Member Functions inherited from Reference
virtual int32_t release () const =0
 Releases the instance. More...
 
virtual int32_t retain () const =0
 Retains the instance. More...
 
virtual int32_t retainCount () const =0
 Returns the current reference count. More...
 

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
pathThe 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
storageA 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::setStream
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::stream
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.