Share via

IXACTCue::SetVoiceOutput

  • Article

IXACTCue::SetVoiceOutput

Routes the output of a cue to up to three XAudio voices.

Xbox 360:  This method is specific to the Xbox 360 platform and uses the XAUDIOVOICEOUTPUT structure of the XAudio services.

[Content-driven]

  HRESULT 
  SetVoiceOutput(
  LPCXAUDIOVOICEOUTPUT pVoiceOutput
);

Parameters

  • pVoiceOutput
    [in] Pointer to an XAUDIOVOICEOUTPUT structure representing the destination voice. The destination voice may contain up to six output channels.

Return Values

Returns S_OK if successful, an error code otherwise.

Remarks

SetVoiceOutput must be called before the cue starts playing.

After calling SetVoiceOutput, calls to IXACTCue::SetChannelVolume are ignored. You must use IXACTCue::SetVoiceOutputVolume to adjust the volume, or switch to using a channel map by calling IXACTCue::SetChannelMap.

The maximum number of voices that SetVoiceOutput may be routed to is defined by XACTMAXOUTPUTVOICECOUNT.

Requirements

Header: Declared in Xact.h.

Library: Use Xact.lib.

See Also

IXACTCue