AudioClientProperties structure
The AudioClientProperties structure is used to set the parameters that describe the properties of the client's audio stream.
Syntax
typedef struct _AudioClientProperties { UINT32 cbSize; BOOL bIsOffload; AUDIO_STREAM_CATEGORY eCategory; AUDCLNT_STREAMOPTIONS Options; } AudioClientProperties, *PAudioClientProperties;
Members
- cbSize
-
The size of the AudioClientProperties structure, in bytes.
- bIsOffload
-
Boolean value to indicate whether or not the audio stream is hardware-offloaded.
- eCategory
-
An enumeration that is used to specify the category of the audio stream.
- Options
-
A member of the AUDCLNT_STREAMOPTIONS enumeration describing the characteristics of the stream.
Supported in Windows 8.1 and later.
Remarks
Starting with Windows 10, hardware-offloaded audio streams must be event driven. This means that if you call IAudioClient2::SetClientProperties and set the bIsOffload parameter of the AudioClientProperties to TRUE, you must specify the AUDCLNT_STREAMFLAGS_EVENTCALLBACK flag in the StreamFlags parameter to IAudioClient::Initialize.
Requirements
|
Minimum supported client |
Windows 8 [desktop apps | Windows Store apps] |
|---|---|
|
Minimum supported server |
Windows Server 2012 [desktop apps | Windows Store apps] |
|
Header |
|
See also
- Core Audio Structures
- AUDIO_STREAM_CATEGORY
- IAudioClient2::SetClientProperties
- AUDCLNT_STREAMOPTIONS