public Class FBHapticPcm

The extension name.

The extension specification version.

API Constants

Extends XrStructureType.

Enum values:

• TYPE_HAPTIC_PCM_VIBRATION_FB
• TYPE_DEVICE_PCM_SAMPLE_RATE_STATE_FB
• TYPE_DEVICE_PCM_SAMPLE_RATE_GET_INFO_FB

Extends XrStructureType.

Enum values:

• TYPE_HAPTIC_PCM_VIBRATION_FB
• TYPE_DEVICE_PCM_SAMPLE_RATE_STATE_FB
• TYPE_DEVICE_PCM_SAMPLE_RATE_GET_INFO_FB

Extends XrStructureType.

Enum values:

• TYPE_HAPTIC_PCM_VIBRATION_FB
• TYPE_DEVICE_PCM_SAMPLE_RATE_STATE_FB
• TYPE_DEVICE_PCM_SAMPLE_RATE_GET_INFO_FB

Unsafe version of: GetDeviceSampleRateFB

Get device sample rate.

C Specification

XrResult xrGetDeviceSampleRateFB(
    XrSession                                   session,
    const XrHapticActionInfo*                   hapticActionInfo,
    XrDevicePcmSampleRateGetInfoFB*             deviceSampleRate);

Description

The runtime must use the hapticActionInfo to get the sample rate of the currently bound device on which haptics is triggered and populate the deviceSampleRate structure. The device is determined by the action and subaction of XrHapticActionInfo. If the hapticActionInfo is bound to more than one device, then runtime should assume that the all these bound devices have the same deviceSampleRate and the runtime should return the sampleRate for any of those bound devices. If the device is invalid, the runtime must populate the sampleRate of XrDevicePcmSampleRateStateFB as 0. A device can be invalid if the runtime does not find any device (which can play haptics) connected to the headset, or if the device does not support PCM haptic effect.

Valid Usage (Implicit)

• The XR_FB_haptic_pcm extension must be enabled prior to calling GetDeviceSampleRateFB
• session must be a valid XrSession handle
• hapticActionInfo must be a pointer to a valid XrHapticActionInfo structure
• deviceSampleRate must be a pointer to an XrDevicePcmSampleRateGetInfoFB structure

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_PATH_UNSUPPORTED
• ERROR_PATH_INVALID
• ERROR_ACTION_TYPE_MISMATCH
• ERROR_ACTIONSET_NOT_ATTACHED

See Also

XrDevicePcmSampleRateGetInfoFB, XrDevicePcmSampleRateStateFB, XrHapticActionInfo

Parameters

session:XrSession

the specified XrSession.

hapticActionInfo:XrHapticActionInfo

the XrHapticActionInfo used to provide action and subaction paths

deviceSampleRate:XrDevicePcmSampleRateGetInfoFB

a pointer to XrDevicePcmSampleRateStateFB which is populated by the runtime.

Annotations

@NativeType:XrResult