[vlc-commits] libvlc_media.h: note that all options are not appliable to medias.

[Olivier Aubert]

vlc | branch: master | Olivier Aubert <olivier.aubert at liris.cnrs.fr> | Thu Jun 14 15:04:13 2012 +0200| [47081ad9792b1ef190df4dea26cc2f9b91e2b57c] | committer: Olivier Aubert

libvlc_media.h: note that all options are not appliable to medias.

See
http://forum.videolan.org/viewtopic.php?f=32&t=100612&p=339220&hilit=media_add_option#p339267
and
http://forum.videolan.org/viewtopic.php?f=32&t=99357&p=333659&hilit=media_add_option#p333659
for reference.

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=47081ad9792b1ef190df4dea26cc2f9b91e2b57c
---

 include/vlc/libvlc_media.h |   12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/include/vlc/libvlc_media.h b/include/vlc/libvlc_media.h
index 279a29c..d743833 100644
--- a/include/vlc/libvlc_media.h
+++ b/include/vlc/libvlc_media.h
@@ -251,7 +251,11 @@ LIBVLC_API libvlc_media_t *libvlc_media_new_as_node(
  * read the media. This allows to use VLC's advanced
  * reading/streaming options on a per-media basis.
  *
- * The options are detailed in vlc --long-help, for instance "--sout-all"
+ * The options are detailed in vlc --long-help, for instance
+ * "--sout-all". Note that all options are not usable on medias:
+ * specifically, due to architectural issues, video-related options
+ * such as text renderer options cannot be set on a single media. They
+ * must be set on the whole libvlc instance instead.
  *
  * \param p_md the media descriptor
  * \param ppsz_options the options (as a string)
@@ -267,7 +271,11 @@ LIBVLC_API void libvlc_media_add_option(
  * read the media. This allows to use VLC's advanced
  * reading/streaming options on a per-media basis.
  *
- * The options are detailed in vlc --long-help, for instance "--sout-all"
+ * The options are detailed in vlc --long-help, for instance
+ * "--sout-all". Note that all options are not usable on medias:
+ * specifically, due to architectural issues, video-related options
+ * such as text renderer options cannot be set on a single media. They
+ * must be set on the whole libvlc instance instead.
  *
  * \param p_md the media descriptor
  * \param ppsz_options the options (as a string)