me/portaudio
Watch
1
0
Fork
You've already forked portaudio
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update doxygen comments for WDM/KS to indicate that new APIs are available in 19.5.0

Browse source
This commit is contained in:
Ross Bencina 2016-09-25 17:49:15 +10:00
commit e50b31bd40
1 changed files with 21 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

27
include/pa_win_wdmks.h
View file

@ -53,14 +53,20 @@ extern "C"
{ {
#endif /* __cplusplus */ #endif /* __cplusplus */
/* Setup flags */ /** Flags to indicate valid fields in PaWinWDMKSInfo.
@see PaWinWDMKSInfo
@version Available as of 19.5.0.
*/
typedef enum PaWinWDMKSFlags typedef enum PaWinWDMKSFlags
{ {
/* Makes WDMKS use the supplied latency figures instead of relying on the frame size reported /** Makes WDMKS use the supplied latency figures instead of relying on the frame size reported
by the WaveCyclic device. Use at own risk! */ by the WaveCyclic device. Use at own risk!
*/
paWinWDMKSOverrideFramesize = (1 << 0), 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), paWinWDMKSUseGivenChannelMask = (1 << 1),
} PaWinWDMKSFlags; } PaWinWDMKSFlags;
@ -69,11 +75,20 @@ extern "C"
unsigned long size; /**< sizeof(PaWinWDMKSInfo) */ unsigned long size; /**< sizeof(PaWinWDMKSInfo) */
PaHostApiTypeId hostApiType; /**< paWDMKS */ PaHostApiTypeId hostApiType; /**< paWDMKS */
unsigned long version; /**< 1 */ unsigned long version; /**< 1 */
/** Flags indicate which fields are valid.
@see PaWinWDMKSFlags
@version Available as of 19.5.0.
*/
unsigned long flags; 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; 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; unsigned channelMask;
} PaWinWDMKSInfo; } PaWinWDMKSInfo;