Async::AudioPacer Class Reference

An audio pipe class that pace audio output. More...

#include <AsyncAudioPacer.h>

Inheritance diagram for Async::AudioPacer:

Public Member Functions
	AudioPacer (int sample_rate, int block_size, int prebuf_time)
	Constuctor.
	~AudioPacer (void)
	Destructor.
virtual int	writeSamples (const float *samples, int count)
	Write samples into this audio sink.
virtual void	flushSamples (void)
	Tell the sink to flush the previously written samples.
virtual void	resumeOutput (void)
	Resume audio output to the sink.
Public Member Functions inherited from Async::AudioSink
	AudioSink (void)
	Default constuctor.
virtual	~AudioSink (void)
	Destructor.
bool	registerSource (AudioSource *source)
	Register an audio source to provide samples to this sink.
void	unregisterSource (void)
	Unregister the previously registered audio source.
bool	isRegistered (void) const
	Check if an audio source has been registered.
AudioSource *	source (void) const
	Get the registered audio source.
Public Member Functions inherited from Async::AudioSource
	AudioSource (void)
	Default constuctor.
virtual	~AudioSource (void)
	Destructor.
bool	registerSink (AudioSink *sink, bool managed=false)
	Register an audio sink to provide samples to.
void	unregisterSink (void)
	Unregister the previously registered audio sink.
bool	isRegistered (void) const
	Check if an audio sink has been registered.
AudioSink *	sink (void) const
	Get the registered audio sink.
bool	sinkManaged (void) const
	Check if the sink is managed or not.
void	handleAllSamplesFlushed (void)
	The registered sink has flushed all samples.

Protected Member Functions
virtual void	allSamplesFlushed (void)
	The registered sink has flushed all samples.
Protected Member Functions inherited from Async::AudioSink
void	sourceResumeOutput (void)
	Tell the source that we are ready to accept more samples.
void	sourceAllSamplesFlushed (void)
	Tell the source that all samples have been flushed.
bool	setHandler (AudioSink *handler)
	Setup another sink to handle the incoming audio.
void	clearHandler (void)
	Clear a handler that was previously setup with setHandler.
AudioSink *	handler (void) const
Protected Member Functions inherited from Async::AudioSource
int	sinkWriteSamples (const float *samples, int len)
void	sinkFlushSamples (void)
bool	setHandler (AudioSource *handler)
	Setup another source to handle the outgoing audio.
AudioSource *	handler (void) const
void	clearHandler (void)
	Clear a handler that was previously setup with setHandler.

Detailed Description

An audio pipe class that pace audio output.

Author

Tobias Blomberg

Date

2007-11-17

This class is used in an audio pipe chain to pace audio output.

Definition at line 115 of file AsyncAudioPacer.h.

Constructor & Destructor Documentation

AudioPacer()

Async::AudioPacer::AudioPacer	(	int	sample_rate,
		int	block_size,
		int	prebuf_time )

Constuctor.

Parameters

sample_rate	The sample rate of the incoming samples
block_size	The size of the audio blocks
prebuf_time	The time (ms) to wait before starting to send audio

~AudioPacer()

Async::AudioPacer::~AudioPacer

(

void

)

Destructor.

Member Function Documentation

allSamplesFlushed()

virtual void Async::AudioPacer::allSamplesFlushed ( void )

protectedvirtual

The registered sink has flushed all samples.

This function will be called when all samples have been flushed in the registered sink. If it is not reimplemented, a handler must be set that handle the function call. This function is normally only called from a connected sink object.

Reimplemented from Async::AudioSource.

flushSamples()

virtual void Async::AudioPacer::flushSamples ( void )

virtual

Tell the sink to flush the previously written samples.

This function is used to tell the sink to flush previously written samples. When done flushing, the sink should call the sourceAllSamplesFlushed function. This function is normally only called from a connected source object.

Reimplemented from Async::AudioSink.

resumeOutput()

virtual void Async::AudioPacer::resumeOutput ( void )

virtual

Resume audio output to the sink.

This function will be called when the registered audio sink is ready to accept more samples. This function is normally only called from a connected sink object.

Reimplemented from Async::AudioSource.

writeSamples()

virtual int Async::AudioPacer::writeSamples ( const float * samples, int count )

virtual

Write samples into this audio sink.

Parameters

samples	The buffer containing the samples
count	The number of samples in the buffer

Returns

Returns the number of samples that has been taken care of

This function is used to write audio into this audio sink. If it returns 0, no more samples should be written until the resumeOutput function in the source have been called. This function is normally only called from a connected source object.

Reimplemented from Async::AudioSink.

---

The documentation for this class was generated from the following file:

• AsyncAudioPacer.h