WindowsAudioSession

page_type	languages	products	urlFragment	extendedZipContent	description
sample	cpp cppcx	windows windows-uwp	WindowsAudioSession	path target SharedContent SharedContent path target LICENSE LICENSE	Shows how to do various audio related tasks using the Windows Audio Session API (WASAPI).

Windows audio session (WASAPI) sample

Shows how to do various audio related tasks using the Windows Audio Session API (WASAPI).

Note: This sample is part of a large collection of UWP feature samples. You can download this sample as a standalone ZIP file from docs.microsoft.com, or you can download the entire collection as a single ZIP file, but be sure to unzip everything to access shared dependencies. For more info on working with the ZIP file, the samples collection, and GitHub, see Get the UWP samples from GitHub. For more samples, see the Samples portal on the Windows Dev Center.

Specifically, this sample covers:

• Enumerating audio playback devices attached to the system and retrieve additional properties.
• Demonstrates how to opt-in to hardware audio offload on supported devices.
• Demonstrates how to implement the basic media transport controls in order to properly support background audio playback.
• Playback of audio using the Windows Audio Session APIs.
• Capture of PCM audio using the Windows Audio Session APIs.
• Low latency audio playback and capture.

For more information on adding audio to your app, see Quickstart: adding audio to an app.

Playing audio in the background is supported by the Windows Audio Session API only in communication scenarios as demonstrated by the VoIP sample. Instead, for general background audio playback of media, use the MediaPlayer class demonstrated in the Background Media Playback sample.

Related topics

Samples

Background Audio
VoIP

Roadmaps

Audio, video, and camera
Designing UX for apps
Roadmap for apps using C# and Visual Basic
Roadmap for apps using C++
Roadmap for apps using JavaScript

Reference

Windows Audio Session API (WASAPI)
Core Audio APIs
Media Foundation

Operating system requirements

Client: Windows 10

Phone: Windows 10

Build the sample

1. If you download the samples ZIP, be sure to unzip the entire archive, not just the folder with the sample you want to build.
2. Start Microsoft Visual Studio and select File > Open > Project/Solution.
3. Starting in the folder where you unzipped the samples, go to the Samples subfolder, then the subfolder for this specific sample, then the subfolder for your preferred language (C++, C#, or JavaScript). Double-click the Visual Studio Solution (.sln) file.
4. Press Ctrl+Shift+B, or select Build > Build Solution.

Run the sample

The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it.

Deploying the sample

1. Select Build > Deploy Solution.

Deploying and running the sample

1. To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging.