Update of /cvsroot/pywin32/pywin32/com/win32comext/directsound/src In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv27495/com/win32comext/directsound/src Modified Files: PyDSBCAPS.cpp PyDSBUFFERDESC.cpp PyDSCAPS.cpp PyDSCBCAPS.cpp PyDSCBUFFERDESC.cpp PyDSCCAPS.cpp directsound.cpp Log Message: Documentation improvemets: - fixed copy & paste errors - added and unified flag explanations. Index: PyDSCAPS.cpp =================================================================== RCS file: /cvsroot/pywin32/pywin32/com/win32comext/directsound/src/PyDSCAPS.cpp,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** PyDSCAPS.cpp 1 Dec 2004 23:13:57 -0000 1.2 --- PyDSCAPS.cpp 25 Mar 2005 01:52:11 -0000 1.3 *************** *** 8,12 **** #include "directsound_pch.h" ! // @pymethod <o PyDSCAPS>|pywintypes|DSCAPS|Creates a new DSCAPS object PyObject *PyWinMethod_NewDSCAPS(PyObject *self, PyObject *args) { --- 8,12 ---- #include "directsound_pch.h" ! // @pymethod <o PyDSCAPS>|directsound|DSCAPS|Creates a new PyDSCAPS object. PyObject *PyWinMethod_NewDSCAPS(PyObject *self, PyObject *args) { *************** *** 89,93 **** /*static*/ struct PyMemberDef PyDSCAPS::members[] = { {"dwFlags", T_INT, OFF(m_caps.dwFlags), 0, "Specifies device capabilities."}, ! // @prop integer|dwFlags|Specifies device capabilities. {"dwMinSecondarySampleRate", T_INT, OFF(m_caps.dwMinSecondarySampleRate), 0, "Minimum sample rate supported by this device's hardware secondary sound buffers."}, // @prop integer|dwMinSecondarySampleRate|Minimum sample rate supported by this device's hardware secondary sound buffers. --- 89,105 ---- /*static*/ struct PyMemberDef PyDSCAPS::members[] = { {"dwFlags", T_INT, OFF(m_caps.dwFlags), 0, "Specifies device capabilities."}, ! // @prop integer|dwFlags|Specifies device capabilities. Can be one or more of the following: ! // @flagh Flag|Description ! // @flag DSCAPS_PRIMARYMONO|The device supports monophonic primary buffers. ! // @flag DSCAPS_PRIMARYSTEREO|The device supports stereo primary buffers. ! // @flag DSCAPS_PRIMARY8BIT|The device supports hardware-mixed secondary buffers with 8-bit samples. ! // @flag DSCAPS_PRIMARY16BIT|The device supports primary sound buffers with 16-bit samples. ! // @flag DSCAPS_CONTINUOUSRATE|The device supports all sample rates between the dwMinSecondarySampleRate and dwMaxSecondarySampleRate member values. Typically, this means that the actual output rate will be within +/- 10 hertz (Hz) of the requested frequency. ! // @flag DSCAPS_EMULDRIVER|The device does not have a DirectSound driver installed, so it is being emulated through the waveform-audio functions. Performance degradation should be expected. ! // @flag DSCAPS_CERTIFIED|This driver has been tested and certified by Microsoft. ! // @flag DSCAPS_SECONDARYMONO|The device supports hardware-mixed monophonic secondary buffers. ! // @flag DSCAPS_SECONDARYSTEREO|The device supports hardware-mixed stereo secondary buffers. ! // @flag DSCAPS_SECONDARY8BIT|The device supports hardware-mixed secondary buffers with 8-bit samples. ! // @flag DSCAPS_SECONDARY16BIT|The device supports hardware-mixed secondary sound buffers with 16-bit samples. {"dwMinSecondarySampleRate", T_INT, OFF(m_caps.dwMinSecondarySampleRate), 0, "Minimum sample rate supported by this device's hardware secondary sound buffers."}, // @prop integer|dwMinSecondarySampleRate|Minimum sample rate supported by this device's hardware secondary sound buffers. Index: PyDSBUFFERDESC.cpp =================================================================== RCS file: /cvsroot/pywin32/pywin32/com/win32comext/directsound/src/PyDSBUFFERDESC.cpp,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** PyDSBUFFERDESC.cpp 23 Mar 2005 22:51:08 -0000 1.2 --- PyDSBUFFERDESC.cpp 25 Mar 2005 01:52:11 -0000 1.3 *************** *** 8,12 **** #include "directsound_pch.h" ! // @pymethod <o PyDSBUFFERDESC>|pywintypes|DSBUFFERDESC|Creates a new DSBUFFERDESC object PyObject *PyWinMethod_NewDSBUFFERDESC(PyObject *self, PyObject *args) { --- 8,12 ---- #include "directsound_pch.h" ! // @pymethod <o PyDSBUFFERDESC>|directsound|DSBUFFERDESC|Creates a new PyDSBUFFERDESC object PyObject *PyWinMethod_NewDSBUFFERDESC(PyObject *self, PyObject *args) { Index: PyDSCCAPS.cpp =================================================================== RCS file: /cvsroot/pywin32/pywin32/com/win32comext/directsound/src/PyDSCCAPS.cpp,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** PyDSCCAPS.cpp 7 Mar 2005 22:18:45 -0000 1.1 --- PyDSCCAPS.cpp 25 Mar 2005 01:52:11 -0000 1.2 *************** *** 8,12 **** #include "directsound_pch.h" ! // @pymethod <o PyDSCCAPS>|pywintypes|DSCCAPS|Creates a new DSCCAPS object PyObject *PyWinMethod_NewDSCCAPS(PyObject *self, PyObject *args) { --- 8,12 ---- #include "directsound_pch.h" ! // @pymethod <o PyDSCCAPS>|directsound|DSCCAPS|Creates a new PyDSCCAPS object PyObject *PyWinMethod_NewDSCCAPS(PyObject *self, PyObject *args) { *************** *** 89,95 **** /*static*/ struct PyMemberDef PyDSCCAPS::members[] = { {"dwFlags", T_INT, OFF(m_caps.dwFlags), 0, "Specifies device capabilities. Can be 0 or DSCCAPS_EMULDRIVER (indicates that no DirectSoundCapture device is available and standard wave audio functions are being used)"}, ! // @prop integer|dwFlags|Specifies device capabilities. Can be 0 or DSCCAPS_EMULDRIVER (indicates that no DirectSound Device is available and standard wave audio functions are being used). {"dwFormats", T_INT, OFF(m_caps.dwFormats), 0, "Supported WAVE_FORMAT formats."}, ! // @prop integer|dwFormats|Supported WAVE_FORMAT formats. {"dwChannels", T_INT, OFF(m_caps.dwChannels), 0, "Number of channels supported by the device."}, // @prop integer|dwChannels|Number of channels supported by the device. --- 89,97 ---- /*static*/ struct PyMemberDef PyDSCCAPS::members[] = { {"dwFlags", T_INT, OFF(m_caps.dwFlags), 0, "Specifies device capabilities. Can be 0 or DSCCAPS_EMULDRIVER (indicates that no DirectSoundCapture device is available and standard wave audio functions are being used)"}, ! // @prop integer|dwFlags|Specifies device capabilities. Can be zero or the following flag: ! // @flagh Flag|Description ! // @flag DSCCAPS_EMULDRIVER|Indicates that no DirectSound Device is available and standard wave audio functions are being used. {"dwFormats", T_INT, OFF(m_caps.dwFormats), 0, "Supported WAVE_FORMAT formats."}, ! // @prop integer|dwFormats|Bitset of supported WAVE_FORMAT formats. {"dwChannels", T_INT, OFF(m_caps.dwChannels), 0, "Number of channels supported by the device."}, // @prop integer|dwChannels|Number of channels supported by the device. Index: directsound.cpp =================================================================== RCS file: /cvsroot/pywin32/pywin32/com/win32comext/directsound/src/directsound.cpp,v retrieving revision 1.7 retrieving revision 1.8 diff -C2 -d -r1.7 -r1.8 *** directsound.cpp 23 Mar 2005 22:51:09 -0000 1.7 --- directsound.cpp 25 Mar 2005 01:52:11 -0000 1.8 *************** *** 352,355 **** --- 352,356 ---- ADD_CONSTANT(DSBCAPS_MUTE3DATMAXDISTANCE); + // @const directsound|DSCBCAPS_WAVEMAPPED|The Win32 wave mapper will be used for formats not supported by the device. ADD_CONSTANT(DSCBCAPS_WAVEMAPPED); Index: PyDSBCAPS.cpp =================================================================== RCS file: /cvsroot/pywin32/pywin32/com/win32comext/directsound/src/PyDSBCAPS.cpp,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** PyDSBCAPS.cpp 23 Mar 2005 22:51:06 -0000 1.2 --- PyDSBCAPS.cpp 25 Mar 2005 01:52:11 -0000 1.3 *************** *** 7,11 **** #include "directsound_pch.h" ! // @pymethod <o PyDSBCAPS>|pywintypes|DSBCAPS|Creates a new DSBCAPS object PyObject *PyWinMethod_NewDSBCAPS(PyObject *self, PyObject *args) { --- 7,11 ---- #include "directsound_pch.h" ! // @pymethod <o PyDSBCAPS>|directsound|DSBCAPS|Creates a new PyDSBCAPS object PyObject *PyWinMethod_NewDSBCAPS(PyObject *self, PyObject *args) { Index: PyDSCBCAPS.cpp =================================================================== RCS file: /cvsroot/pywin32/pywin32/com/win32comext/directsound/src/PyDSCBCAPS.cpp,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** PyDSCBCAPS.cpp 7 Mar 2005 22:18:45 -0000 1.1 --- PyDSCBCAPS.cpp 25 Mar 2005 01:52:11 -0000 1.2 *************** *** 8,12 **** #include "directsound_pch.h" ! // @pymethod <o PyDSCBCAPS>|pywintypes|DSCBCAPS|Creates a new DSCBCAPS object PyObject *PyWinMethod_NewDSCBCAPS(PyObject *self, PyObject *args) { --- 8,12 ---- #include "directsound_pch.h" ! // @pymethod <o PyDSCBCAPS>|directsound|DSCBCAPS|Creates a new PyDSCBCAPS object PyObject *PyWinMethod_NewDSCBCAPS(PyObject *self, PyObject *args) { Index: PyDSCBUFFERDESC.cpp =================================================================== RCS file: /cvsroot/pywin32/pywin32/com/win32comext/directsound/src/PyDSCBUFFERDESC.cpp,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** PyDSCBUFFERDESC.cpp 7 Mar 2005 22:18:45 -0000 1.1 --- PyDSCBUFFERDESC.cpp 25 Mar 2005 01:52:11 -0000 1.2 *************** *** 8,12 **** #include "directsound_pch.h" ! // @pymethod <o PyDSCBUFFERDESC>|pywintypes|DSCBUFFERDESC|Creates a new DSCBUFFERDESC object PyObject *PyWinMethod_NewDSCBUFFERDESC(PyObject *self, PyObject *args) { --- 8,12 ---- #include "directsound_pch.h" ! // @pymethod <o PyDSCBUFFERDESC>|directsound|DSCBUFFERDESC|Creates a new PyDSCBUFFERDESC object PyObject *PyWinMethod_NewDSCBUFFERDESC(PyObject *self, PyObject *args) { *************** *** 93,97 **** /*static*/ struct PyMemberDef PyDSCBUFFERDESC::members[] = { {"dwFlags", T_INT, OFF(m_dscbd.dwFlags), 0, "Identifies the capabilities to include when creating a new DirectSoundBuffer object"}, ! // @prop integer|dwFlags|Identifies the capabilities to include when creating a new DirectSoundBuffer object. {"dwBufferBytes", T_INT, OFF(m_dscbd.dwBufferBytes), 0, "Size of the new buffer, in bytes. This value must be 0 when creating primary buffers. For secondary buffers, the minimum and maximum sizes allowed are specified by DSBSIZE_MIN and DSBSIZE_MAX"}, // @prop integer|dwBufferBytes|Size of the new buffer, in bytes. This value must be 0 when creating primary buffers. For secondary buffers, the minimum and maximum sizes allowed are specified by DSBSIZE_MIN and DSBSIZE_MAX. --- 93,99 ---- /*static*/ struct PyMemberDef PyDSCBUFFERDESC::members[] = { {"dwFlags", T_INT, OFF(m_dscbd.dwFlags), 0, "Identifies the capabilities to include when creating a new DirectSoundBuffer object"}, ! // @prop integer|dwFlags|Identifies the capabilities to include when creating a new DirectSoundBuffer object. Can be zero or the following flag: ! // @flagh Flag|Description ! // @flag DSCBCAPS_WAVEMAPPED|The Win32 wave mapper will be used for formats not supported by the device. {"dwBufferBytes", T_INT, OFF(m_dscbd.dwBufferBytes), 0, "Size of the new buffer, in bytes. This value must be 0 when creating primary buffers. For secondary buffers, the minimum and maximum sizes allowed are specified by DSBSIZE_MIN and DSBSIZE_MAX"}, // @prop integer|dwBufferBytes|Size of the new buffer, in bytes. This value must be 0 when creating primary buffers. For secondary buffers, the minimum and maximum sizes allowed are specified by DSBSIZE_MIN and DSBSIZE_MAX. |
