Welcome to
www.tdxlibrary.org
Home of the
the TDx_Library...
"RAD DirectX"
for
C++ Builder
...
|
TDx_Sound_Library v2.00 Component Reference
|
|
[ TDx_SoundBuffer::GetFormat() ]
[ next: GetFrequency() ]
[ prev: GetCurrentPosition() ]
public:
virtual bool __fastcall GetFormat( WAVEFORMATEX* pFormat, dword pSizeAllocated, dword* pSizeWritten );
TDX_SOUNDBUFFER::GETFORMAT()
[ component method ]
- Description
The
TDx_SoundBuffer::GetFormat
method
will
return
either
the
sound
data
format
of
the
buffer
or
amount
of
space
needed
to
retrieve
that
information.
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 buffer.
Setting this parameter to NULL will cause the required buffer size to be 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.
SizeWritten
The SizeWritten parameter will reference the amount, in bytes, written into the WAVEFORMATEX structure referenced by the Format parameter of this method.
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.
|
|