summaryrefslogtreecommitdiffstatshomepage
path: root/3rdparty/portaudio/include/pa_win_wdmks.h
diff options
context:
space:
mode:
Diffstat (limited to '3rdparty/portaudio/include/pa_win_wdmks.h')
-rw-r--r--3rdparty/portaudio/include/pa_win_wdmks.h29
1 files changed, 22 insertions, 7 deletions
diff --git a/3rdparty/portaudio/include/pa_win_wdmks.h b/3rdparty/portaudio/include/pa_win_wdmks.h
index f9395050ebb..35929625e2c 100644
--- a/3rdparty/portaudio/include/pa_win_wdmks.h
+++ b/3rdparty/portaudio/include/pa_win_wdmks.h
@@ -1,7 +1,7 @@
#ifndef PA_WIN_WDMKS_H
#define PA_WIN_WDMKS_H
/*
- * $Id: pa_win_wdmks.h 1924 2014-04-09 14:27:21Z robiwan $
+ * $Id$
* PortAudio Portable Real-Time Audio Library
* WDM/KS specific extensions
*
@@ -53,14 +53,20 @@ extern "C"
{
#endif /* __cplusplus */
- /* Setup flags */
+ /** Flags to indicate valid fields in PaWinWDMKSInfo.
+ @see PaWinWDMKSInfo
+ @version Available as of 19.5.0.
+ */
typedef enum PaWinWDMKSFlags
{
- /* Makes WDMKS use the supplied latency figures instead of relying on the frame size reported
- by the WaveCyclic device. Use at own risk! */
+ /** Makes WDMKS use the supplied latency figures instead of relying on the frame size reported
+ by the WaveCyclic device. Use at own risk!
+ */
paWinWDMKSOverrideFramesize = (1 << 0),
- /* Makes WDMKS (output stream) use the given channelMask instead of the default */
+ /** Makes WDMKS (output stream) use the given channelMask instead of the default.
+ @version Available as of 19.5.0.
+ */
paWinWDMKSUseGivenChannelMask = (1 << 1),
} PaWinWDMKSFlags;
@@ -69,11 +75,20 @@ extern "C"
unsigned long size; /**< sizeof(PaWinWDMKSInfo) */
PaHostApiTypeId hostApiType; /**< paWDMKS */
unsigned long version; /**< 1 */
+
+ /** Flags indicate which fields are valid.
+ @see PaWinWDMKSFlags
+ @version Available as of 19.5.0.
+ */
unsigned long flags;
- /* The number of packets to use for WaveCyclic devices, range is [2, 8]. Set to zero for default value of 2. */
+ /** The number of packets to use for WaveCyclic devices, range is [2, 8]. Set to zero for default value of 2. */
unsigned noOfPackets;
- /* If paWinWDMKSUseGivenChannelMask bit is set in flags, use this as channelMask instead of default */
+
+ /** If paWinWDMKSUseGivenChannelMask bit is set in flags, use this as channelMask instead of default.
+ @see PaWinWDMKSFlags
+ @version Available as of 19.5.0.
+ */
unsigned channelMask;
} PaWinWDMKSInfo;