IAudioClient Interface Reference

Inheritance diagram for IAudioClient:

Collaboration diagram for IAudioClient:

Public Member Functions
HRESULT	Initialize ([in] AUDCLNT_SHAREMODE ShareMode, [in] DWORD StreamFlags, [in] REFERENCE_TIME hnsBufferDuration, [in] REFERENCE_TIME hnsPeriodicity, [in] const WAVEFORMATEX *pFormat, [in] LPCGUID AudioSessionGuid)
HRESULT	GetBufferSize ([out] UINT32 *pNumBufferFrames)
HRESULT	GetStreamLatency ([out] REFERENCE_TIME *phnsLatency)
HRESULT	GetCurrentPadding ([out] UINT32 *pNumPaddingFrames)
HRESULT	IsFormatSupported ([in] AUDCLNT_SHAREMODE ShareMode, [in] const WAVEFORMATEX *pFormat, [out, unique] WAVEFORMATEX **ppClosestMatch)
HRESULT	GetMixFormat ([out] WAVEFORMATEX **ppDeviceFormat)
HRESULT	GetDevicePeriod ([out] REFERENCE_TIME *phnsDefaultDevicePeriod, [out] REFERENCE_TIME *phnsMinimumDevicePeriod)
HRESULT	Start (void)
HRESULT	Stop (void)
HRESULT	Reset (void)
HRESULT	SetEventHandle ([in] HANDLE eventHandle)
HRESULT	GetService ([in] REFIID riid, [iid_is(riid), out] void **ppv)
Public Member Functions inherited from IUnknown
HRESULT	QueryInterface ([in] REFIID riid, [out, iid_is(riid)] void **ppvObject)
ULONG	AddRef ()
ULONG	Release ()

Additional Inherited Members
Public Types inherited from IUnknown
typedef IUnknown *	LPUNKNOWN

Detailed Description

Definition at line 73 of file audioclient.idl.

Member Function Documentation

GetBufferSize()

HRESULT IAudioClient::GetBufferSize

(

[out] UINT32 *

pNumBufferFrames

)

GetCurrentPadding()

HRESULT IAudioClient::GetCurrentPadding

(

[out] UINT32 *

pNumPaddingFrames

)

GetDevicePeriod()

HRESULT IAudioClient::GetDevicePeriod	(	[out] REFERENCE_TIME *	phnsDefaultDevicePeriod,
		[out] REFERENCE_TIME *	phnsMinimumDevicePeriod
	)

GetMixFormat()

HRESULT IAudioClient::GetMixFormat

(

[out] WAVEFORMATEX **

ppDeviceFormat

)

GetService()

HRESULT IAudioClient::GetService	(	[in] REFIID	riid,
		[iid_is(riid), out] void **	ppv
	)

GetStreamLatency()

HRESULT IAudioClient::GetStreamLatency

(

[out] REFERENCE_TIME *

phnsLatency

)

Initialize()

HRESULT IAudioClient::Initialize	(	[in] AUDCLNT_SHAREMODE	ShareMode,
		[in] DWORD	StreamFlags,
		[in] REFERENCE_TIME	hnsBufferDuration,
		[in] REFERENCE_TIME	hnsPeriodicity,
		[in] const WAVEFORMATEX *	pFormat,
		[in] LPCGUID	AudioSessionGuid
	)

IsFormatSupported()

HRESULT IAudioClient::IsFormatSupported	(	[in] AUDCLNT_SHAREMODE	ShareMode,
		[in] const WAVEFORMATEX *	pFormat,
		[out, unique] WAVEFORMATEX **	ppClosestMatch
	)

Reset()

HRESULT IAudioClient::Reset

(

void

)

SetEventHandle()

HRESULT IAudioClient::SetEventHandle

(

[in] HANDLE

eventHandle

)

Start()

HRESULT IAudioClient::Start

(

void

)

Stop()

HRESULT IAudioClient::Stop

(

void

)

---

The documentation for this interface was generated from the following file:

• sdk/include/psdk/audioclient.idl