e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-02-07 09:46:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Version 4.3.0

Browse Source
This commit is contained in:
Gary Scavone
2009-03-24 23:02:15 -04:00
committed by Stephen Sinclair
parent 2cbce2d8bd
commit 27d9b79dc7
271 changed files with 22219 additions and 8834 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
doc/doxygen/realtime.txt
View File

@@ -12,18 +12,24 @@ SineWave.h, is 2048 samples.
The class RtWvOut is a protected subclass of WvOut. A number of
optional constructor arguments can be used to fine tune its
performance for a given system. RtWvOut provides a "single-sample"
interface to the RtAudio class. Note that RtWvOut (as well as the
RtWvIn and RtDuplex classes described below) make use of RtAudio's
blocking input/output functionality. On systems that implement an
inherently callback-based audio API (Linux Jack, Windows ASIO, OS-X
CoreAudio), this blocking functionality will be less robust. An
example of audio output using a callback scheme will be discussed in a
subsequent tutorial section.
performance for a given system. RtWvOut provides a "single-sample",
blocking interface to the RtAudio class. Note that RtWvOut (as well
as the RtWvIn class described below) makes use of RtAudio's callback
input/output functionality by creating a large ring-buffer into which
data is written. These classes should not be used when low-latency
and robust performance is necessary
Though not used here, an RtWvIn class exists as well that can be used to read realtime audio data from an input device. See the <TT>record.cpp</TT> example program in the <TT>examples</TT> project for more information.
Though not used here, an RtWvIn class exists as well that can be used
to read realtime audio data from an input device. See the
<TT>record.cpp</TT> example program in the <TT>examples</TT> project
for more information.
It may be possible to use an instance of RtWvOut and an instance of RtWvIn to simultaneously read and write realtime audio to and from a hardware device or devices. However, it is recommended to instead use a single instance of RtDuplex to achieve this behavior, in that it guarantees better synchronization between the input and output data. See the <TT>effects</TT> project or the <TT>io.cpp</TT> example program in the <TT>examples</TT> project for more information.
It may be possible to use an instance of RtWvOut and an instance of
RtWvIn to simultaneously read and write realtime audio to and from a
hardware device or devices. However, it is recommended to instead use
a single instance of RtAudio to achieve this behavior, as described in the next section.
See the <TT>effects</TT> project or the <TT>duplex.cpp</TT> example
program in the <TT>examples</TT> project for more information.
When using any realtime STK class (RtAudio, RtWvOut, RtWvIn, RtDuplex, RtMidi, InetWvIn, InetWvOut, Socket, UdpSocket, TcpServer, TcpClient, and Thread), it is necessary to specify an audio/MIDI API preprocessor definition and link with the appropriate libraries or frameworks. For example, the above program could be compiled on a Linux system using the GNU g++ compiler and the ALSA audio API as follows (assuming all necessary files exist in the project directory):