Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IAudioClient2::SetClientProperties method

Sets the properties of the audio stream by populating an AudioClientProperties structure.

Syntax


HRESULT SetClientProperties(
  [inconst AudioClientProperties *pProperties
);

Parameters

pProperties [in]

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

Minimum supported client

Windows 8 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2012 [desktop apps | Windows Store apps]

Minimum supported phone

Windows Phone 8.1

Header

Audioclient.h

See also

AudioClientProperties
IAudioClient2
IAudioClient::Initialize

 

 

Show:
© 2017 Microsoft