Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Sets the properties of the audio stream by populating an AudioClientProperties structure.
Syntax
HRESULT SetClientProperties(
[in] const AudioClientProperties *pProperties
);
Parameters
[in] pProperties
Pointer to an AudioClientProperties structure.
Return value
The SetClientProperties method returns S_OK to indicate that it has completed successfully. Otherwise it returns an appropriate error code.
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
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 8 [desktop apps | UWP apps] |
| Minimum supported server | Windows Server 2012 [desktop apps | UWP apps] |
| Target Platform | Windows |
| Header | audioclient.h |