Microsoft DirectX 8.1 (Visual Basic)

DirectSoundSecondaryBuffer8.ReadBuffer

The ReadBuffer method reads a portion of the sound buffer and stores the data in an application buffer.

Most applications do not use this method, because secondary buffers automatically send their data to the primary buffer in response to the DirectSoundSecondaryBuffer8.Play method.

Syntax

object.ReadBuffer( _
  start As Long, _
  size As Long, _
  buffer As Any, _
  flags As CONST_DSBLOCKFLAGS)

Parts

object

Resolves to a DirectSoundSecondaryBuffer8 object.

start

Offset, in bytes, from the start of the buffer to where the read begins. This parameter is ignored if DSBLOCK_FROMWRITECURSOR is specified in the flags parameter.

size

Size, in bytes, of the portion of the buffer to read. The sound buffer is conceptually circular, so this value can be greater than the number of bytes between start and the end of the buffer. This member is ignored if DSBLOCK_ENTIREBUFFER is specified in the flags parameter.

buffer

Variable that receives the data. Typically this is an array of bytes, and you pass the first element of the array.

flags

One of the constants of the CONST_DSBLOCKFLAGS enumeration.

Error Codes

If the method fails, an error is raised and Err.Number may be set to one of the following error codes.

DSERR_BUFFERLOST
DSERR_INVALIDCALL
DSERR_INVALIDPARAM
DSERR_PRIOLEVELNEEDED