System media transport controls sample
Shows how to use the APIs in the Windows.Media namespace to allow your app to respond to system media events as well as providing the system with metadata about the content that is playing.
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.
In particular, this sample demonstrates manual integration with SystemMediaTransportControls (SMTC). MediaPlayer has automatic integration with SMTC, but since this sample demonstrates manual integration with SMTC, it disables the MediaPlayer's CommandManager which is what performs the automatic integration. Unless you have a need to manually integrate with SMTC, such as using an audio API like WASAPI or AudioGraph, it is recommended that you use the built-in integration through CommandManager instead of the procedures demonstrated throughout this sample.
With automatic integration, timeline properties are synchronized from the player, button state is inferred but can still be customized, and metadata is updated through MediaPlaybackItem.ApplyDisplayProperties() instead of directly updating the SMTC. In contrast, manual integration means that the app intends to update all state and handle all events of the SMTC itself.
Note that the SMTC does not show data for the first time until the application begins an audio playback session.
Scenario 1: Press the "Select Files" button in order to select some media content from your device.
In the code behind, when the file open picker is launched and a file is selected, the file/s are assigned to the playlist defined as a list of Storage Items and the first item is passed to SetNewMediaItem.
SetNewMediaItem performs a number of interesting jobs. It enables or disables certain system controls, such as next and previous based on where we are in the playlist. It then opens the file and sets it on the MediaPlayer using Source. The MediaPlayer is set to AutoPlay so the file will begin to play on it's own. The final thing it does is attempt to read metadata from the file itself, using the CopyFromFileAsync method on the DisplayUpdater in order update the SystemMediaTransportControls. It's possible to set all of the metadata required manually by directly manipulating the properties on the display updater.
The rest of the sample focuses on some core concepts of using the System Media Transport Controls. Firstly we keep the controls up to date with our state, such as our current playback status and the position of our current playback.
The second thing we do is set up a number of event handlers in order to handle certain events from the system. One example of this is the ButtonPressed event which sends the app commands such as play, pause and skip etc. This is so the user can still control the app, even if it isn't neccesarily on screen. In this event handler we take the appropriate action for the command, such as pausing our media and then updating the state back on the control.
- Windows 10 build 14393 or higher
Build the sample
- If you download the samples ZIP, be sure to unzip the entire archive, not just the folder with the sample you want to build.
- Start Microsoft Visual Studio and select File > Open > Project/Solution.
- 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
- Select Build > Deploy Solution.
Deploying and running the sample
- 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.