---

syn::AudioOStream Class Reference

Abstract Output stream for audio targets. More...

#include <AudioOStream.h>

Inheritance diagram for syn::AudioOStream:

[legend]List of all members.

Public Methods
virtual	~AudioOStream ()
virtual bool	open (const syn::AudioFormat &destfmt)=0
	open the stream specify the format of your data you'll be passing to write(). More...
virtual bool	isOpen ()=0
	is the stream open? More...
virtual bool	canAcceptMoreData () const=0
	poll this function to know when to give more data to update. More...
virtual bool	write (const void *const data, int samples)=0
	write samples to the audio stream. More...
virtual int	pcount () const=0
	get the put count == the number of samples last written by write(). More...
virtual bool	close ()=0
	close the stream... More...
virtual void	flush ()=0

---

Detailed Description

Abstract Output stream for audio targets.

examples of targets can be audio apis, network streams, audio files like wav or aiff, ...

Definition at line 44 of file AudioOStream.h.

---

Constructor & Destructor Documentation

syn::AudioOStream::~AudioOStream ( ) [inline, virtual]

Definition at line 47 of file AudioOStream.h.

---

Member Function Documentation

bool syn::AudioOStream::open ( const syn::AudioFormat & fmt ) [pure virtual]

open the stream specify the format of your data you'll be passing to write(). Reimplemented in syn::OpenALAudioOStream, syn::RawAudioOStream, and syn::WavAudioOStream.

bool syn::AudioOStream::isOpen ( ) [pure virtual]

is the stream open? Reimplemented in syn::OpenALAudioOStream, syn::RawAudioOStream, and syn::WavAudioOStream.

bool syn::AudioOStream::canAcceptMoreData ( ) const [pure virtual]

poll this function to know when to give more data to update. Reimplemented in syn::OpenALAudioOStream, and syn::RawAudioOStream.

bool syn::AudioOStream::write ( const void *const data, int samples ) [pure virtual]

write samples to the audio stream. Reimplemented in syn::RawAudioOStream.

int syn::AudioOStream::pcount ( ) const [pure virtual]

get the put count == the number of samples last written by write(). Reimplemented in syn::OpenALAudioOStream, syn::RawAudioOStream, and syn::WavAudioOStream.

bool syn::AudioOStream::close ( ) [pure virtual]

close the stream... Reimplemented in syn::OpenALAudioOStream, syn::RawAudioOStream, and syn::WavAudioOStream.

void syn::AudioOStream::flush ( ) [pure virtual]

Reimplemented in syn::OpenALAudioOStream, and syn::RawAudioOStream.

---

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

• /root/src/subsynth/syn/Stream/AudioOStream.h

---