audioclient.h header

This header is used by Core Audio APIs. For more information, see:

• Core Audio APIs

audioclient.h contains the following programming interfaces:

Interfaces

IAcousticEchoCancellationControl Provides a mechanism for determining if an audio capture endpoint supports acoustic echo cancellation (AEC) and, if so, allows the client to set the audio render endpoint that should be used as the reference stream.
IAudioCaptureClient The IAudioCaptureClient interface enables a client to read input data from a capture endpoint buffer.
IAudioClient The IAudioClient interface enables a client to create and initialize an audio stream between an audio application and the audio engine (for a shared-mode stream) or the hardware buffer of an audio endpoint device (for an exclusive-mode stream).
IAudioClient2 The IAudioClient2 interface is derived from the IAudioClient interface, with a set of additional methods that enable a Windows Audio Session API (WASAPI) audio client to do the following:_opt in for offloading, query stream properties, and get information from the hardware that handles offloading.The audio client can be successful in creating an offloaded stream if the underlying endpoint supports the hardware audio engine, the endpoint has been enumerated and discovered by the audio system, and there are still offload pin instances available on the endpoint.
IAudioClient3 The IAudioClient3 interface is derived from the IAudioClient2 interface, with a set of additional methods that enable a Windows Audio Session API (WASAPI) audio client to query for the audio engine's supported periodicities and current periodicity as well as request initialization of a shared audio stream with a specified periodicity.
IAudioClientDuckingControl Provides a method, SetDuckingOptionsForCurrentStream, that allows an app to specify that the system shouldn't duck the audio of other streams when the app's audio render stream is active.
IAudioClock The IAudioClock interface enables a client to monitor a stream's data rate and the current position in the stream.
IAudioClock2 The IAudioClock2 interface is used to get the current device position.
IAudioClockAdjustment The IAudioClockAdjustment interface is used to adjust the sample rate of a stream.
IAudioEffectsChangedNotificationClient A callback interface allows applications to receive notifications when the list of audio effects changes or the resources needed to enable an effect changes.
IAudioEffectsManager Provides management functionality for the audio effects pipeline
IAudioRenderClient The IAudioRenderClient interface enables a client to write output data to a rendering endpoint buffer.
IAudioStreamVolume The IAudioStreamVolume interface enables a client to control and monitor the volume levels for all of the channels in an audio stream.
IAudioViewManagerService Provides APIs for associating an HWND with an audio stream.
IChannelAudioVolume The IChannelAudioVolume interface enables a client to control and monitor the volume levels for all of the channels in the audio session that the stream belongs to.
ISimpleAudioVolume The ISimpleAudioVolume interface enables a client to control the master volume level of an audio session.

Structures

AUDIO_EFFECT Represents an audio effect.
AudioClientProperties The AudioClientProperties structure (audioclient.h) is used to set the parameters that describe the properties of the client's audio stream.

Enumerations

_AUDCLNT_BUFFERFLAGS The _AUDCLNT_BUFFERFLAGS enumeration defines flags that indicate the status of an audio endpoint buffer.
AUDCLNT_STREAMOPTIONS Defines values that describe the characteristics of an audio stream.
AUDIO_DUCKING_OPTIONS Specifies audio ducking options. Use values from this enumeration when calling IAudioClientDuckingControl::SetDuckingOptionsForCurrentStream
AUDIO_EFFECT_STATE Specifies the state of an audio effect.