Artwork

Constants and helper methods for the Artwork table, providing access to the current artwork.

The Artwork table contains the details of the artwork that has been loaded by Muzei. It also provides direct access to the cached image already downloaded by Muzei, ensuring that you do not need to do additional networks requests or have internet access when retrieving previously loaded artwork.

Working with the Artwork table

Querying CONTENT_URI will return either zero rows (in cases where the user has never activated Muzei before) or a row for each previously loaded artwork with all of the details needed to create an Artwork object. The helper method getCurrentArtwork builds an Artwork object for the most recent artwork, although you can certainly query the CONTENT_URI directly and either use the columns directly or use Artwork.fromCursor to parse the Cursor for you.

If instead you use ContentResolver.openInputStream, you'll get an InputStream for the cached image Bitmap. This can then be passed to BitmapFactory.decodeStream or similar methods to retrieve the Bitmap itself. The helper method getCurrentArtworkBitmap does this operation, although note that this may return a very large Bitmap so following the Handling Bitmaps documentation advice is highly suggested.

Listening for changes

Just like any ContentProvider, listening for changes can be done by implementing a ContentObserver on CONTENT_URI to listen for updates.

On API 24+ devices, it is strongly recommended to use WorkManager or JobScheduler to listen for content URI changes in the background without maintaining a constantly running ContentObserver.

To support earlier versions of Android, you can listen for the ACTION_ARTWORK_CHANGED broadcast, sent out immediately after an update is made:

<receiver android:name=".ExampleArtworkUpdateReceiver">
  <intent-filter>
    <action android:name="com.google.android.apps.muzei.ACTION_ARTWORK_CHANGED" />
  </intent-filter>
</receiver>

No data is sent alongside the broadcast, but this can be used to kick off background processing to retrieve the latest artwork or start other processing.

Properties

Functions