.TH "KAudioPlayStream" kde3 "11 Jun 2005" "Version Version 3.4.1" "arts Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KAudioPlayStream \- A wrapper around ByteSoundProducer/ByteStreamToAudio/Synth_AMAN_PLAY.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kaudioplaystream.h>\fP
.PP
Inherits \fBQObject\fP.
.PP
.SS "Public Slots"

.in +1c
.ti -1c
.RI "void \fBstart\fP (int samplingRate, int bits, int channels)"
.br
.ti -1c
.RI "void \fBstop\fP ()"
.br
.ti -1c
.RI "void \fBwrite\fP (\fBQByteArray\fP &data)"
.br
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBrequestData\fP (\fBQByteArray\fP &)"
.br
.ti -1c
.RI "void \fBrunning\fP (bool)"
.br
.ti -1c
.RI "void \fBnoData\fP ()"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKAudioPlayStream\fP (\fBKArtsServer\fP *server, const \fBQString\fP title, \fBQObject\fP *\fBparent\fP=0, const char *\fBname\fP=0)"
.br
.ti -1c
.RI "\fB~KAudioPlayStream\fP ()"
.br
.ti -1c
.RI "void \fBsetPolling\fP (bool)"
.br
.ti -1c
.RI "bool \fBpolling\fP () const "
.br
.ti -1c
.RI "bool \fBrunning\fP () const "
.br
.ti -1c
.RI "Arts::StereoEffectStack \fBeffectStack\fP () const "
.br
.ti -1c
.RI "void \fBfillData\fP (Arts::DataPacket< Arts::mcopbyte > *packet)"
.br
.in -1c
.SH "Detailed Description"
.PP 
A wrapper around ByteSoundProducer/ByteStreamToAudio/Synth_AMAN_PLAY. 

\fBAuthor:\fP
.RS 4
Arnold Krille <arnold@arnoldarts.de> 
.RE
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 42 of file kaudioplaystream.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KAudioPlayStream::KAudioPlayStream (\fBKArtsServer\fP * server, const \fBQString\fP title, \fBQObject\fP * parent = \fC0\fP, const char * name = \fC0\fP)"
.PP
Creates a KAudioPlayStream on server with a title. 
.PP
You should pass the \fBKArtsServer\fP also as parent to be sure this object is deleted before the server is.
.PP
\fBParameters:\fP
.RS 4
\fIserver\fP The server where it should play to. 
.br
\fItitle\fP The title that is shown in the AudioManager. 
.br
\fIparent\fP You will propably want to pass the server as parent to so this stream gets deleted before the server disappears.
.RE
.PP

.PP
Definition at line 85 of file kaudioplaystream.cpp.
.PP
References endl(), k_funcinfo, and kdDebug().
.SS "KAudioPlayStream::~\fBKAudioPlayStream\fP ()"
.PP
Destructs the KAudioPlayStream. 
.PP

.PP
Definition at line 91 of file kaudioplaystream.cpp.
.PP
References endl(), k_funcinfo, and kdDebug().
.SH "Member Function Documentation"
.PP 
.SS "void KAudioPlayStream::setPolling (bool)"
.PP
Controls wether this Stream should poll the data from you via the signal. 
.PP
\fBSee also:\fP
.RS 4
\fBrequestData()\fP or you use 
.PP
\fBwrite()\fP to fill the inputbuffer.
.RE
.PP
Default is true
.PP
Definition at line 96 of file kaudioplaystream.cpp.
.SS "bool KAudioPlayStream::polling () const"
.PP
Returns the polling state. 
.PP
\fBSee also:\fP
.RS 4
\fBsetPolling\fP
.RE
.PP

.PP
Definition at line 97 of file kaudioplaystream.cpp.
.SS "bool KAudioPlayStream::running () const"
.PP
\fBReturns:\fP
.RS 4
wether this stream is running ('on air') or not.
.RE
.PP

.PP
Definition at line 99 of file kaudioplaystream.cpp.
.PP
Referenced by start(), and stop().
.SS "Arts::StereoEffectStack KAudioPlayStream::effectStack () const"
.PP
\fBReturns:\fP
.RS 4
The Arts::StereoEffectStack right before the Synth_AMAN_PLAY.
.RE
.PP

.PP
Definition at line 101 of file kaudioplaystream.cpp.
.SS "void KAudioPlayStream::start (int samplingRate, int bits, int channels)\fC [slot]\fP"
.PP
Start the stream. 
.PP
\fBParameters:\fP
.RS 4
\fIsamplingRate\fP how many samples per second ( typically 11000/22050/44100/48000 ) 
.br
\fIbits\fP how many bits per sample ( 8 / 16 ) 
.br
\fIchannels\fP how many channels ( 1 or 2 )
.RE
.PP

.PP
Definition at line 105 of file kaudioplaystream.cpp.
.PP
References endl(), k_funcinfo, kdDebug(), and running().
.SS "void KAudioPlayStream::stop ()\fC [slot]\fP"
.PP
Stops the stream. 
.PP

.PP
Definition at line 128 of file kaudioplaystream.cpp.
.PP
References endl(), k_funcinfo, kdDebug(), and running().
.SS "void KAudioPlayStream::write (\fBQByteArray\fP & data)\fC [slot]\fP"
.PP
Write data into the inputbuffer. 
.PP
If you ignore the signal 
.PP
\fBSee also:\fP
.RS 4
\fBnoData()\fP it will play 0 ( silence ).
.RE
.PP

.PP
Definition at line 150 of file kaudioplaystream.cpp.
.SS "void KAudioPlayStream::requestData (\fBQByteArray\fP &)\fC [signal]\fP"
.PP
This signal is emitted when audio should be played. 
.PP
You have to fill the array with data.
.PP
Referenced by fillData().
.SS "void KAudioPlayStream::running (bool)\fC [signal]\fP"
.PP
Is emitted when the state changes. 
.PP

.SS "void KAudioPlayStream::noData ()\fC [signal]\fP"
.PP
Is emitted if the inputbuffer runs dry and polling os off. 
.PP

.SS "void KAudioPlayStream::fillData (Arts::DataPacket< Arts::mcopbyte > * packet)"
.PP
TODO: Implement a queue and fetching from it... 
.PP
Definition at line 154 of file kaudioplaystream.cpp.
.PP
References requestData().

.SH "Author"
.PP 
Generated automatically by Doxygen for arts Library from the source code.
