client API: report IDs of inserted playlist entries on loading playlist

May or may not help when dealing with playlist loading in scripts. It's
supposed to help with the mean fact that loading a recursive playlist
will essentially edit the playlist behind the API user's back.

1 files changed, 17 insertions, 0 deletions

diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst
index 3e449ba81b..c19a8fdd65 100644
--- a/DOCS/man/input.rst
+++ b/DOCS/man/input.rst
@@ -1358,6 +1358,23 @@ This list uses the event name field value, and the C API symbol in brackets:
         In the future, this ``error`` field will be unset for this specific
         event.)
 
+    ``playlist_insert_id``
+        If loading ended, because the playlist entry to be played was for example
+        a playlist, and the current playlist entry is replaced with a number of
+        other entries. This may happen at least with MPV_END_FILE_REASON_REDIRECT
+        (other event types may use this for similar but different purposes in the
+        future). In this case, playlist_insert_id will be set to the playlist
+        entry ID of the first inserted entry, and playlist_insert_num_entries to
+        the total number of inserted playlist entries. Note this in this specific
+        case, the ID of the last inserted entry is playlist_insert_id+num-1.
+        Beware that depending on circumstances, you may observe the new playlist
+        entries before seeing the event (e.g. reading the "playlist" property or
+        getting a property change notification before receiving the event).
+        If this is 0 in the C API, this field isn't added.
+
+    ``playlist_insert_num_entries``
+        See playlist_insert_id. Only present if playlist_insert_id is present.
+
 ``file-loaded``  (``MPV_EVENT_FILE_LOADED``)
     Happens after a file was loaded and begins playback.