---

syn::OpenALAudioOStream Class Reference

Output stream for OpenAL. More...

#include <OpenALAudioOStream.h>

Inheritance diagram for syn::OpenALAudioOStream:

[legend]Collaboration diagram for syn::OpenALAudioOStream:

[legend]List of all members.

Public Methods
	OpenALAudioOStream ()
virtual	~OpenALAudioOStream ()
void	setContext (syn::AudioContext &ctx)
virtual bool	open (const syn::AudioFormat &fmt)
	open the stream specify the format of your data you'll be passing to write(). More...
virtual bool	isOpen ()
	is the stream open? More...
void	resizeBuffers (signed int numBuffers=2)
	setup the number of buffers to use, default is double buffered (2). More...
virtual bool	canAcceptMoreData () const
	poll this function to know when to give more data to update. More...
virtual bool	write (const void *const data, signed int size)
	write samples to the sound hardware. More...
virtual int	pcount () const
	get the put count == the number of samples last written by write(). More...
virtual bool	close ()
	close the stream... More...
virtual void	flush ()
virtual const syn::AudioFormat&	format () const
	what format of audio data does this stream accept? More...

---

Detailed Description

Output stream for OpenAL.

Definition at line 51 of file OpenALAudioOStream.h.

---

Constructor & Destructor Documentation

syn::OpenALAudioOStream::OpenALAudioOStream ( )

Definition at line 53 of file OpenALAudioOStream.cpp.

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

Definition at line 55 of file OpenALAudioOStream.h.

---

Member Function Documentation

void syn::OpenALAudioOStream::setContext ( syn::AudioContext & ctx ) [inline]

Definition at line 57 of file OpenALAudioOStream.h.

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

open the stream specify the format of your data you'll be passing to write(). Reimplemented from syn::AudioOStream. Definition at line 103 of file OpenALAudioOStream.cpp.

bool syn::OpenALAudioOStream::isOpen ( ) [inline, virtual]

is the stream open? Reimplemented from syn::AudioOStream. Definition at line 68 of file OpenALAudioOStream.h.

void syn::OpenALAudioOStream::resizeBuffers ( signed int numBuffers = 2 )

setup the number of buffers to use, default is double buffered (2).

bool syn::OpenALAudioOStream::canAcceptMoreData ( ) const [virtual]

poll this function to know when to give more data to update. Reimplemented from syn::AudioOStream. Definition at line 210 of file OpenALAudioOStream.cpp.

bool syn::OpenALAudioOStream::write ( const void *const data, signed int size ) [virtual]

write samples to the sound hardware. make sure it is still in the format you opened the steam in... samples are in terms of [channels * bytes_per_samp]

int syn::OpenALAudioOStream::pcount ( ) const [inline, virtual]

get the put count == the number of samples last written by write(). Reimplemented from syn::AudioOStream. Definition at line 83 of file OpenALAudioOStream.h.

bool syn::OpenALAudioOStream::close ( ) [virtual]

close the stream... Reimplemented from syn::AudioOStream. Definition at line 360 of file OpenALAudioOStream.cpp. Referenced by open().

void syn::OpenALAudioOStream::flush ( ) [virtual]

Reimplemented from syn::AudioOStream. Definition at line 92 of file OpenALAudioOStream.cpp.

const syn::AudioFormat & syn::OpenALAudioOStream::format ( ) const [inline, virtual]

what format of audio data does this stream accept? Definition at line 92 of file OpenALAudioOStream.h.

---

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

• /root/src/subsynth/syn/Stream/OpenALAudioOStream.h
• /root/src/subsynth/syn/Stream/OpenALAudioOStream.cpp

---