From 2ea2d92e3b4e1e87ffe1df14da877334834a499f Mon Sep 17 00:00:00 2001 From: Gary Scavone Date: Fri, 11 Oct 2013 02:06:28 +0200 Subject: Release 4.0.12 tarball --- doc/html/RtAudio_8h.html | 136 ++++++++++++++++++++++++++++++----------------- 1 file changed, 86 insertions(+), 50 deletions(-) (limited to 'doc/html/RtAudio_8h.html') diff --git a/doc/html/RtAudio_8h.html b/doc/html/RtAudio_8h.html index 601e574..9196f77 100644 --- a/doc/html/RtAudio_8h.html +++ b/doc/html/RtAudio_8h.html @@ -8,37 +8,58 @@
Home   Class/Enum List   File List   Compound Members  
- + + +
+
+Classes | +Typedefs
+
+
RtAudio.h File Reference
+
-

RtAudio.h File Reference

#include <string>
+
#include <string>
#include <vector>
#include "RtError.h"
#include <sstream>
- +

Go to the source code of this file.

- - - - - - - - - - - - - - - - - - - +

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.
+ + + + + + + + + + + + + +

+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.
 
-

Detailed Description

-

Typedef Documentation

- +

Typedef Documentation

+
@@ -46,15 +67,14 @@
typedef unsigned long RtAudioFormat
-
-
+

RtAudio data format type.

-

Support for signed integers and floats. Audio data fed to/from an RtAudio stream is assumed to ALWAYS be in host byte order. The internal routines will automatically take care of any necessary byte-swapping between the host format and the soundcard. Thus, endian-ness is not a concern in the following format definitions. Note that 24-bit data is expected to be encapsulated in a 32-bit format.

+

Support for signed integers and floats. Audio data fed to/from an RtAudio stream is assumed to ALWAYS be in host byte order. The internal routines will automatically take care of any necessary byte-swapping between the host format and the soundcard. Thus, endian-ness is not a concern in the following format definitions.

  • RTAUDIO_SINT8: 8-bit signed integer.
  • RTAUDIO_SINT16: 16-bit signed integer.
    • -
  • RTAUDIO_SINT24: Lower 3 bytes of 32-bit signed integer.
    • +
  • RTAUDIO_SINT24: 24-bit signed integer.
  • RTAUDIO_SINT32: 32-bit signed integer.
  • RTAUDIO_FLOAT32: Normalized between plus/minus 1.0.
  • RTAUDIO_FLOAT64: Normalized between plus/minus 1.0.
    • @@ -62,7 +82,7 @@
- +
@@ -70,8 +90,7 @@
typedef unsigned long RtAudioStreamFlags
-
-
+

RtAudio stream option flags.

The following flags can be OR'ed together to allow a client to make changes to the default stream behavior:

@@ -89,7 +108,7 @@
- +
@@ -97,8 +116,7 @@
typedef unsigned long RtAudioStreamStatus
-
-
+

RtAudio stream status (over- or underflow) flags.

Notification of a stream over- or underflow is indicated by a non-zero stream status argument in the RtAudioCallback function. The stream status can be one of the following two options, depending on whether the stream is open for output and/or input:

@@ -109,40 +127,58 @@
- +
- +
typedef int(* RtAudioCallback)(void *outputBuffer, void *inputBuffer, unsigned int nFrames, double streamTime, RtAudioStreamStatus status, void *userData)typedef int(* RtAudioCallback)(void *outputBuffer, void *inputBuffer, unsigned int nFrames, double streamTime, RtAudioStreamStatus status, void *userData)
-
-
+

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.

-
Parameters:
- - - - - - - +
Parameters
+
outputBuffer For output (or duplex) streams, the client should write nFrames of audio sample frames into this buffer. This argument should be recast to the datatype specified when the stream was opened. For input-only streams, this argument will be NULL.
inputBuffer For input (or duplex) streams, this buffer will hold nFrames of input audio sample frames. This argument should be recast to the datatype specified when the stream was opened. For output-only streams, this argument will be NULL.
nFrames The number of sample frames of input or output data in the buffers. The actual buffer size in bytes is dependent on the data type and number of channels in use.
streamTime The number of seconds that have elapsed since the stream was started.
status If non-zero, this argument indicates a data overflow or underflow condition for the stream. The particular condition can be determined by comparison with the RtAudioStreamStatus flags.
userData A pointer to optional data provided by the client when opening the stream (default = NULL).
+ + + + + +
outputBufferFor output (or duplex) streams, the client should write nFrames of audio sample frames into this buffer. This argument should be recast to the datatype specified when the stream was opened. For input-only streams, this argument will be NULL.
inputBufferFor input (or duplex) streams, this buffer will hold nFrames of input audio sample frames. This argument should be recast to the datatype specified when the stream was opened. For output-only streams, this argument will be NULL.
nFramesThe number of sample frames of input or output data in the buffers. The actual buffer size in bytes is dependent on the data type and number of channels in use.
streamTimeThe number of seconds that have elapsed since the stream was started.
statusIf non-zero, this argument indicates a data overflow or underflow condition for the stream. The particular condition can be determined by comparison with the RtAudioStreamStatus flags.
userDataA pointer to optional data provided by the client when opening the stream (default = NULL).

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.

+
+ +
+
+ + + + +
typedef void(* RtAudioErrorCallback)(RtError::Type type, const std::string &errorText)
+
+ +

RtAudio error callback function prototype.

+
Parameters
+ + + +
typeType of error.
errorTextError description.
+
+
+
+
- - +
©2001-2012 Gary P. Scavone, McGill University. All Rights Reserved.
Maintained by Gary P. Scavone.
©2001-2013 Gary P. Scavone, McGill University. All Rights Reserved.
Maintained by Gary P. Scavone.
- -- cgit v1.2.3