SnapshotMetadataChange

AI-generated Key Takeaways

• SnapshotMetadataChange allows developers to modify the metadata of a snapshot, such as the cover image, description, played time, and progress value.

• Unset fields in a SnapshotMetadataChange object will retain their existing values in the snapshot metadata.

• SnapshotMetadataChange.EMPTY_CHANGE can be used to commit a snapshot change without altering any metadata.

• The SnapshotMetadataChange.Builder class is used to create instances of SnapshotMetadataChange.

public interface SnapshotMetadataChange

A collection of changes to apply to the metadata of a snapshot. Fields that are not set will retain their current values.

Nested Class Summary

class

SnapshotMetadataChange.Builder

Builder for SnapshotMetadataChange objects.

Field Summary

public static final SnapshotMetadataChange

EMPTY_CHANGE

Sentinel object to use to commit a change without modifying the metadata.

Public Method Summary

abstract Bitmap	getCoverImage() Returns the new cover image to set for the snapshot.
abstract String	getDescription() Returns the new description to set for the snapshot.
abstract Long	getPlayedTimeMillis() Returns the new played time to set for the snapshot.
abstract Long	getProgressValue() Returns the new progress value to set for the snapshot.

Fields

public static final SnapshotMetadataChange EMPTY_CHANGE

Sentinel object to use to commit a change without modifying the metadata.

Public Methods

public abstract Bitmap getCoverImage ()

Returns the new cover image to set for the snapshot.

public abstract String getDescription ()

Returns the new description to set for the snapshot.

public abstract Long getPlayedTimeMillis ()

Returns the new played time to set for the snapshot.

public abstract Long getProgressValue ()

Returns the new progress value to set for the snapshot.