Welcome to
www.tdxlibrary.org
Home of the
the TDx_Library...
"RAD DirectX"
for
C++ Builder
...
|
TDx_Sound_Library v2.00 Component Reference
|
|
[ TDx_SoundCaptureBuffer::GetFormat() ]
[ next: GetStatus() ]
[ prev: GetCurrentPosition() ]
public:
virtual bool __fastcall GetFormat( WAVEFORMATEX* pFormat, dword pSizeAllocated, dword* pSizeWritten );
TDX_SOUNDCAPTUREBUFFER::GETFORMAT()
[ component method ]
- Description
The
TDx_SoundCaptureBuffer::GetFormat
method
will
return
the
sound
format
currently
set
for
the
capture
buffer.
If
the
method
call
fails,
the
OnError
event
may
be
triggered
with
the
following
value:
DSERR_INVALIDPARAM
- Parameters
Format
The Format parameter references a WAVEFORMATEX structure for holding the sound data format of the capture buffer if this method returns successfully.
Setting this parameter to NULL will cause the buffer size needed to be retrieved and placed in the SizeWritten parameter of this method.
SizeAllocated
The SizeAllocated parameter defines the size, in bytes, of the WAVEFORMATEX structure referenced by the Format parameter of this method.
If the structure exceeds this value it will be truncated.
SizeWritten
The SizeWritten parameter will reference the amount, in bytes, that was written into the WAVEFORMATEX structure referenced by the Format parameter if this method returns successfully.
This parameter may be set to NULL.
- See Also
- Top
If you would like to submit additions or improvements to this page, click: darren_john_dwyer@hotmail.com.
|
|