Logo Search packages:      
Sourcecode: lastfm version File versions  Download package

RtAudio Class Reference

#include <RtAudio.h>

List of all members.


Detailed Description

Realtime audio i/o C++ classes.

RtAudio provides a common API (Application Programming Interface) for realtime audio input/output across Linux (native ALSA, Jack, and OSS), SGI, Macintosh OS X (CoreAudio), and Windows (DirectSound and ASIO) operating systems.

RtAudio WWW site: http://music.mcgill.ca/~gary/rtaudio/

RtAudio: realtime audio i/o C++ classes Copyright (c) 2001-2005 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.

Definition at line 336 of file RtAudio.h.


Public Types

enum  RtAudioApi {
  UNSPECIFIED, LINUX_ALSA, LINUX_OSS, LINUX_JACK,
  MACOSX_CORE, IRIX_AL, WINDOWS_ASIO, WINDOWS_DS
}
 Audio API specifier arguments. More...

Public Member Functions

void abortStream ()
 Stop a stream, discarding any samples remaining in the input/output queue.
void cancelStreamCallback ()
 A public method which cancels a callback process and function for the stream.
void closeStream ()
 Public method which closes a stream and frees any associated buffers.
int getDeviceCount (void)
 A public method which returns the number of audio devices found.
RtAudioDeviceInfo getDeviceInfo (int device)
 Return an RtAudioDeviceInfo structure for a specified device number.
char *const getStreamBuffer ()
 A public method which returns a pointer to the buffer for an open stream.
void openStream (int outputDevice, int outputChannels, int inputDevice, int inputChannels, RtAudioFormat format, int sampleRate, int *bufferSize, int *numberOfBuffers)
 A public method for opening a stream and also returning numberOfBuffers parameter via pointer argument.
void openStream (int outputDevice, int outputChannels, int inputDevice, int inputChannels, RtAudioFormat format, int sampleRate, int *bufferSize, int numberOfBuffers)
 A public method for opening a stream with the specified parameters.
 RtAudio (int outputDevice, int outputChannels, int inputDevice, int inputChannels, RtAudioFormat format, int sampleRate, int *bufferSize, int *numberOfBuffers, RtAudioApi api=UNSPECIFIED)
 An overloaded constructor which opens a stream and also returns numberOfBuffers parameter via pointer argument.
 RtAudio (int outputDevice, int outputChannels, int inputDevice, int inputChannels, RtAudioFormat format, int sampleRate, int *bufferSize, int numberOfBuffers, RtAudioApi api=UNSPECIFIED)
 A constructor which can be used to open a stream during instantiation.
 RtAudio (RtAudioApi api=UNSPECIFIED)
 The default class constructor.
void setStreamCallback (RtAudioCallback callback, void *userData)
 A public method which sets a user-defined callback function for a given stream.
void startStream ()
 Public method which starts a stream.
void stopStream ()
 Stop a stream, allowing any samples remaining in the queue to be played out and/or read in.
void tickStream ()
 Public method used to trigger processing of input/output data for a stream.
 ~RtAudio ()
 The destructor.

Protected Member Functions

void initialize (RtAudioApi api)

Protected Attributes

RtApi * rtapi_

The documentation for this class was generated from the following files:

Generated by  Doxygen 1.6.0   Back to index