[libbluray-devel] Update documentation

[hpi1]

libbluray | branch: master | hpi1 <hpi1 at anonymous.org> | Mon Feb 20 21:58:01 2017 +0200| [13bdae1d0d0c48fc271a6b9d9ee29cbf2fb9e240] | committer: hpi1

Update documentation

> http://git.videolan.org/gitweb.cgi/libbluray.git/?a=commit;h=13bdae1d0d0c48fc271a6b9d9ee29cbf2fb9e240
---

 src/libbluray/bluray.h | 18 ++++++++++++++----
 1 file changed, 14 insertions(+), 4 deletions(-)

diff --git a/src/libbluray/bluray.h b/src/libbluray/bluray.h
index 725292e..c8be696 100644
--- a/src/libbluray/bluray.h
+++ b/src/libbluray/bluray.h
@@ -570,9 +570,18 @@ void bd_seamless_angle_change(BLURAY *bd, unsigned angle);
  *
  *  Select stream (PG / TextST track)
  *
+ *  When playing with on-disc menus:
+ *
+ *  Stream selection is controlled by on-disc menus.
+ *  If user can change stream selection also in player GUI, this function
+ *  should be used to keep on-disc menus in sync with player GUI.
+ *
+ *  When playing the disc without on-disc menus:
+ *
+ *  Initial stream selection is done using preferred language settings.
  *  This function can be used to override automatic stream selection.
- *  Selecting the stream is useful only when using libbluray internal decoders
- *  or stream is stored in a sub-path.
+ *  Without on-disc menus selecting the stream is useful only when using
+ *  libbluray internal decoders or the stream is stored in a sub-path.
  *
  * @param bd  BLURAY object
  * @param stream_type  BLURAY_*_STREAM
@@ -997,9 +1006,8 @@ int bd_set_rate(BLURAY *bd, uint32_t rate);
 
 /**
  *
- *  Pass user input to graphics controller.
+ *  Pass user input to graphics controller or BD-J.
  *  Keys are defined in libbluray/keys.h.
- *  Current pts can be updated by using BD_VK_NONE key. This is required for animated menus.
  *
  * @param bd  BLURAY object
  * @param pts current playback position (1/90000s) or -1
@@ -1012,6 +1020,8 @@ int bd_user_input(BLURAY *bd, int64_t pts, uint32_t key);
  *
  *  Select menu button at location (x,y).
  *
+ *  This function has no effect with BD-J menus.
+ *
  * @param bd  BLURAY object
  * @param pts current playback position (1/90000s) or -1
  * @param x mouse pointer x-position