Platform SDK: DirectX

DirectSound.CreateSoundBufferFromFile

The DirectSound.CreateSoundBufferFromFile method creates a DirectSoundBuffer object to hold a sequence of audio samples, and loads the data from the file into the buffer.

object.CreateSoundBufferFromFile(filename As String, _
    bufferDesc As DSBUFFERDESC, _
    format As WAVEFORMATEX) As DirectSoundBuffer

Parameters

object
Object expression that resolves to a DirectSound object.
filename
Name of the wave file to load into the created buffer.
bufferDesc
DSBUFFERDESC type that specifies the description of the sound buffer to create. The lBufferBytes member is ignored.
format
WAVEFORMATEX type that receives information about the wave format of the file. The members do not have to be initialized before this type is passed to the method.

Return Values

If the method succeeds, a DirectSoundBuffer is returned.

Error Codes

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

DSERR_ALLOCATED
DSERR_BADFORMAT
DSERR_OUTOFMEMORY
DSERR_UNINITIALIZED
DSERR_UNSUPPORTED

See Also

DirectSound.CreateSoundBuffer, DirectSound.CreateSoundBufferFromResource, DirectSound.DuplicateSoundBuffer