Export op_current_link

[audio-opusfile.git] / lib / Audio / Opusfile.pm

diff --git a/lib/Audio/Opusfile.pm b/lib/Audio/Opusfile.pm
index a6bbc4751e47f78a72df63a33acf8d70c7751248..f5a1365fc48f405bcc264077c21319a8b1b8d026 100644 (file)
--- a/lib/Audio/Opusfile.pm
+++ b/lib/Audio/Opusfile.pm
@@ -206,6 +206,15 @@ separate function to convert this to seconds.
 The stream must be seekable to get the total. A negative value is
 returned if the stream is not seekable.
 
+=item $of->B<current_link>
+
+Retrieve the index of the current link.
+
+This is the link that produced the data most recently read by
+op_read_float() or its associated functions, or, after a seek, the
+link that the seek target landed in. Reading more data may advance the
+link index (even on the first read after a seek).
+
 =item $of->B<bitrate>([I<$link_index>])
 
 Computes the bitrate of the stream (with no arguments), or of an