Change "eg." to "e.g."
[rtaudio-cdist.git] / doc / doxygen / probe.txt
index 9fce97bbebb588ccacc6f86fcdd2efdcdb6f0dcf..69970009f29f02715625a2912cf0421ca3c28351 100644 (file)
@@ -18,7 +18,7 @@ int main()
 
   // Scan through devices for various capabilities
   RtAudio::DeviceInfo info;
-  for ( unsigned int i=1; i<=devices; i++ ) {
+  for ( unsigned int i=0; i<devices; i++ ) {
 
     info = audio.getDeviceInfo( i );
 
@@ -37,15 +37,16 @@ The RtAudio::DeviceInfo structure is defined in RtAudio.h and provides a variety
 
 \code
   typedef struct RtAudio::DeviceInfo {
-    bool probed;                  // true if the device capabilities were successfully probed.
-    std::string name;             // Character string device identifier.
-    int outputChannels;           // Maximum output channels supported by device.
-    int inputChannels;            // Maximum input channels supported by device.
-    int duplexChannels;           // Maximum simultaneous input/output channels supported by device.
-    bool isDefaultOutput;         // true if this is the default output device.
-    bool isDefaultInput;          // true if this is the default input device.
-    std::vector<int> sampleRates; // Supported sample rates.
-    RtAudioFormat nativeFormats;  // Bit mask of supported data formats.
+    bool probed;                           // true if the device capabilities were successfully probed.
+    std::string name;                      // Character string device identifier.
+    unsigned int outputChannels;           // Maximum output channels supported by device.
+    unsigned int inputChannels;            // Maximum input channels supported by device.
+    unsigned int duplexChannels;           // Maximum simultaneous input/output channels supported by device.
+    bool isDefaultOutput;                  // true if this is the default output device.
+    bool isDefaultInput;                   // true if this is the default input device.
+    std::vector<unsigned int> sampleRates; // Supported sample rates.
+    unsigned int preferredSampleRate;      // Preferred sample rate, e.g. for WASAPI the system sample rate.
+    RtAudioFormat nativeFormats;           // Bit mask of supported data formats.
   };
 \endcode