IDirectMusicSynth::SetSynthSink method (dmusics.h)

The SetSynthSink method establishes the connection of the synth to the wave sink.

Syntax

HRESULT SetSynthSink(
  IDirectMusicSynthSink *pSynthSink
);

Parameters

pSynthSink

Pointer to the synth sink. This parameter either points to the IDirectMusicSynthSink sink object to connect to the synth, or is NULL to disconnect the synth from its current synth sink.

Return value

SetSynthSink returns S_OK if the call was successful. Otherwise, the method returns an appropriate error code. The following table shows some of the possible return status codes.

Remarks

Before the synthesizer can expose much of its functionality, it must be connected to a wave sink object, which is represented by the IDirectMusicSynthSink interface. The IDirectMusicSynth::SetSynthSink method establishes this connection.

The IDirectMusicSynthSink object does the work of actually connecting up to the ultimate audio destination, which might be DirectSound, Microsoft Win32 wave audio, or some other audio stream. The default implementation sends data to DirectSound.

This approach allows a synthesizer to connect to many different styles of audio out without special code within the synthesizer itself. This makes it very easy to connect one synthesizer implementation to any available wave-output device.

For more information, see the description of the IDirectMusic interface in the Microsoft Windows SDK documentation.

The pSynthSink parameter follows the reference-counting conventions for COM objects.

Requirements

See also

IDirectMusicSynthSink