Firelight Technologies FMOD Studio API
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
);
C# Syntax
RESULT System.getOutputHandle(
out IntPtr handle
);
JavaScript Syntax
System.getOutputHandle(
handle
);
Parameters
- handle
- Address of a variable that receives the handle to the output mode's native hardware API object (see remarks for supported outputs).
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_WAVWRITER Pointer to stdio FILE is returned FMOD_OUTPUTTYPE_WAVWRITER_NRT Pointer to stdio FILE is returned
FMOD_OUTPUTTYPE_DSOUND Pointer to type IDirectSound8 is returned. FMOD_OUTPUTTYPE_WINMM Pointer to type HWAVEOUT is returned. FMOD_OUTPUTTYPE_WASAPI Pointer to type IAudioClient is returned. FMOD_OUTPUTTYPE_ALSA Pointer to type snd_pcm_t is returned. FMOD_OUTPUTTYPE_COREAUDIO Handle of type AudioUnit is returned. FMOD_OUTPUTTYPE_XAUDIO (Xbox360) Pointer to type IXAudio2 is returned. FMOD_OUTPUTTYPE_AUDIOOUT (PS4) Pointer to type int is returned. Handle returned from sceAudioOutOpen.
See Also
Version 1.10.03 Built on Feb 1, 2018