The GetWaveBuffer API procedure is used to retrieve a "sample block" data buffer from an open
wave file. Applications should continue to read data from a wave file until this procedure returns
a zero (FALSE) value. A zero return value indicates that all data has been read from the wave file image.
Note: |
The final sample data block read from the wave file may be padded with "silence" data at the
end. This is required because sample data from a wave file will very rarely be an integer number
of "wave buffer bytes" in length.
|
Namespace:
LanScape
Assembly:
LMEVoipManaged (in LMEVoipManaged.dll) Version: 6.0.5226.26700
Syntax
C# |
---|
public bool GetWaveBuffer(
Object[] SampleBuffer
) |
Visual Basic (Declaration) |
---|
Public Function GetWaveBuffer ( _
SampleBuffer As Object() _
) As Boolean |
Visual C++ |
---|
public:
bool GetWaveBuffer(
array<Object^>^ SampleBuffer
) |
Parameters
- SampleBuffer
- Type: array<
System..::.Object
>[]()[]
The destination buffer that will contain the retrieved wave file sampled data. The size of this buffer must
be the same as the buffer length specified using the BytesPerWaveBuffer parameter when the OpenWaveFile(VoipMediaEngine, String, Int32)
API procedure was called.
Return Value
If the function returns non zero (TRUE), there is more sample data to read from the wave file.
If the function returns zero (FALSE), all data has been read from the wave file. The last buffer read may be zero padded at the end.
Remarks
See Also