falkTX
/
rtaudio
mirror of https://github.com/falkTX/rtaudio
1
0
Fork 0
Code Releases 27 Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2 Commits
5 Branches
4.3MB
Tree: cdfd5a2d8e
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'cdfd5a2d8e'
${ noResults }
rtaudio/doc/man/man3/RtAudio.3

254 lines
12KB
Raw Blame History 

  1. .TH "RtAudio" 3 "22 Jan 2002" "RtAudio" \" -*- nroff -*-

  2. .ad l

  3. .nh

  4. .SH NAME

  5. RtAudio \- 

  6. .SH SYNOPSIS

  7. .br

  8. .PP

  9. \fC#include <RtAudio.h>\fP

  10. .PP

  11. .SS "Public Types"

  12. 

  13. .in +1c

  14. .ti -1c

  15. .RI "typedef unsigned long \fBRTAUDIO_FORMAT\fP"

  16. .br

  17. .ti -1c

  18. .RI "typedef int (* \fBRTAUDIO_CALLBACK\fP )(char *buffer, int bufferSize, void *userData)"

  19. .br

  20. .ti -1c

  21. .RI "enum { \fBMAX_SAMPLE_RATES\fP =  14  }"

  22. .br

  23. .in -1c

  24. .SS "Public Methods"

  25. 

  26. .in +1c

  27. .ti -1c

  28. .RI "\fBRtAudio\fP ()"

  29. .br

  30. .RI "\fIThe default constructor.\fP"

  31. .ti -1c

  32. .RI "\fBRtAudio\fP (int *streamID, int outputDevice, int outputChannels, int inputDevice, int inputChannels, \fBRTAUDIO_FORMAT\fP format, int sampleRate, int *bufferSize, int numberOfBuffers)"

  33. .br

  34. .RI "\fIA constructor which can be used to open a stream during instantiation.\fP"

  35. .ti -1c

  36. .RI "\fB~RtAudio\fP ()"

  37. .br

  38. .RI "\fIThe destructor.\fP"

  39. .ti -1c

  40. .RI "int \fBopenStream\fP (int outputDevice, int outputChannels, int inputDevice, int inputChannels, \fBRTAUDIO_FORMAT\fP format, int sampleRate, int *bufferSize, int numberOfBuffers)"

  41. .br

  42. .RI "\fIA public method for opening a stream with the specified parameters.\fP"

  43. .ti -1c

  44. .RI "void \fBsetStreamCallback\fP (int streamID, \fBRTAUDIO_CALLBACK\fP callback, void *userData)"

  45. .br

  46. .RI "\fIA public method which sets a user-defined callback function for a given stream.\fP"

  47. .ti -1c

  48. .RI "void \fBcancelStreamCallback\fP (int streamID)"

  49. .br

  50. .RI "\fIA public method which cancels a callback process and function for a given stream.\fP"

  51. .ti -1c

  52. .RI "int \fBgetDeviceCount\fP (void)"

  53. .br

  54. .RI "\fIA public method which returns the number of audio devices found.\fP"

  55. .ti -1c

  56. .RI "void \fBgetDeviceInfo\fP (int device, \fBRTAUDIO_DEVICE\fP *info)"

  57. .br

  58. .RI "\fIFill a user-supplied \fBRTAUDIO_DEVICE\fP structure for a specified device.\fP"

  59. .ti -1c

  60. .RI "char* const \fBgetStreamBuffer\fP (int streamID)"

  61. .br

  62. .RI "\fIA public method which returns a pointer to the buffer for an open stream.\fP"

  63. .ti -1c

  64. .RI "void \fBtickStream\fP (int streamID)"

  65. .br

  66. .RI "\fIPublic method used to trigger processing of input/output data for a stream.\fP"

  67. .ti -1c

  68. .RI "void \fBcloseStream\fP (int streamID)"

  69. .br

  70. .RI "\fIPublic method which closes a stream and frees any associated buffers.\fP"

  71. .ti -1c

  72. .RI "void \fBstartStream\fP (int streamID)"

  73. .br

  74. .RI "\fIPublic method which starts a stream.\fP"

  75. .ti -1c

  76. .RI "void \fBstopStream\fP (int streamID)"

  77. .br

  78. .RI "\fIStop a stream, allowing any samples remaining in the queue to be played out and/or read in.\fP"

  79. .ti -1c

  80. .RI "void \fBabortStream\fP (int streamID)"

  81. .br

  82. .RI "\fIStop a stream, discarding any samples remaining in the input/output queue.\fP"

  83. .ti -1c

  84. .RI "int \fBstreamWillBlock\fP (int streamID)"

  85. .br

  86. .RI "\fIQueries a stream to determine whether a call to the \fBtickStream\fP() method will block.\fP"

  87. .in -1c

  88. .SS "Static Public Attributes"

  89. 

  90. .in +1c

  91. .ti -1c

  92. .RI "const \fBRTAUDIO_FORMAT\fP \fBRTAUDIO_SINT8\fP"

  93. .br

  94. .ti -1c

  95. .RI "const \fBRTAUDIO_FORMAT\fP \fBRTAUDIO_SINT16\fP"

  96. .br

  97. .ti -1c

  98. .RI "const \fBRTAUDIO_FORMAT\fP \fBRTAUDIO_SINT24\fP"

  99. .br

  100. .ti -1c

  101. .RI "const \fBRTAUDIO_FORMAT\fP \fBRTAUDIO_SINT32\fP"

  102. .br

  103. .ti -1c

  104. .RI "const \fBRTAUDIO_FORMAT\fP \fBRTAUDIO_FLOAT32\fP"

  105. .br

  106. .ti -1c

  107. .RI "const \fBRTAUDIO_FORMAT\fP \fBRTAUDIO_FLOAT64\fP"

  108. .br

  109. .in -1c

  110. .SH "MEMBER TYPEDEF DOCUMENTATION"

  111. .PP 

  112. .SS "typedef unsigned long RtAudio::RTAUDIO_FORMAT"

  113. .PP

  114. .SS "typedef int(* RtAudio::RTAUDIO_CALLBACK)(char *buffer, int bufferSize, void *userData)"

  115. .PP

  116. .SH "MEMBER ENUMERATION DOCUMENTATION"

  117. .PP 

  118. .SS "anonymous enum"

  119. .PP

  120. \fBEnumeration values:\fP

  121. .in +1c

  122. .TP

  123. \fB\fIMAX_SAMPLE_RATES\fP \fP

  124. 

  125. .SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION"

  126. .PP 

  127. .SS "RtAudio::RtAudio ()"

  128. .PP

  129. The default constructor.

  130. .PP

  131. 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 \fBRtAudioError\fP error can be thrown if no devices are found or if a memory allocation error occurs. 

  132. .SS "RtAudio::RtAudio (int * streamID, int outputDevice, int outputChannels, int inputDevice, int inputChannels, \fBRTAUDIO_FORMAT\fP format, int sampleRate, int * bufferSize, int numberOfBuffers)"

  133. .PP

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

  135. .PP

  136. The specified output and/or input device identifiers correspond to those enumerated via the \fBgetDeviceInfo\fP() 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 \fBRtAudioError\fP can be thrown if no devices are found for the given parameters, if a memory allocation error occurs, or if a driver error occurs. 

  137. .PP

  138. \fBSee also: \fP

  139. .in +1c

  140. \fBopenStream\fP() 

  141. .SS "RtAudio::~RtAudio ()"

  142. .PP

  143. The destructor.

  144. .PP

  145. Stops and closes any open streams and devices and deallocates buffer and structure memory. 

  146. .SH "MEMBER FUNCTION DOCUMENTATION"

  147. .PP 

  148. .SS "int RtAudio::openStream (int outputDevice, int outputChannels, int inputDevice, int inputChannels, \fBRTAUDIO_FORMAT\fP format, int sampleRate, int * bufferSize, int numberOfBuffers)"

  149. .PP

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

  151. .PP

  152. If successful, the opened stream ID is returned. Otherwise, an \fBRtAudioError\fP is thrown.

  153. .PP

  154. \fBParameters: \fP

  155. .in +1c

  156. .TP

  157. \fB\fIoutputDevice:\fP\fP

  158. If equal to 0, the default or first device found meeting the given parameters is opened. Otherwise, the device number should correspond to one of those enumerated via the \fBgetDeviceInfo\fP() method. 

  159. .TP

  160. \fB\fIoutputChannels:\fP\fP

  161. The desired number of output channels. If equal to zero, the outputDevice identifier is ignored. 

  162. .TP

  163. \fB\fIinputDevice:\fP\fP

  164. If equal to 0, the default or first device found meeting the given parameters is opened. Otherwise, the device number should correspond to one of those enumerated via the \fBgetDeviceInfo\fP() method. 

  165. .TP

  166. \fB\fIinputChannels:\fP\fP

  167. The desired number of input channels. If equal to zero, the inputDevice identifier is ignored. 

  168. .TP

  169. \fB\fIformat:\fP\fP

  170. An RTAUDIO_FORMAT specifying the desired sample data format. 

  171. .TP

  172. \fB\fIsampleRate:\fP\fP

  173. The desired sample rate (sample frames per second). 

  174. .TP

  175. \fB\fIbufferSize:\fP\fP

  176. A pointer value indicating the desired internal buffer size in sample frames. The actual value used by the device is returned via the same pointer. A value of zero can be specified, in which case the lowest allowable value is determined. 

  177. .TP

  178. \fB\fInumberOfBuffers:\fP\fP

  179. A value which can be used to help control device latency. More buffers typically result in more robust performance, though at a cost of greater latency. A value of zero can be specified, in which case the lowest allowable value is used. 

  180. .SS "void RtAudio::setStreamCallback (int streamID, \fBRTAUDIO_CALLBACK\fP callback, void * userData)"

  181. .PP

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

  183. .PP

  184. 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 \fBstartStream\fP() and \fBstopStream\fP() methods, respectively). The callback process remains active for the duration of the stream and is automatically shutdown when the stream is closed (via the \fBcloseStream\fP() method or by object destruction). The callback process can also be shutdown and the user function de-referenced through an explicit call to the \fBcancelStreamCallback\fP() 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 \fBsetStreamCallback\fP() and \fBcancelStreamCallback\fP() methods (the blocking \fBtickStream\fP() method can be used before a callback is set and/or after a callback is cancelled). An \fBRtAudioError\fP will be thrown for an invalid device argument. 

  185. .SS "void RtAudio::cancelStreamCallback (int streamID)"

  186. .PP

  187. A public method which cancels a callback process and function for a given stream.

  188. .PP

  189. 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 \fBsetStreamCallback\fP() method. An \fBRtAudioError\fP will be thrown for an invalid device argument. 

  190. .SS "int RtAudio::getDeviceCount (void)"

  191. .PP

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

  193. .PP

  194. .SS "void RtAudio::getDeviceInfo (int device, \fBRTAUDIO_DEVICE\fP * info)"

  195. .PP

  196. Fill a user-supplied \fBRTAUDIO_DEVICE\fP structure for a specified device.

  197. .PP

  198. Any device between 0 and \fBgetDeviceCount\fP()-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 \fBRtAudioError\fP will be thrown for an invalid device argument. 

  199. .SS "char *const RtAudio::getStreamBuffer (int streamID)"

  200. .PP

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

  202. .PP

  203. The user should fill and/or read the buffer data in interleaved format and then call the \fBtickStream\fP() method. An \fBRtAudioError\fP will be thrown for an invalid stream identifier. 

  204. .SS "void RtAudio::tickStream (int streamID)"

  205. .PP

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

  207. .PP

  208. This method blocks until all buffer data is read/written. An \fBRtAudioError\fP will be thrown for an invalid stream identifier or if a driver error occurs. 

  209. .SS "void RtAudio::closeStream (int streamID)"

  210. .PP

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

  212. .PP

  213. If an invalid stream identifier is specified, this method issues a warning and returns (an \fBRtAudioError\fP is not thrown). 

  214. .SS "void RtAudio::startStream (int streamID)"

  215. .PP

  216. Public method which starts a stream.

  217. .PP

  218. An \fBRtAudioError\fP will be thrown for an invalid stream identifier or if a driver error occurs. 

  219. .SS "void RtAudio::stopStream (int streamID)"

  220. .PP

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

  222. .PP

  223. An \fBRtAudioError\fP will be thrown for an invalid stream identifier or if a driver error occurs. 

  224. .SS "void RtAudio::abortStream (int streamID)"

  225. .PP

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

  227. .PP

  228. An \fBRtAudioError\fP will be thrown for an invalid stream identifier or if a driver error occurs. 

  229. .SS "int RtAudio::streamWillBlock (int streamID)"

  230. .PP

  231. Queries a stream to determine whether a call to the \fBtickStream\fP() method will block.

  232. .PP

  233. A return value of 0 indicates that the stream will NOT block. A positive return value indicates the number of sample frames that cannot yet be processed without blocking. 

  234. .SH "MEMBER DATA DOCUMENTATION"

  235. .PP 

  236. .SS "const \fBRTAUDIO_FORMAT\fP RtAudio::RTAUDIO_SINT8\fC [static]\fP"

  237. .PP

  238. .SS "const \fBRTAUDIO_FORMAT\fP RtAudio::RTAUDIO_SINT16\fC [static]\fP"

  239. .PP

  240. .SS "const \fBRTAUDIO_FORMAT\fP RtAudio::RTAUDIO_SINT24\fC [static]\fP"

  241. .PP

  242. Upper 3 bytes of 32-bit integer. 

  243. .SS "const \fBRTAUDIO_FORMAT\fP RtAudio::RTAUDIO_SINT32\fC [static]\fP"

  244. .PP

  245. .SS "const \fBRTAUDIO_FORMAT\fP RtAudio::RTAUDIO_FLOAT32\fC [static]\fP"

  246. .PP

  247. Normalized between plus/minus 1.0. 

  248. .SS "const \fBRTAUDIO_FORMAT\fP RtAudio::RTAUDIO_FLOAT64\fC [static]\fP"

  249. .PP

  250. Normalized between plus/minus 1.0. 

  251. 

  252. .SH "AUTHOR"

  253. .PP 

  254. Generated automatically by Doxygen for RtAudio from the source code.