Muzei offers two API surfaces:
Muzei itself is responsible for displaying wallpaper images, or
Artwork, but even its built
in wallpaper sources are all built with the same
com.google.android.apps.muzei.api.provider.MuzeiArtProvider API, which makes it possible
for any app to provide wallpapers to Muzei via just a few steps:
com.google.android.apps.muzei:muzei-api:3.2.0 or higher.
<provider> tag to your
AndroidManifest.xml file and add the required
Once you have both Muzei and your custom source installed, you should be able to choose your source from the 'Sources' screen in Muzei.
A deeper discussion of the API, along with code snippets, is available in the com.google.android.apps.muzei.api.provider.MuzeiArtProvider class reference.
A complete example is available in the example-unsplash directory.
You can access the current wallpaper on Android phones and tablets, or on Wear OS, while Muzei is the active wallpaper.
A deeper discussion of the API, along with code snippets, is available in the com.google.android.apps.muzei.api package reference docs.
Complete examples are available in the example-watchface directory.
Contains the MuzeiContract APIs to get the current artwork from Muzei.
Contains the APIs needed to build a custom source using a MuzeiArtProvider.