Add doc for setTrackerData extension

SRGSSR · Feb 14, 2024 · c6d0c0b · c6d0c0b
1 parent 2f6cbff
commit c6d0c0b
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/pillarbox-player/src/main/java/ch/srgssr/pillarbox/player/extension/MediaItem.kt b/pillarbox-player/src/main/java/ch/srgssr/pillarbox/player/extension/MediaItem.kt
@@ -29,7 +29,7 @@ fun MediaItem.getMediaItemTrackerData(): MediaItemTrackerData {
 }
 
 /**
- * Set tracker data.
+ * Set tracker data. This method should only be called if {@link #setUri} is passed a non-null value.
  * @see MediaItem.Builder.setTag
  * @param trackerData Set trackerData to [MediaItem.Builder.setTag].
  * @return [MediaItem.Builder] for convenience