Constructor Detail

• Builder

  public Builder()

Method Detail

• setTitle

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

  Sets the title.

• setArtist

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

  Sets the artist.

• setAlbumTitle

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

  Sets the album title.

• setAlbumArtist

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

  Sets the album artist.

• setDisplayTitle

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

  Sets the display title.

• setSubtitle

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

  Sets the subtitle.

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

• setDescription

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

  Sets the description.

• setUserRating

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

  Sets the user Rating.

• setOverallRating

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

  Sets the overall Rating.

• setArtworkData

  @CanIgnoreReturnValue
  @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

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

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

• maybeSetArtworkData

  @CanIgnoreReturnValue
  public MediaMetadata.Builder maybeSetArtworkData​(byte[] artworkData,
                                                   @PictureType
                                                   @com.google.android.exoplayer2.MediaMetadata.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

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

  Sets the artwork Uri.

• setTrackNumber

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

  Sets the track number.

• setTotalTrackCount

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

  Sets the total number of tracks.

• setFolderType

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

  Sets the MediaMetadata.FolderType.

  This method will be deprecated. Use setIsBrowsable(java.lang.Boolean) to indicate if an item is a browsable folder and use setMediaType(java.lang.Integer) to indicate the type of the folder.

• setIsBrowsable

  @CanIgnoreReturnValue
  public MediaMetadata.Builder setIsBrowsable​(@Nullable
                                              Boolean isBrowsable)

  Sets whether the media is a browsable folder.

• setIsPlayable

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

  Sets whether the media is playable.

• setYear

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

  Deprecated.

  Use setRecordingYear(Integer) instead.

• setRecordingYear

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

  Sets the year of the recording date.

• setRecordingMonth

  @CanIgnoreReturnValue
  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

  @CanIgnoreReturnValue
  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

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

  Sets the year of the release date.

• setReleaseMonth

  @CanIgnoreReturnValue
  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

  @CanIgnoreReturnValue
  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

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

  Sets the writer.

• setComposer

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

  Sets the composer.

• setConductor

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

  Sets the conductor.

• setDiscNumber

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

  Sets the disc number.

• setTotalDiscCount

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

  Sets the total number of discs.

• setGenre

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

  Sets the genre.

• setCompilation

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

  Sets the compilation.

• setStation

  @CanIgnoreReturnValue
  public MediaMetadata.Builder setStation​(@Nullable
                                          CharSequence station)

  Sets the name of the station streaming the media.

• setMediaType

  @CanIgnoreReturnValue
  public MediaMetadata.Builder setMediaType​(@Nullable
                                            @MediaType Integer mediaType)

  Sets the MediaMetadata.MediaType.

• setExtras

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

  Sets the extras Bundle.

• populateFromMetadata

  @CanIgnoreReturnValue
  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

  @CanIgnoreReturnValue
  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.

• populate

  @CanIgnoreReturnValue
  public MediaMetadata.Builder populate​(@Nullable
                                        MediaMetadata mediaMetadata)

  Populates all the fields from mediaMetadata, provided they are non-null.

• build

  public MediaMetadata build()

  Returns a new MediaMetadata instance with the current builder values.