Skip to content

Latest commit

 

History

History
184 lines (138 loc) · 4.49 KB

ns-xaudio2-xaudio2_performance_data.md

File metadata and controls

184 lines (138 loc) · 4.49 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NS:xaudio2.XAUDIO2_PERFORMANCE_DATA
XAUDIO2_PERFORMANCE_DATA (xaudio2.h)
Contains performance information. (XAUDIO2_PERFORMANCE_DATA)
XAUDIO2_PERFORMANCE_DATA
XAUDIO2_PERFORMANCE_DATA structure [XAudio2 Audio Mixing APIs]
xaudio2.xaudio2_performance_data
xaudio2/XAUDIO2_PERFORMANCE_DATA
xaudio2\xaudio2_performance_data.htm
xaudio2
T:Microsoft.directx_sdk.xaudio2.XAUDIO2_PERFORMANCE_DATA
12/05/2018
XAUDIO2_PERFORMANCE_DATA, XAUDIO2_PERFORMANCE_DATA structure [XAudio2 Audio Mixing APIs], xaudio2.xaudio2_performance_data, xaudio2/XAUDIO2_PERFORMANCE_DATA
xaudio2.h
Windows
Windows
XAUDIO2_PERFORMANCE_DATA
19H1
XAUDIO2_PERFORMANCE_DATA
xaudio2/XAUDIO2_PERFORMANCE_DATA
c++
APIRef
kbSyntax
HeaderDef
xaudio2.h
XAUDIO2_PERFORMANCE_DATA

XAUDIO2_PERFORMANCE_DATA structure

-description

Contains performance information.

-struct-fields

-field AudioCyclesSinceLastQuery

CPU cycles spent on audio processing since the last call to the IXAudio2::StartEngine or IXAudio2::GetPerformanceData function.

-field TotalCyclesSinceLastQuery

Total CPU cycles elapsed since the last call.

Note  This only counts cycles on the CPU on which XAudio2 is running.
 

-field MinimumCyclesPerQuantum

Fewest CPU cycles spent on processing any single audio quantum since the last call.

-field MaximumCyclesPerQuantum

Most CPU cycles spent on processing any single audio quantum since the last call.

-field MemoryUsageInBytes

Total memory currently in use.

-field CurrentLatencyInSamples

Minimum delay that occurs between the time a sample is read from a source buffer and the time it reaches the speakers.

Windows
The delay reported is a variable value equal to the rough distance between the last sample submitted to the driver by XAudio2 and the sample currently playing. The following factors can affect the delay: playing multichannel audio on a hardware-accelerated device; the type of audio device (WavePci, WaveCyclic, or WaveRT); and, to a lesser extent, audio hardware implementation.
 
Xbox 360
The delay reported is a fixed value, which is normally 1,024 samples (21.333 ms at 48 kHz). If XOverrideSpeakerConfig has been called using the XAUDIOSPEAKERCONFIG_LOW_LATENCY flag, the delay reported is 512 samples (10.667 ms at 48 kHz).

-field GlitchesSinceEngineStarted

Total audio dropouts since the engine started.

-field ActiveSourceVoiceCount

Number of source voices currently playing.

-field TotalSourceVoiceCount

Total number of source voices currently in existence.

-field ActiveSubmixVoiceCount

Number of submix voices currently playing.

-field ActiveResamplerCount

Number of resampler xAPOs currently active.

-field ActiveMatrixMixCount

Number of matrix mix xAPOs currently active.

-field ActiveXmaSourceVoices

Windows
Unsupported.
 
Xbox 360
Number of source voices decoding XMA data.

-field ActiveXmaStreams

Windows
Unsupported.
 
Xbox 360
A voice can use more than one XMA stream.

-remarks

CPU cycles are recorded using . Use to convert these values.

Platform Requirements

Windows 10 (XAudio2.9); Windows 8, Windows Phone 8 (XAudio 2.8); DirectX SDK (XAudio 2.7)

-see-also

IXAudio2::GetPerformanceData

XAudio2 Structures