X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=doc%2Fhtml%2FRtAudio_8h.html;h=9196f772ddaba631dff76cf4ac8984d235835974;hb=2ea2d92e3b4e1e87ffe1df14da877334834a499f;hp=b38da617d1e619be11845dcca40bd4b8de2fb1b1;hpb=a1bbe4d94da4e9fd19f54bf83de23a6f5dc345df;p=rtaudio.git diff --git a/doc/html/RtAudio_8h.html b/doc/html/RtAudio_8h.html index b38da61..9196f77 100644 --- a/doc/html/RtAudio_8h.html +++ b/doc/html/RtAudio_8h.html @@ -1,56 +1,184 @@ - -
-#include <map>
-Go to the source code of this file.
Compounds | ||||||||||||||||||||||||||||
class | RtAudioError | |||||||||||||||||||||||||||
class | RtAudio | |||||||||||||||||||||||||||
struct | RtAudio::RTAUDIO_DEVICE | |||||||||||||||||||||||||||
struct | RtAudio::RTAUDIO_STREAM | |||||||||||||||||||||||||||
Defines | ||||||||||||||||||||||||||||
#define | __RtAudio_h |
+Classes | |
class | RtAudio |
Realtime audio i/o C++ classes. More... | |
struct | RtAudio::DeviceInfo |
The public device information structure for returning queried values. More... | |
struct | RtAudio::StreamParameters |
The structure for specifying input or ouput stream parameters. More... | |
struct | RtAudio::StreamOptions |
The structure for specifying stream options. More... | |
+Typedefs | |
typedef unsigned long | RtAudioFormat |
RtAudio data format type. | |
typedef unsigned int | RtAudioStreamFlags |
RtAudio stream option flags. | |
typedef unsigned int | RtAudioStreamStatus |
RtAudio stream status (over- or underflow) flags. | |
typedef int(* | RtAudioCallback )(void *outputBuffer, void *inputBuffer, unsigned int nFrames, double streamTime, RtAudioStreamStatus status, void *userData) |
RtAudio callback function prototype. | |
typedef void(* | RtAudioErrorCallback )(RtError::Type type, const std::string &errorText) |
RtAudio error callback function prototype. | |
-
-
+
+
+RtAudio stream option flags. +The following flags can be OR'ed together to allow a client to make changes to the default stream behavior: +
By default, RtAudio streams pass and receive audio data from the client in an interleaved format. By passing the RTAUDIO_NONINTERLEAVED flag to the openStream() function, audio data will instead be presented in non-interleaved buffers. In this case, each buffer argument in the RtAudioCallback function will point to a single array of data, with Certain audio APIs offer a number of parameters that influence the I/O latency of a stream. By default, RtAudio will attempt to set these parameters internally for robust (glitch-free) performance (though some APIs, like Windows Direct Sound, make this difficult). By passing the RTAUDIO_MINIMIZE_LATENCY flag to the openStream() function, internal stream settings will be influenced in an attempt to minimize stream latency, though possibly at the expense of stream performance. +If the RTAUDIO_HOG_DEVICE flag is set, RtAudio will attempt to open the input and/or output stream device(s) for exclusive use. Note that this is not possible with all supported audio APIs. +If the RTAUDIO_SCHEDULE_REALTIME flag is set, RtAudio will attempt to select realtime scheduling (round-robin) for the callback thread. +If the RTAUDIO_ALSA_USE_DEFAULT flag is set, RtAudio will attempt to open the "default" PCM device when using the ALSA API. Note that this will override any specified input or output device id. + +
+
+
+
+
+
+
+RtAudio stream status (over- or underflow) flags. +Notification of a stream over- or underflow is indicated by a non-zero stream
+
+
+
+
+
+
+RtAudio callback function prototype. +All RtAudio clients must create a function of type RtAudioCallback to read and/or write data from/to the audio stream. When the underlying audio system is ready for new input or output data, this function will be invoked. +
To continue normal stream operation, the RtAudioCallback function should return a value of zero. To stop the stream and drain the output buffer, the function should return a value of one. To abort the stream immediately, the client should return a value of two. + +
+
+
+
+
+
+
+RtAudio error callback function prototype. +
+
- -
|