[vlc-commits] [Git][videolan/vlc][master] vlc_sout: fix parameter documentation for SOUT_STREAM_ID_SPU_HIGHLIGHT

[Steve Lhomme (@robUx4)]

Steve Lhomme pushed to branch master at VideoLAN / VLC


Commits:
1dcda3d7 by Steve Lhomme at 2023-07-29T09:23:52+00:00
vlc_sout: fix parameter documentation for SOUT_STREAM_ID_SPU_HIGHLIGHT

It requires a stream ID, as the same suggests.

It got lost in 7779bf5a36013071337e070d9bb55d0234dadfbc.

- - - - -


1 changed file:

- include/vlc_sout.h


Changes:

=====================================
include/vlc_sout.h
=====================================
@@ -196,12 +196,14 @@ enum sout_stream_query_e
      * the stream output.
      * This control should fail and do nothing if not implemented.
      *
+     * \param void* Stream ID
      * \param vlc_spu_highlight_t* Selected spu data.
      *
      * Usage:
      * \code{c}
+     * void *stream_id;
      * const vlc_spu_highlight_t hl_data = {... SPU infos...};
-     * sout_StreamControl(stream, SOUT_STREAM_ID_SPU_HIGHLIGHT, &hl_data);
+     * sout_StreamControl(stream, SOUT_STREAM_ID_SPU_HIGHLIGHT, stream_id, &hl_data);
      * \endcode
      */
     SOUT_STREAM_ID_SPU_HIGHLIGHT,



View it on GitLab: https://code.videolan.org/videolan/vlc/-/commit/1dcda3d70a2ed9593fb677dca69bfa472ef1a44a

-- 
View it on GitLab: https://code.videolan.org/videolan/vlc/-/commit/1dcda3d70a2ed9593fb677dca69bfa472ef1a44a
You're receiving this email because of your account on code.videolan.org.


VideoLAN code repository instance