[vlc-commits] vlc_es_out: update comments to avoid es state control misuses

[Francois Cartegnie]

vlc | branch: master | Francois Cartegnie <fcvlcdev at free.fr> | Thu Sep 28 12:20:09 2017 +0200| [d0b88cac552b728700daff48ad48c769672f90fb] | committer: Francois Cartegnie

vlc_es_out: update comments to avoid es state control misuses

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

 include/vlc_es_out.h | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/include/vlc_es_out.h b/include/vlc_es_out.h
index f8d7aa1b2c..fbed8bd3ae 100644
--- a/include/vlc_es_out.h
+++ b/include/vlc_es_out.h
@@ -35,7 +35,7 @@
 
 enum es_out_query_e
 {
-    /* set ES selected for the es category (audio/video/spu) */
+    /* set or change the selected ES in its category (audio/video/spu) */
     ES_OUT_SET_ES,      /* arg1= es_out_id_t*                   */
     ES_OUT_RESTART_ES,  /* arg1= es_out_id_t*                   */
     /* Restart all ES, destroying and recreating decoder/sout and potential
@@ -45,7 +45,8 @@ enum es_out_query_e
     /* set 'default' tag on ES (copied across from container) */
     ES_OUT_SET_ES_DEFAULT, /* arg1= es_out_id_t*                */
 
-    /* force selection/unselection of the ES (bypass current mode) */
+    /* force (un)selection of the ES (bypass current mode)
+       XXX: this will not change the state of any other ES ! (see SET_ES) */
     ES_OUT_SET_ES_STATE,/* arg1= es_out_id_t* arg2=bool   */
     ES_OUT_GET_ES_STATE,/* arg1= es_out_id_t* arg2=bool*  */