Microsoft DirectX 8.1 (C++)

IDirectMusicPerformance8::CreateStandardAudioPath

The CreateStandardAudioPath method creates an object that represents the stages in data flow from the performance to DirectSound buffers. This method can be used instead of IDirectMusicPerformance8::CreateAudioPath to create a basic predefined audiopath rather than one defined in a source file.

Syntax

HRESULT  CreateStandardAudioPath(
  DWORD dwType, 
  DWORD dwPChannelCount, 
  BOOL  fActivate,
  IDirectMusicAudioPath **ppNewPath
);
 

Parameters

dwType

Type of the path. The following values are defined.

Value Description
DMUS_APATH_DYNAMIC_3D One bus to a 3-D buffer. Does not send to environmental reverb.
DMUS_APATH_DYNAMIC_MONO One bus to a mono buffer.
DMUS_APATH_DYNAMIC_STEREO Two buses to a stereo buffer.
DMUS_APATH_SHARED_STEREOPLUSREVERB Ordinary music setup with stereo outs and reverb.

For more information on these audiopath types, see Standard Audiopaths.

dwPChannelCount

Number of performance channels in the path.

fActivate

Boolean value that specifies whether to activate the path on creation.

ppNewPath

Address of a variable that receives an IDirectMusicAudioPath interface pointer for the audiopath. See IDirectMusicAudioPath8.

Return Values

If the method succeeds, the return value is S_OK.

If it fails, the method can return one of the error values shown in the following table.

Return code
DMUS_E_AUDIOPATHS_NOT_VALID
DMUS_E_NOT_INIT
DSERR_BUFFERLOST
E_INVALIDARG
E_OUTOFMEMORY
E_POINTER

Remarks

The method fails with DSERR_BUFFERLOST if any application has initialized DirectSound with the write-primary cooperative level.

Requirements

  Header: Declared in dmusici.h.

See Also