[pywin32-checkins] pywin32/win32/src PyWAVEFORMATEX.cpp,1.1,1.2

[Lars I. <lar...@us...>]

Update of /cvsroot/pywin32/pywin32/win32/src
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv29038/win32/src

Modified Files:
	PyWAVEFORMATEX.cpp 
Log Message:
Minor documentation improvements.


Index: PyWAVEFORMATEX.cpp
===================================================================
RCS file: /cvsroot/pywin32/pywin32/win32/src/PyWAVEFORMATEX.cpp,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** PyWAVEFORMATEX.cpp	30 Nov 2004 21:30:29 -0000	1.1
--- PyWAVEFORMATEX.cpp	1 Dec 2004 23:13:57 -0000	1.2
***************
*** 90,94 ****
  	{"wFormatTag",  T_SHORT,  OFF(m_wfx.wFormatTag), 0, "Format as an integer. WAVE_FORMAT_PCM (1) is very common."}, // @prop integer|wFormatTag|Waveform-audio format type. pywintypes only defines WAVE_FORMAT_PCM as a constant. Other values must be looked up in the mmsystem.h header file. 
  	{"nChannels",  T_SHORT,  OFF(m_wfx.nChannels), 0, "Number of channels" }, // @prop integer|nChannels|Number of channels. 1 for Mono, 2 for Stereo, anything, but never 5.1.
! 	{"nSamplesPerSec",  T_INT,  OFF(m_wfx.nSamplesPerSec), 0, "Sample rate in seconds" }, // @prop integer|Sample rate, in samples per second (hertz), that each channel should be played or recorded. If wFormatTag is WAVE_FORMAT_PCM, then common values for nSamplesPerSec are 8000, 11025, 22050, and 44100 Hz
  	{"nAvgBytesPerSec",  T_INT,  OFF(m_wfx.nAvgBytesPerSec), 0, "Required average data-transfer rate, in bytes per second, for the format tag. If wFormatTag is WAVE_FORMAT_PCM, nAvgBytesPerSec should be equal to the product of nSamplesPerSec and nBlockAlign." }, // @prop integer|nAvgBytesPerSec|Required average data-transfer rate, in bytes per second, for the format tag. If wFormatTag is WAVE_FORMAT_PCM, nAvgBytesPerSec should be equal to the product of nSamplesPerSec and nBlockAlign.
  	{"nBlockAlign",  T_SHORT,  OFF(m_wfx.nBlockAlign), 0, "Block alignment, in bytes. The block alignment is the minimum atomic unit of data for the wFormatTag format type. If wFormatTag is WAVE_FORMAT_PCM, nBlockAlign should be equal to the product of nChannels and wBitsPerSample divided by 8 (bits per byte)."}, // @prop integer|nBlockAlign|Block alignment, in bytes. The block alignment is the minimum atomic unit of data for the wFormatTag format type. If wFormatTag is WAVE_FORMAT_PCM, nBlockAlign should be equal to the product of nChannels and wBitsPerSample divided by 8 (bits per byte). For non-PCM formats, this member must be computed according to the manufacturer’s specification of the format tag.
--- 90,94 ----
  	{"wFormatTag",  T_SHORT,  OFF(m_wfx.wFormatTag), 0, "Format as an integer. WAVE_FORMAT_PCM (1) is very common."}, // @prop integer|wFormatTag|Waveform-audio format type. pywintypes only defines WAVE_FORMAT_PCM as a constant. Other values must be looked up in the mmsystem.h header file. 
  	{"nChannels",  T_SHORT,  OFF(m_wfx.nChannels), 0, "Number of channels" }, // @prop integer|nChannels|Number of channels. 1 for Mono, 2 for Stereo, anything, but never 5.1.
! 	{"nSamplesPerSec",  T_INT,  OFF(m_wfx.nSamplesPerSec), 0, "Sample rate in seconds" }, // @prop integer|nSamplesPerSec|Sample rate, in samples per second (hertz), that each channel should be played or recorded. If wFormatTag is WAVE_FORMAT_PCM, then common values for nSamplesPerSec are 8000, 11025, 22050, and 44100 Hz
  	{"nAvgBytesPerSec",  T_INT,  OFF(m_wfx.nAvgBytesPerSec), 0, "Required average data-transfer rate, in bytes per second, for the format tag. If wFormatTag is WAVE_FORMAT_PCM, nAvgBytesPerSec should be equal to the product of nSamplesPerSec and nBlockAlign." }, // @prop integer|nAvgBytesPerSec|Required average data-transfer rate, in bytes per second, for the format tag. If wFormatTag is WAVE_FORMAT_PCM, nAvgBytesPerSec should be equal to the product of nSamplesPerSec and nBlockAlign.
  	{"nBlockAlign",  T_SHORT,  OFF(m_wfx.nBlockAlign), 0, "Block alignment, in bytes. The block alignment is the minimum atomic unit of data for the wFormatTag format type. If wFormatTag is WAVE_FORMAT_PCM, nBlockAlign should be equal to the product of nChannels and wBitsPerSample divided by 8 (bits per byte)."}, // @prop integer|nBlockAlign|Block alignment, in bytes. The block alignment is the minimum atomic unit of data for the wFormatTag format type. If wFormatTag is WAVE_FORMAT_PCM, nBlockAlign should be equal to the product of nChannels and wBitsPerSample divided by 8 (bits per byte). For non-PCM formats, this member must be computed according to the manufacturer’s specification of the format tag.