Constructor Detail

• Builder

  public Builder()

Method Detail

• setTitle

  public MediaMetadata.Builder setTitle​(@Nullable
                                        CharSequence title)

  Sets the title.

• setArtist

  public MediaMetadata.Builder setArtist​(@Nullable
                                         CharSequence artist)

  Sets the artist.

• setAlbumTitle

  public MediaMetadata.Builder setAlbumTitle​(@Nullable
                                             CharSequence albumTitle)

  Sets the album title.

• setAlbumArtist

  public MediaMetadata.Builder setAlbumArtist​(@Nullable
                                              CharSequence albumArtist)

  Sets the album artist.

• setDisplayTitle

  public MediaMetadata.Builder setDisplayTitle​(@Nullable
                                               CharSequence displayTitle)

  Sets the display title.

• setSubtitle

  public MediaMetadata.Builder setSubtitle​(@Nullable
                                           CharSequence subtitle)

  Sets the subtitle.

  This is the secondary title of the media, unrelated to closed captions.

• setDescription

  public MediaMetadata.Builder setDescription​(@Nullable
                                              CharSequence description)

  Sets the description.

• setMediaUri

  public MediaMetadata.Builder setMediaUri​(@Nullable
                                           Uri mediaUri)

  Sets the media Uri.

• setUserRating

  public MediaMetadata.Builder setUserRating​(@Nullable
                                             Rating userRating)

  Sets the user Rating.

• setOverallRating

  public MediaMetadata.Builder setOverallRating​(@Nullable
                                                Rating overallRating)

  Sets the overall Rating.

• setArtworkData

  @Deprecated
  public MediaMetadata.Builder setArtworkData​(@Nullable
                                              byte[] artworkData)

  Deprecated.

  Use setArtworkData(byte[] data, Integer pictureType) or maybeSetArtworkData(byte[] data, int pictureType), providing a MediaMetadata.PictureType.

• setArtworkData

  public MediaMetadata.Builder setArtworkData​(@Nullable
                                              byte[] artworkData,
                                              @Nullable @PictureType
                                              Integer artworkDataType)

  Sets the artwork data as a compressed byte array with an associated artworkDataType.

• maybeSetArtworkData

  public MediaMetadata.Builder maybeSetArtworkData​(byte[] artworkData,
                                                   @PictureType
                                                   int artworkDataType)

  Sets the artwork data as a compressed byte array in the event that the associated MediaMetadata.PictureType is MediaMetadata.PICTURE_TYPE_FRONT_COVER, the existing MediaMetadata.PictureType is not MediaMetadata.PICTURE_TYPE_FRONT_COVER, or the current artworkData is not set.

  Use setArtworkData(byte[], Integer) to set the artwork data without checking the MediaMetadata.PictureType.

• setArtworkUri

  public MediaMetadata.Builder setArtworkUri​(@Nullable
                                             Uri artworkUri)

  Sets the artwork Uri.

• setTrackNumber

  public MediaMetadata.Builder setTrackNumber​(@Nullable
                                              Integer trackNumber)

  Sets the track number.

• setTotalTrackCount

  public MediaMetadata.Builder setTotalTrackCount​(@Nullable
                                                  Integer totalTrackCount)

  Sets the total number of tracks.

• setFolderType

  public MediaMetadata.Builder setFolderType​(@Nullable @FolderType
                                             Integer folderType)

  Sets the MediaMetadata.FolderType.

• setIsPlayable

  public MediaMetadata.Builder setIsPlayable​(@Nullable
                                             Boolean isPlayable)

  Sets whether the media is playable.

• setYear

  @Deprecated
  public MediaMetadata.Builder setYear​(@Nullable
                                       Integer year)

  Deprecated.

  Use setRecordingYear(Integer) instead.

• setRecordingYear

  public MediaMetadata.Builder setRecordingYear​(@Nullable
                                                Integer recordingYear)

  Sets the year of the recording date.

• setRecordingMonth

  public MediaMetadata.Builder setRecordingMonth​(@Nullable @IntRange(from=1L,to=12L)
                                                 Integer recordingMonth)

  Sets the month of the recording date.

  Value should be between 1 and 12.

• setRecordingDay

  public MediaMetadata.Builder setRecordingDay​(@Nullable @IntRange(from=1L,to=31L)
                                               Integer recordingDay)

  Sets the day of the recording date.

  Value should be between 1 and 31.

• setReleaseYear

  public MediaMetadata.Builder setReleaseYear​(@Nullable
                                              Integer releaseYear)

  Sets the year of the release date.

• setReleaseMonth

  public MediaMetadata.Builder setReleaseMonth​(@Nullable @IntRange(from=1L,to=12L)
                                               Integer releaseMonth)

  Sets the month of the release date.

  Value should be between 1 and 12.

• setReleaseDay

  public MediaMetadata.Builder setReleaseDay​(@Nullable @IntRange(from=1L,to=31L)
                                             Integer releaseDay)

  Sets the day of the release date.

  Value should be between 1 and 31.

• setWriter

  public MediaMetadata.Builder setWriter​(@Nullable
                                         CharSequence writer)

  Sets the writer.

• setComposer

  public MediaMetadata.Builder setComposer​(@Nullable
                                           CharSequence composer)

  Sets the composer.

• setConductor

  public MediaMetadata.Builder setConductor​(@Nullable
                                            CharSequence conductor)

  Sets the conductor.

• setDiscNumber

  public MediaMetadata.Builder setDiscNumber​(@Nullable
                                             Integer discNumber)

  Sets the disc number.

• setTotalDiscCount

  public MediaMetadata.Builder setTotalDiscCount​(@Nullable
                                                 Integer totalDiscCount)

  Sets the total number of discs.

• setGenre

  public MediaMetadata.Builder setGenre​(@Nullable
                                        CharSequence genre)

  Sets the genre.

• setCompilation

  public MediaMetadata.Builder setCompilation​(@Nullable
                                              CharSequence compilation)

  Sets the compilation.

• setExtras

  public MediaMetadata.Builder setExtras​(@Nullable
                                         Bundle extras)

  Sets the extras Bundle.

• populateFromMetadata

  public MediaMetadata.Builder populateFromMetadata​(Metadata metadata)

  Sets all fields supported by the entries within the Metadata.

  Fields are only set if the Metadata.Entry has an implementation for Metadata.Entry.populateMediaMetadata(Builder).

  In the event that multiple Metadata.Entry objects within the Metadata relate to the same MediaMetadata field, then the last one will be used.

• populateFromMetadata

  public MediaMetadata.Builder populateFromMetadata​(List<Metadata> metadataList)

  Sets all fields supported by the entries within the list of Metadata.

  Fields are only set if the Metadata.Entry has an implementation for Metadata.Entry.populateMediaMetadata(Builder).

  In the event that multiple Metadata.Entry objects within any of the Metadata relate to the same MediaMetadata field, then the last one will be used.

• build

  public MediaMetadata build()

  Returns a new MediaMetadata instance with the current builder values.