IDirectSound::DuplicateSoundBuffer
[The feature associated with this page, DirectSound, is a legacy feature. It has been superseded by WASAPI and Audio Graphs. Media Casting have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use Media Casting instead of DirectSound, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
This method creates a new DirectSoundBuffer object that uses the same buffer memory as the original object.
Syntax
HRESULT DuplicateSoundBuffer( LPDIRECTSOUNDBUFFER lpDsbOriginal, LPLPDIRECTSOUNDBUFFER lplpDsbDuplicate);
Parameters
- lpDsbOriginal
Address of the DirectSoundBuffer object to be duplicated. - lplpDsbDuplicate
Address of a pointer to the new DirectSoundBuffer object.
Return Value
If the method succeeds, the return value is DS_OK.
If the method fails, the return value may be one of the following error values:
| Return Code |
|---|
| DSERR_ALLOCATED |
| DSERR_INVALIDCALL |
| DSERR_INVALIDPARAM |
| DSERR_OUTOFMEMORY |
| DSERR_UNINITIALIZED |
Remarks
The new object can be used just like the original.
Initially, the duplicate buffer will have the same parameters as the original buffer. However, the application can change the parameters of each buffer independently, and each can be played or stopped without affecting the other.
If data in the buffer is changed through one object, the change will be reflected in the other object because the buffer memory is shared.
The buffer memory will be released when the last object referencing it is released.
Applications cannot assume that an attempt to duplicate a sound buffer will always succeed. In particular, DirectSound will not create a software duplicate of a hardware buffer.
Requirements
Header: Declared in DSound.h.
Library: Use Dsound.lib.