[vlc-devel] [PATCH V2 08/17] player: document vout lifecycle

[Thomas Guillem]

---
 include/vlc_player.h | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/include/vlc_player.h b/include/vlc_player.h
index ad170f3306..bc93f6029d 100644
--- a/include/vlc_player.h
+++ b/include/vlc_player.h
@@ -2613,6 +2613,10 @@ vlc_player_aout_EnableFilter(vlc_player_t *player, const char *name, bool add);
  * @warning the returned vout_thread_t * must be released with vout_Release().
  * @see vlc_players_cbs.on_vout_list_changed
  *
+ * @note If the player was able to load a "vout window" module, the player is
+ * guaranteed to always hold one valid vout (that can be in the started or
+ * stopped state).
+ *
  * @param player player instance
  * @return a valid vout_thread_t * or NULL, cf. warning
  */
-- 
2.20.1