XAUDIO2_VOICE_SENDS structure (xaudio2.h)

Article
02/22/2024

Defines a set of voices to receive data from a single output voice.

Syntax

typedef struct XAUDIO2_VOICE_SENDS {
  UINT32                  SendCount;
  XAUDIO2_SEND_DESCRIPTOR *pSends;
} XAUDIO2_VOICE_SENDS;

Members

SendCount

Number of voices to receive the output of the voice. An OutputCount value of 0 indicates the voice should not send output to any voices.

pSends

Array of XAUDIO2_SEND_DESCRIPTOR structures describing destination voices and the filters that should be used when sending to the voices. This array should contain SendCount elements. If SendCount is 0 pSends should be NULL. Note that pSends cannot contain the same voice more than once.

Remarks

If pSends is not NULL all of its elements must be non-NULL. To send output to the default mastering voice call IXAudio2Voice::SetOutputVoices with the pSendList argument set to NULL.

Setting SendCount to 0 is useful for certain effects such as volume meters or file writers that don't generate any audio output to pass on to another voice.

If needed, a voice will perform a single sample rate conversion, from the voice's input sample rate to the input sample rate of the voice's output voices. Because only one sample rate conversion will be performed, all the voice's output voices must have the same input sample rate. If the input sample rates of the voice and its output voices are the same, no sample rate conversion is performed.

Platform Requirements

Windows 10 (XAudio2.9); Windows 8, Windows Phone 8 (XAudio 2.8); DirectX SDK (XAudio 2.7)

Requirements

Requirement	Value
Header	xaudio2.h