System::getOutputHandle

Retrieves a pointer to the system level output device module. This means a pointer to a DirectX "LPDIRECTSOUND", or a WINMM handle, or with something like with FMOD_OUTPUTTYPE_NOSOUND output, the handle will be null or 0.

C++ Syntax

FMOD_RESULT System::getOutputHandle(
  void **handle
);

C Syntax

FMOD_RESULT FMOD_System_GetOutputHandle(
  FMOD_SYSTEM *system,
  void **handle
);

Parameters

handle: Address of a variable that receives the handle to the output mode's native hardware API object (see remarks).

Return Values

If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.

Remarks

Must be called after System::init.
Cast the resulting pointer depending on what output system pointer you are after.

FMOD_OUTPUTTYPE_DSOUND       Pointer to type DIRECTSOUND is returned.
FMOD_OUTPUTTYPE_WINMM        Pointer to type HWAVEOUT is returned.
FMOD_OUTPUTTYPE_OPENAL       Pointer to type ALCdevice is returned.
FMOD_OUTPUTTYPE_WASAPI       Pointer to type IAudioRenderClient is returned.
FMOD_OUTPUTTYPE_ASIO         Pointer to type AsioDrivers is returned.
FMOD_OUTPUTTYPE_OSS          File handle is returned, (cast to int).
FMOD_OUTPUTTYPE_ALSA         Pointer to type snd_pcm_t is returned.
FMOD_OUTPUTTYPE_ESD          Handle of type int is returned, as returned by so_esd_open_sound (cast to int).
FMOD_OUTPUTTYPE_COREAUDIO    Handle of type AudioUnit is returned.
FMOD_OUTPUTTYPE_PS3          NULL / 0 is returned.
FMOD_OUTPUTTYPE_XBOX360      Pointer to type IXAudio2 is returned.
FMOD_OUTPUTTYPE_PSP          NULL / 0 is returned.
FMOD_OUTPUTTYPE_WII          NULL / 0 is returned.
FMOD_OUTPUTTYPE_NOSOUND      NULL / 0 is returned.
FMOD_OUTPUTTYPE_WAVWRITER    NULL / 0 is returned.

See Also

Version 1.03.06 Built on Apr 17, 2014