AudioCDCallback Class Reference

Implement this interface to receive progress notifications from AudioCD when writing or reading audio. More...

#include <pb_api.h>

Inherits Reference.

Public Member Functions
virtual bool_t	onContinueRead ()
	The onContinue method is called to check if the reading operation should continue.
virtual bool_t	onContinueWrite ()
	The onContinueWrite method is called to check if the writing should continue.
virtual void	onReadProgress (uint32_t current, uint32_t all)
	The onProgress method is called to report the number of blocks read from the CD.
virtual void	onReadStatus (AudioCDStatus::Enum status)
	The onReadStatus method is called to report the status of the reading operation.
virtual void	onWriteProgress (uint32_t current, uint32_t all)
	The onProgress method is called to report the number of blocks written to the CD.
virtual void	onWriteStatus (AudioCDStatus::Enum status)
	The onWriteStatus method is called to report the status of the write operation.
virtual void	onWriteTrack (int32_t trackIndex, int32_t percentWritten)
	The onTrackStatus method is called to report the write progress of individual tracks.
int32_t	release () const
	Simple implementation of primo::Reference::release.
int32_t	retain () const
	Simple implementation of primo::Reference::retain.
int32_t	retainCount () const
	Simple implementation of primo::Reference::retainCount.
virtual int32_t	release () const =0
	Releases the instance.
virtual int32_t	retain () const =0
	Retains the instance.
virtual int32_t	retainCount () const =0
	Returns the current reference count.

Detailed Description

Implement this interface to receive progress notifications from AudioCD when writing or reading audio.

See also

AudioCD::setCallback

AudioCD::writeToCD

AudioCD::readTrackFromCD

AudioCD::readBlocksFromCD

Member Function Documentation

onContinueRead()

virtual bool_t onContinueRead ( )

virtual

The onContinue method is called to check if the reading operation should continue.

Returns

1 The reading should continue.

0 The reading should stop.

onContinueWrite()

virtual bool_t onContinueWrite ( )

virtual

The onContinueWrite method is called to check if the writing should continue.

Returns

1 The writing should continue.

0 The writing should stop.

onReadProgress()

virtual void onReadProgress ( uint32_t  current, uint32_t  all  )

virtual

The onProgress method is called to report the number of blocks read from the CD.

Parameters

current	The number of blocks that have been read from the CD.
all	The total number of blocks that will be read from the CD. This is always the size of the audio session in blocks.

Remarks

This method is called for every chunk read from the CD. This may be as frequently as 10 times per second. A minimal processing is recommended, otherwise the whole audio reading operation may slow significantly.

onReadStatus()

virtual void onReadStatus ( AudioCDStatus::Enum  status )

virtual

The onReadStatus method is called to report the status of the reading operation.

Parameters

status

[in] Audio CD status.

onWriteProgress()

virtual void onWriteProgress ( uint32_t  current, uint32_t  all  )

virtual

The onProgress method is called to report the number of blocks written to the CD.

Parameters

current	The number of blocks that have been written to the CD.
all	The total number of blocks that will be written to the CD. This is always the size of the audio session in blocks.

onWriteStatus()

virtual void onWriteStatus ( AudioCDStatus::Enum  status )

virtual

The onWriteStatus method is called to report the status of the write operation.

Parameters

status

Audio CD status.

onWriteTrack()

virtual void onWriteTrack ( int32_t  trackIndex, int32_t  percentWritten  )

virtual

The onTrackStatus method is called to report the write progress of individual tracks.

Parameters

trackIndex	The zero based index of the track that is being written.
percentWritten	The percentage of the track data that has been written to the CD.

release()

int32_t release ( ) const

virtual

Simple implementation of primo::Reference::release.

Returns

The updated reference count.

Implements Reference.

retain()

int32_t retain ( ) const

virtual

Simple implementation of primo::Reference::retain.

Returns

The updated reference count.

Implements Reference.

retainCount()

int32_t retainCount ( ) const

virtual

Simple implementation of primo::Reference::retainCount.

Returns

The current reference count.

Implements Reference.