Use short lower-case names as API identifiers

[rtaudio-cdist.git] / RtAudio.h

diff --git a/RtAudio.h b/RtAudio.h
index 91124cf104e85c3a5e8b9e885d233f30f2210fcd..449e0d7dcc9323b47b955ebc7c23a8b2187f4c45 100644 (file)
--- a/RtAudio.h
+++ b/RtAudio.h
@@ -399,11 +399,21 @@ class RTAUDIO_DLL_PUBLIC RtAudio
 
   //! Return the name of a specified compiled audio API.
   /*!
+    This obtains a short lower-case name used for identification purposes.
+    This value is guaranteed to remain identical across library versions.
     If the API is unknown or not compiled, this function will return
     the empty string.
   */
   static const std::string &getCompiledApiName( RtAudio::Api api );
 
+  //! Return the display name of a specified compiled audio API.
+  /*!
+    This obtains a long name used for display purposes.
+    If the API is unknown or not compiled, this function will return
+    the empty string.
+  */
+  static const std::string &getCompiledApiDisplayName( RtAudio::Api api );
+
   //! Return the compiled audio API having the given name.
   /*!
     A case insensitive comparison will check the specified name