From f58f7c5aafe9b52acf26fad31ac2c01c6a184fbc Mon Sep 17 00:00:00 2001 From: Gary Scavone Date: Thu, 10 Oct 2013 23:57:51 +0200 Subject: Release 2.1 tarball --- doc/html/classRtAudio.html | 227 +++++++++++++-------------------------------- 1 file changed, 62 insertions(+), 165 deletions(-) (limited to 'doc/html/classRtAudio.html') diff --git a/doc/html/classRtAudio.html b/doc/html/classRtAudio.html index cb4eff4..157d97a 100644 --- a/doc/html/classRtAudio.html +++ b/doc/html/classRtAudio.html @@ -1,38 +1,37 @@ - - -The RtAudio Tutorial - - - -
-Tutorial   Class/Enum List   File List   Compound Members  
+ + +The RtAudio Tutorial + + + +
+Tutorial   Class/Enum List   File List   Compound Members  
-

RtAudio Class Reference

#include <RtAudio.h> +

RtAudio Class Reference

Realtime audio i/o C++ class. +More... +

+#include <RtAudio.h>

List of all members. - - - - - + - + - + - - + + - + @@ -48,101 +47,30 @@ - - - - - - -

Public Types

typedef unsigned long RTAUDIO_FORMAT
typedef int (* RTAUDIO_CALLBACK )(char *buffer, int bufferSize, void *userData)
enum  { MAX_SAMPLE_RATES = 14 - }

Public Methods

 RtAudio ()
 The default constructor. More...

 RtAudio (int *streamId, int outputDevice, int outputChannels, int inputDevice, int inputChannels, RTAUDIO_FORMAT format, int sampleRate, int *bufferSize, int numberOfBuffers)
 RtAudio (int *streamId, int outputDevice, int outputChannels, int inputDevice, int inputChannels, RTAUDIO_FORMAT format, int sampleRate, int *bufferSize, int numberOfBuffers)
 A constructor which can be used to open a stream during instantiation. More...

 ~RtAudio ()
 The destructor. More...

int openStream (int outputDevice, int outputChannels, int inputDevice, int inputChannels, RTAUDIO_FORMAT format, int sampleRate, int *bufferSize, int numberOfBuffers)
int openStream (int outputDevice, int outputChannels, int inputDevice, int inputChannels, RTAUDIO_FORMAT format, int sampleRate, int *bufferSize, int numberOfBuffers)
 A public method for opening a stream with the specified parameters. More...

void setStreamCallback (int streamId, RTAUDIO_CALLBACK callback, void *userData)
void setStreamCallback (int streamId, RTAUDIO_CALLBACK callback, void *userData)
 A public method which sets a user-defined callback function for a given stream. More...

void cancelStreamCallback (int streamId)
 A public method which cancels a callback process and function for a given stream. More...

int getDeviceCount (void)
 A public method which returns the number of audio devices found. More...

+int getDeviceCount (void)
 A public method which returns the number of audio devices found.

void getDeviceInfo (int device, RTAUDIO_DEVICE *info)
 Fill a user-supplied RTAUDIO_DEVICE structure for a specified device. More...

 Fill a user-supplied RTAUDIO_DEVICE structure for a specified device number. More...

char* const getStreamBuffer (int streamId)
 A public method which returns a pointer to the buffer for an open stream. More...

void tickStream (int streamId)
int streamWillBlock (int streamId)
 Queries a stream to determine whether a call to the tickStream() method will block. More...


Static Public Attributes

const RTAUDIO_FORMAT RTAUDIO_SINT8
const RTAUDIO_FORMAT RTAUDIO_SINT16
const RTAUDIO_FORMAT RTAUDIO_SINT24
const RTAUDIO_FORMAT RTAUDIO_SINT32
const RTAUDIO_FORMAT RTAUDIO_FLOAT32
const RTAUDIO_FORMAT RTAUDIO_FLOAT64
-

Member Typedef Documentation

-

- - - - + + + + + +
- - - - - -
-typedef unsigned long RtAudio::RTAUDIO_FORMAT -
-
const RTAUDIO_FORMAT RTAUDIO_SINT8
const RTAUDIO_FORMAT RTAUDIO_SINT16
const RTAUDIO_FORMAT RTAUDIO_SINT24
const RTAUDIO_FORMAT RTAUDIO_SINT32
const RTAUDIO_FORMAT RTAUDIO_FLOAT32
const RTAUDIO_FORMAT RTAUDIO_FLOAT64
- - - - - -
-   - - +

Detailed Description

+Realtime audio i/o C++ class.

-

-

- - - - -
- - - - - -
-typedef int(* RtAudio::RTAUDIO_CALLBACK)(char *buffer, int bufferSize, void *userData) -
-
- - - - - -
-   - - +RtAudio provides a common API (Application Programming Interface) for realtime audio input/output across Linux (native ALSA and OSS), SGI, Macintosh OS X (CoreAudio), and Windows (DirectSound and ASIO) operating systems.

-

-

Member Enumeration Documentation

-

- - - - -
- - - - - -
-anonymous enum -
-
- - - - - -
-   - - +RtAudio WWW site: http://www-ccrma.stanford.edu/~gary/rtaudio/ +

+RtAudio: a realtime audio i/o C++ class Copyright (c) 2001-2002 Gary P. Scavone +

+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: +

+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. +

+Any person wishing to distribute modifications to the Software is requested to send the modifications to the original developer so that they can be incorporated into the canonical version. +

+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

-

-Enumeration values:
- - -
MAX_SAMPLE_RATES -  -
-
-

Constructor & Destructor Documentation

@@ -215,7 +143,7 @@ int inputChannels, @@ -322,7 +250,7 @@ int inputChannels, @@ -405,7 +333,7 @@ int streamId, @@ -463,37 +391,6 @@ A public method which cancels a callback process and function for a given stream This method shuts down a callback process and de-references the user function for a specific stream. Callback functionality can subsequently be restarted on the stream via the setStreamCallback() method. An RtError will be thrown for an invalid device argument.
-RTAUDIO_FORMAT format, +RTAUDIO_FORMAT format,
-RTAUDIO_FORMAT format, +RTAUDIO_FORMAT format,
-RTAUDIO_CALLBACK callback, +RTAUDIO_CALLBACK callback,
-

- - - - -
- - - - - - -
-int RtAudio::getDeviceCount ( - -void ) -
-
- - - - - -
-   - - -

-A public method which returns the number of audio devices found. -

-

@@ -526,9 +423,9 @@ int device, +Any device integer between 1 and getDeviceCount() is valid. If a device is busy or otherwise unavailable, the structure member "probed" will have a value of "false" and all other members are undefined. If the specified device is the current default input or output device, the "isDefault" member will have a value of "true". An RtError will be thrown for an invalid device argument.

-Fill a user-supplied RTAUDIO_DEVICE structure for a specified device. +Fill a user-supplied RTAUDIO_DEVICE structure for a specified device number.

-Any device between 0 and getDeviceCount()-1 is valid. If a device is busy or otherwise unavailable, the structure member "probed" has a value of "false". The system default input and output devices are referenced by device identifier = 0. On systems which allow dynamic default device settings, the default devices are not identified by name (specific device enumerations are assigned device identifiers > 0). An RtError will be thrown for an invalid device argument.

@@ -756,7 +653,7 @@ A return value of 0 indicates that the stream will NOT block. A positive return @@ -772,7 +669,7 @@ const RTAUDIO_FORMAT RtAudio::RTAU +8-bit signed integer.
-const RTAUDIO_FORMAT RtAudio::RTAUDIO_SINT8 [static] +const RTAUDIO_FORMAT RtAudio::RTAUDIO_SINT8 [static]

-

@@ -782,7 +679,7 @@ const RTAUDIO_FORMAT RtAudio::RTAU @@ -798,7 +695,7 @@ const RTAUDIO_FORMAT RtAudio::RTAU +16-bit signed integer.
-const RTAUDIO_FORMAT RtAudio::RTAUDIO_SINT16 [static] +const RTAUDIO_FORMAT RtAudio::RTAUDIO_SINT16 [static]

-

@@ -808,7 +705,7 @@ const RTAUDIO_FORMAT RtAudio::RTAU @@ -824,7 +721,7 @@ const RTAUDIO_FORMAT RtAudio::RTAU +Upper 3 bytes of 32-bit signed integer.
-const RTAUDIO_FORMAT RtAudio::RTAUDIO_SINT24 [static] +const RTAUDIO_FORMAT RtAudio::RTAUDIO_SINT24 [static]

-Upper 3 bytes of 32-bit integer.

@@ -834,7 +731,7 @@ Upper 3 bytes of 32-bit integer. @@ -850,7 +747,7 @@ const RTAUDIO_FORMAT RtAudio::RTAU +32-bit signed integer.
-const RTAUDIO_FORMAT RtAudio::RTAUDIO_SINT32 [static] +const RTAUDIO_FORMAT RtAudio::RTAUDIO_SINT32 [static]

-

@@ -860,7 +757,7 @@ const RTAUDIO_FORMAT RtAudio::RTAU @@ -886,7 +783,7 @@ Normalized between plus/minus 1.0.
-const RTAUDIO_FORMAT RtAudio::RTAUDIO_FLOAT32 [static] +const RTAUDIO_FORMAT RtAudio::RTAUDIO_FLOAT32 [static]
@@ -907,12 +804,12 @@ Normalized between plus/minus 1.0.
-const RTAUDIO_FORMAT RtAudio::RTAUDIO_FLOAT64 [static] +const RTAUDIO_FORMAT RtAudio::RTAUDIO_FLOAT64 [static]

The documentation for this class was generated from the following file: -
- -
- ©2001-2002 CCRMA, Stanford University. All Rights Reserved.
- Maintained by Gary P. Scavone, gary@ccrma.stanford.edu

-

- - +
+ +
+ ©2001-2002 Gary P. Scavone, CCRMA, Stanford University. All Rights Reserved.
+ Maintained by Gary P. Scavone, gary@ccrma.stanford.edu

+

+ + -- cgit v1.2.3