class AudioReaderInterface

Audio Reader Interface. More...

Contains pure virtuals
Full nameCoral::AudioReaderInterface
Definition#include <audioreaderinterface.h>
InheritsCoral::AudioQualityInterface [virtual public]
Inherited byMP3AudioReader, MultiAudioReader, WavAudioReader
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods


Detailed Description

This class is the interface for an audio reader.

AudioReaderInterface ()

[virtual]

Virtual destructor.

bool  openMedia (const char* name)

[pure virtual]

Open media.

Parameters:
nameName of media, e.g. a file name.

Returns: true, if AudioReader is ready for reading; false otherwise.

void  closeMedia ()

[pure virtual]

Close media, if opened.

bool  ready ()

[const pure virtual]

Check, if AudioReader is ready for reading.

Returns: true, if AudioReader is ready; false otherwise.

void  getMediaInfo (MediaInfo& mediaInfo)

[const pure virtual]

Get MediaInfo.

Parameters:
mediaInfoReference to store media info.

MediaError  getErrorCode ()

[const pure virtual]

Get error code.

Returns: Error code.

card64  getPosition ()

[const pure virtual]

Get current position.

Returns: Position in nanoseconds.

card64  getMaxPosition ()

[const pure virtual]

Get maximum position.

Returns: maximum position in nanoseconds.

void  setPosition (const card64 position)

[pure virtual]

Get position.

Parameters:
positionPosition in nanoseconds.

cardinal  getNextBlock (void* buffer, const cardinal blockSize)

[pure virtual]

Read next block. In case of an error, getNextBlock() should return 0 and set ready to false.

Parameters:
bufferBuffer for block to read.
blockSizeSize of block in bytes.

Returns: Number of bytes read.