Edit

Share via

IAudioClient3::GetCurrentSharedModeEnginePeriod method (audioclient.h)

  • Article

Returns the current format and periodicity of the audio engine. This method enables audio clients to match the current period of the audio engine.

Syntax

HRESULT GetCurrentSharedModeEnginePeriod(
  [out] WAVEFORMATEX **ppFormat,
  [out] UINT32       *pCurrentPeriodInFrames
);

Parameters

[out] ppFormat

Type: WAVEFORMATEX**

The current device format that is being used by the audio engine.

[out] pCurrentPeriodInFrames

Type: UINT32*

The current period of the audio engine, in audio frames.

Return value

Type: HRESULT

This method returns S_OK to indicate that it has completed successfully. Otherwise it returns an appropriate error code.

Remarks

Note  The values returned by this method are instantaneous values and may be invalid immediately after the call returns if, for example, another audio client sets the periodicity or format to a different value.
 
Note  The caller is responsible for calling CoTaskMemFree to deallocate the memory of the WAVEFORMATEX structure populated by this method.
 

Requirements

Requirement Value
Minimum supported client Windows 10 [desktop apps only]
Minimum supported server Windows Server 2016 [desktop apps only]
Target Platform Windows
Header audioclient.h

See also

IAudioClient3