Package org.lwjgl.openxr

Class OCULUSAudioDeviceGuid

java.lang.Object

org.lwjgl.openxr.OCULUSAudioDeviceGuid

public class OCULUSAudioDeviceGuid
extends Object

The XR_OCULUS_audio_device_guid extension.

This extension enables the querying of audio device information associated with an OpenXR instance.

On Windows, there may be multiple audio devices available on the system. This extensions allows applications to query the runtime for the appropriate audio devices for the active HMD.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	XR_MAX_AUDIO_DEVICE_STR_SIZE_OCULUS	XR_MAX_AUDIO_DEVICE_STR_SIZE_OCULUS
static final String	XR_OCULUS_AUDIO_DEVICE_GUID_EXTENSION_NAME	The extension name.
static final int	XR_OCULUS_audio_device_guid_SPEC_VERSION	The extension specification version.

Method Summary

Modifier and Type	Method	Description
static int	nxrGetAudioInputDeviceGuidOculus(org.lwjgl.openxr.XrInstance instance, long buffer)	Unsafe version of: GetAudioInputDeviceGuidOculus
static int	nxrGetAudioOutputDeviceGuidOculus(org.lwjgl.openxr.XrInstance instance, long buffer)	Unsafe version of: GetAudioOutputDeviceGuidOculus
static int	xrGetAudioInputDeviceGuidOculus(org.lwjgl.openxr.XrInstance instance, ByteBuffer buffer)	Query the GUID for the active audio input device.
static int	xrGetAudioOutputDeviceGuidOculus(org.lwjgl.openxr.XrInstance instance, ByteBuffer buffer)	Query the GUID for the active audio output device.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

XR_OCULUS_audio_device_guid_SPEC_VERSION

public static final int XR_OCULUS_audio_device_guid_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_OCULUS_AUDIO_DEVICE_GUID_EXTENSION_NAME

public static final String XR_OCULUS_AUDIO_DEVICE_GUID_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_MAX_AUDIO_DEVICE_STR_SIZE_OCULUS

public static final int XR_MAX_AUDIO_DEVICE_STR_SIZE_OCULUS

XR_MAX_AUDIO_DEVICE_STR_SIZE_OCULUS

See Also:

• Constant Field Values

Method Details

nxrGetAudioOutputDeviceGuidOculus

public static int nxrGetAudioOutputDeviceGuidOculus(org.lwjgl.openxr.XrInstance instance,
 long buffer)

Unsafe version of: GetAudioOutputDeviceGuidOculus

xrGetAudioOutputDeviceGuidOculus

public static int xrGetAudioOutputDeviceGuidOculus(org.lwjgl.openxr.XrInstance instance,
 ByteBuffer buffer)

Query the GUID for the active audio output device.

C Specification

 XrResult xrGetAudioOutputDeviceGuidOculus(
     XrInstance                                  instance,
     wchar_t                                     buffer[XR_MAX_AUDIO_DEVICE_STR_SIZE_OCULUS]);

Valid Usage (Implicit)

• The XR_OCULUS_audio_device_guid extension must be enabled prior to calling GetAudioOutputDeviceGuidOculus
• instance must be a valid XrInstance handle
• buffer must be a wide character array of length MAX_AUDIO_DEVICE_STR_SIZE_OCULUS

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_FEATURE_UNSUPPORTED

See Also

GetAudioInputDeviceGuidOculus

Parameters:

instance - the XrInstance to query the audio device state in.

buffer - a fixed size buffer which will contain the audio device GUID. The format of this data matches the IMMDevice::GetId API.

nxrGetAudioInputDeviceGuidOculus

public static int nxrGetAudioInputDeviceGuidOculus(org.lwjgl.openxr.XrInstance instance,
 long buffer)

Unsafe version of: GetAudioInputDeviceGuidOculus

xrGetAudioInputDeviceGuidOculus

public static int xrGetAudioInputDeviceGuidOculus(org.lwjgl.openxr.XrInstance instance,
 ByteBuffer buffer)

Query the GUID for the active audio input device.

C Specification

 XrResult xrGetAudioInputDeviceGuidOculus(
     XrInstance                                  instance,
     wchar_t                                     buffer[XR_MAX_AUDIO_DEVICE_STR_SIZE_OCULUS]);

Valid Usage (Implicit)

• The XR_OCULUS_audio_device_guid extension must be enabled prior to calling GetAudioInputDeviceGuidOculus
• instance must be a valid XrInstance handle
• buffer must be a wide character array of length MAX_AUDIO_DEVICE_STR_SIZE_OCULUS

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_FEATURE_UNSUPPORTED

See Also

GetAudioOutputDeviceGuidOculus

Parameters:

instance - the XrInstance to query the audio device state in.

buffer - a fixed size buffer which will contain the audio device GUID. The format of this data matches the IMMDevice::GetId API.