Skip to content

Latest commit

 

History

History
83 lines (62 loc) · 3.12 KB

nf-audioengineendpoint-ihardwareaudioenginebase-getengineformat.md

File metadata and controls

83 lines (62 loc) · 3.12 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
NF:audioengineendpoint.IHardwareAudioEngineBase.GetEngineFormat
IHardwareAudioEngineBase::GetEngineFormat (audioengineendpoint.h)
The GetEngineFormat method retrieves the current data format of the offloaded audio stream.
GetEngineFormat
GetEngineFormat method [Core Audio]
GetEngineFormat method [Core Audio]
IHardwareAudioEngineBase interface
IHardwareAudioEngineBase interface [Core Audio]
GetEngineFormat method
IHardwareAudioEngineBase.GetEngineFormat
IHardwareAudioEngineBase::GetEngineFormat
audioengineendpoint/IHardwareAudioEngineBase::GetEngineFormat
coreaudio.ihardwareaudioenginebase_getengineformat
coreaudio\ihardwareaudioenginebase_getengineformat.htm
CoreAudio
150F8E7C-35A0-42DA-8E3D-69835153382F
12/05/2018
GetEngineFormat, GetEngineFormat method [Core Audio], GetEngineFormat method [Core Audio],IHardwareAudioEngineBase interface, IHardwareAudioEngineBase interface [Core Audio],GetEngineFormat method, IHardwareAudioEngineBase.GetEngineFormat, IHardwareAudioEngineBase::GetEngineFormat, audioengineendpoint/IHardwareAudioEngineBase::GetEngineFormat, coreaudio.ihardwareaudioenginebase_getengineformat
audioengineendpoint.h
Windows
Windows
19H1
IHardwareAudioEngineBase::GetEngineFormat
audioengineendpoint/IHardwareAudioEngineBase::GetEngineFormat
c++
APIRef
kbSyntax
COM
audioengineendpoint.h
IHardwareAudioEngineBase.GetEngineFormat

IHardwareAudioEngineBase::GetEngineFormat

-description

The GetEngineFormat method retrieves the current data format of the offloaded audio stream.

-parameters

-param pDevice [in]

A pointer to an IMMDevice interface.

-param _bRequestDeviceFormat [in]

A Boolean variable that indicates whether or not the IMMDevice interface is being accessed to retrieve the device format.

-param _ppwfxFormat [out]

A pointer to a pointer to a WAVEFORMATEX structure that provides information about the hardware audio engine. This includes the waveform audio format type, the number of audio channels, and the sample rate of the audio engine.

-returns

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

-see-also

IHardwareAudioEngineBase

IMMDevice

WAVEFORMATEX