summaryrefslogtreecommitdiff
path: root/RtAudio.h
diff options
context:
space:
mode:
authorJP Cimalando <jpcima@users.noreply.github.com>2018-08-08 00:36:22 +0200
committerJP Cimalando <jpcima@users.noreply.github.com>2018-08-08 00:43:31 +0200
commit021928773bfbf9b25505677451ee197b1fe006b6 (patch)
treed926b77d97bfc0fe670f527e43b8d5046eadfcb0 /RtAudio.h
parentee6fd4b4609a1c05a3f4ded4c8022b5ba84d7afd (diff)
Use short lower-case names as API identifiers
Diffstat (limited to 'RtAudio.h')
-rw-r--r--RtAudio.h10
1 files changed, 10 insertions, 0 deletions
diff --git a/RtAudio.h b/RtAudio.h
index 91124cf..449e0d7 100644
--- 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