From 9f727b28665547db7609c0baf5c39ca96af71565 Mon Sep 17 00:00:00 2001 From: Gary Scavone Date: Thu, 10 Oct 2013 23:55:02 +0200 Subject: Release 2.0.1 tarball --- doc/html/classRtAudio.html | 66 +++++++++++++++++++++++----------------------- 1 file changed, 33 insertions(+), 33 deletions(-) (limited to 'doc/html/classRtAudio.html') diff --git a/doc/html/classRtAudio.html b/doc/html/classRtAudio.html index 9986e3a..cb4eff4 100644 --- a/doc/html/classRtAudio.html +++ b/doc/html/classRtAudio.html @@ -19,33 +19,33 @@

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

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

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

-void tickStream (int streamID) +void tickStream (int streamId)  Public method used to trigger processing of input/output data for a stream. More...

-void closeStream (int streamID) +void closeStream (int streamId)  Public method which closes a stream and frees any associated buffers. More...

-void startStream (int streamID) +void startStream (int streamId)  Public method which starts a stream. More...

-void stopStream (int streamID) +void stopStream (int streamId)  Stop a stream, allowing any samples remaining in the queue to be played out and/or read in. More...

-void abortStream (int streamID) +void abortStream (int streamId)  Stop a stream, discarding any samples remaining in the input/output queue. More...

-int streamWillBlock (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 @@ -172,7 +172,7 @@ RtAudio::RtAudio (

The default constructor.

-Probes the system to make sure at least one audio input/output device is available and determines the api-specific identifier for each device found. An RtAudioError error can be thrown if no devices are found or if a memory allocation error occurs. +Probes the system to make sure at least one audio input/output device is available and determines the api-specific identifier for each device found. An RtError error can be thrown if no devices are found or if a memory allocation error occurs.

@@ -185,7 +185,7 @@ Probes the system to make sure at least one audio input/output device is availab RtAudio::RtAudio ( -int * streamID, +int * streamId, @@ -251,7 +251,7 @@ int numberOfBuffers )

A constructor which can be used to open a stream during instantiation.

-The specified output and/or input device identifiers correspond to those enumerated via the getDeviceInfo() method. If device = 0, the default or first available devices meeting the given parameters is selected. If an output or input channel value is zero, the corresponding device value is ignored. When a stream is successfully opened, its identifier is returned via the "streamID" pointer. An RtAudioError can be thrown if no devices are found for the given parameters, if a memory allocation error occurs, or if a driver error occurs.

+The specified output and/or input device identifiers correspond to those enumerated via the getDeviceInfo() method. If device = 0, the default or first available devices meeting the given parameters is selected. If an output or input channel value is zero, the corresponding device value is ignored. When a stream is successfully opened, its identifier is returned via the "streamId" pointer. An RtError can be thrown if no devices are found for the given parameters, if a memory allocation error occurs, or if a driver error occurs.
See also:
openStream()
@@ -358,7 +358,7 @@ int numberOfBuffers )

A public method for opening a stream with the specified parameters.

-If successful, the opened stream ID is returned. Otherwise, an RtAudioError is thrown.

+If successful, the opened stream ID is returned. Otherwise, an RtError is thrown.
Parameters:
@@ -429,7 +429,7 @@ void * userData )

A public method which sets a user-defined callback function for a given stream.

-This method assigns a callback function to a specific, previously opened stream for non-blocking stream functionality. A separate process is initiated, though the user function is called only when the stream is "running" (between calls to the startStream() and stopStream() methods, respectively). The callback process remains active for the duration of the stream and is automatically shutdown when the stream is closed (via the closeStream() method or by object destruction). The callback process can also be shutdown and the user function de-referenced through an explicit call to the cancelStreamCallback() method. Note that a single stream can use only blocking or callback functionality at the same time, though it is possible to alternate modes on the same stream through the use of the setStreamCallback() and cancelStreamCallback() methods (the blocking tickStream() method can be used before a callback is set and/or after a callback is cancelled). An RtAudioError will be thrown for an invalid device argument. +This method assigns a callback function to a specific, previously opened stream for non-blocking stream functionality. A separate process is initiated, though the user function is called only when the stream is "running" (between calls to the startStream() and stopStream() methods, respectively). The callback process remains active for the duration of the stream and is automatically shutdown when the stream is closed (via the closeStream() method or by object destruction). The callback process can also be shutdown and the user function de-referenced through an explicit call to the cancelStreamCallback() method. Note that a single stream can use only blocking or callback functionality at the same time, though it is possible to alternate modes on the same stream through the use of the setStreamCallback() and cancelStreamCallback() methods (the blocking tickStream() method can be used before a callback is set and/or after a callback is cancelled). An RtError will be thrown for an invalid device argument.

outputDevice: @@ -399,7 +399,7 @@ A value which can be used to help control device latency. More buffers typically void RtAudio::setStreamCallback ( -int streamID, +int streamId,

@@ -442,7 +442,7 @@ This method assigns a callback function to a specific, previously opened stream void RtAudio::cancelStreamCallback ( -int streamID ) +int streamId ) @@ -460,7 +460,7 @@ int streamID )

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 RtAudioError will be thrown for an invalid device argument. +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.

@@ -528,7 +528,7 @@ int device,

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

-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 RtAudioError will be thrown for an invalid device argument. +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.

@@ -541,7 +541,7 @@ Any device between 0 and getDeviceCoun char *const RtAudio::getStreamBuffer ( -int streamID ) +int streamId ) @@ -559,7 +559,7 @@ int streamID )

A public method which returns a pointer to the buffer for an open stream.

-The user should fill and/or read the buffer data in interleaved format and then call the tickStream() method. An RtAudioError will be thrown for an invalid stream identifier. +The user should fill and/or read the buffer data in interleaved format and then call the tickStream() method. An RtError will be thrown for an invalid stream identifier.

@@ -572,7 +572,7 @@ The user should fill and/or read the buffer data in interleaved format and then void RtAudio::tickStream ( -int streamID ) +int streamId ) @@ -590,7 +590,7 @@ int streamID )

Public method used to trigger processing of input/output data for a stream.

-This method blocks until all buffer data is read/written. An RtAudioError will be thrown for an invalid stream identifier or if a driver error occurs. +This method blocks until all buffer data is read/written. An RtError will be thrown for an invalid stream identifier or if a driver error occurs.

@@ -603,7 +603,7 @@ This method blocks until all buffer data is read/written. An -int streamID ) +int streamId ) @@ -621,7 +621,7 @@ int streamID )

Public method which closes a stream and frees any associated buffers.

-If an invalid stream identifier is specified, this method issues a warning and returns (an RtAudioError is not thrown). +If an invalid stream identifier is specified, this method issues a warning and returns (an RtError is not thrown).

@@ -634,7 +634,7 @@ If an invalid stream identifier is specified, this method issues a warning and r void RtAudio::startStream ( -int streamID ) +int streamId ) @@ -652,7 +652,7 @@ int streamID )

Public method which starts a stream.

-An RtAudioError will be thrown for an invalid stream identifier or if a driver error occurs. +An RtError will be thrown for an invalid stream identifier or if a driver error occurs.

@@ -665,7 +665,7 @@ An RtAudioError will be thrown f void RtAudio::stopStream ( -int streamID ) +int streamId ) @@ -683,7 +683,7 @@ int streamID )

Stop a stream, allowing any samples remaining in the queue to be played out and/or read in.

-An RtAudioError will be thrown for an invalid stream identifier or if a driver error occurs. +An RtError will be thrown for an invalid stream identifier or if a driver error occurs.

@@ -696,7 +696,7 @@ An RtAudioError will be thrown f void RtAudio::abortStream ( -int streamID ) +int streamId ) @@ -714,7 +714,7 @@ int streamID )

Stop a stream, discarding any samples remaining in the input/output queue.

-An RtAudioError will be thrown for an invalid stream identifier or if a driver error occurs. +An RtError will be thrown for an invalid stream identifier or if a driver error occurs.

@@ -727,7 +727,7 @@ An RtAudioError will be thrown f int RtAudio::streamWillBlock ( -int streamID ) +int streamId ) @@ -909,7 +909,7 @@ Normalized between plus/minus 1.0.

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

    -- cgit v1.2.3