Libovr 1.30 Reference Guide

OVR_CAPI_Audio.h File Reference

CAPI audio functions.

Macros

#define	NOMINMAX
#define	OVR_AUDIO_MAX_DEVICE_STR_SIZE

Functions

ovrResult	ovr_GetAudioDeviceOutWaveId ( UINT * deviceOutId ) Gets the ID of the preferred VR audio output device.
ovrResult	ovr_GetAudioDeviceInWaveId ( UINT * deviceInId ) Gets the ID of the preferred VR audio input device.
ovrResult	ovr_GetAudioDeviceOutGuidStr ( WCHAR deviceOutStrBuffer ) Gets the GUID of the preferred VR audio device as a string.
ovrResult	ovr_GetAudioDeviceOutGuid ( GUID * deviceOutGuid ) Gets the GUID of the preferred VR audio device.
ovrResult	ovr_GetAudioDeviceInGuidStr ( WCHAR deviceInStrBuffer ) Gets the GUID of the preferred VR microphone device as a string.
ovrResult	ovr_GetAudioDeviceInGuid ( GUID * deviceInGuid ) Gets the GUID of the preferred VR microphone device.

Detailed Description

Copyright 2015 Oculus VR, LLC. All Rights reserved.

Macros Documentation

#define NOMINMAX

#define OVR_AUDIO_MAX_DEVICE_STR_SIZE

Function Documentation

ovrResult ovr_GetAudioDeviceOutWaveId ( UINT * deviceOutId )

Gets the ID of the preferred VR audio output device.

Parameters

deviceOutId

The ID of the user's preferred VR audio device to use, which will be valid upon a successful return value, else it will be WAVE_MAPPER.

Returns an ovrResult indicating success or failure. In the case of failure, use ovr_GetLastErrorInfo to get more information.

ovrResult ovr_GetAudioDeviceInWaveId ( UINT * deviceInId )

Gets the ID of the preferred VR audio input device.

Parameters

deviceInId

The ID of the user's preferred VR audio device to use, which will be valid upon a successful return value, else it will be WAVE_MAPPER.

Returns an ovrResult indicating success or failure. In the case of failure, use ovr_GetLastErrorInfo to get more information.

ovrResult ovr_GetAudioDeviceOutGuidStr ( WCHAR deviceOutStrBuffer )

Gets the GUID of the preferred VR audio device as a string.

Parameters

deviceOutStrBuffer

A buffer where the GUID string for the device will copied to.

Returns an ovrResult indicating success or failure. In the case of failure, use ovr_GetLastErrorInfo to get more information.

ovrResult ovr_GetAudioDeviceOutGuid ( GUID * deviceOutGuid )

Gets the GUID of the preferred VR audio device.

Parameters

deviceOutGuid

The GUID of the user's preferred VR audio device to use, which will be valid upon a successful return value, else it will be NULL.

Returns an ovrResult indicating success or failure. In the case of failure, use ovr_GetLastErrorInfo to get more information.

ovrResult ovr_GetAudioDeviceInGuidStr ( WCHAR deviceInStrBuffer )

Gets the GUID of the preferred VR microphone device as a string.

Parameters

deviceInStrBuffer

A buffer where the GUID string for the device will copied to.

Returns an ovrResult indicating success or failure. In the case of failure, use ovr_GetLastErrorInfo to get more information.

ovrResult ovr_GetAudioDeviceInGuid ( GUID * deviceInGuid )

Gets the GUID of the preferred VR microphone device.

Parameters

deviceInGuid

The GUID of the user's preferred VR audio device to use, which will be valid upon a successful return value, else it will be NULL.

Returns an ovrResult indicating success or failure. In the case of failure, use ovr_GetLastErrorInfo to get more information.

1

7

8

9

10

11

12

13

14

15

16

17

18

19

20

29

30

39

40

48

49

50

59

60

68

69

70

79

80

81

82

83

84

85

/********************************************************************************/
#ifndef OVR_CAPI_Audio_h
#define OVR_CAPI_Audio_h

#ifdef _WIN32
// Prevents <Windows.h> from defining min() and max() macro symbols.
#ifndef NOMINMAX
#define NOMINMAX
#endif
#include <windows.h>
#include "OVR_CAPI.h"
#define OVR_AUDIO_MAX_DEVICE_STR_SIZE 128

#if !defined(OVR_EXPORTING_CAPI)

OVR_PUBLIC_FUNCTION(ovrResult) ovr_GetAudioDeviceOutWaveId(UINT* deviceOutId);

OVR_PUBLIC_FUNCTION(ovrResult) ovr_GetAudioDeviceInWaveId(UINT* deviceInId);

OVR_PUBLIC_FUNCTION(ovrResult)
ovr_GetAudioDeviceOutGuidStr(WCHAR deviceOutStrBuffer[OVR_AUDIO_MAX_DEVICE_STR_SIZE]);

OVR_PUBLIC_FUNCTION(ovrResult) ovr_GetAudioDeviceOutGuid(GUID* deviceOutGuid);

OVR_PUBLIC_FUNCTION(ovrResult)
ovr_GetAudioDeviceInGuidStr(WCHAR deviceInStrBuffer[OVR_AUDIO_MAX_DEVICE_STR_SIZE]);

OVR_PUBLIC_FUNCTION(ovrResult) ovr_GetAudioDeviceInGuid(GUID* deviceInGuid);

#endif // !defined(OVR_EXPORTING_CAPI)

#endif // OVR_OS_MS

#endif // OVR_CAPI_Audio_h

The documentation for this file was generated from the following file: Include/OVR_CAPI_Audio.h