[vlc-commits] [Git][videolan/vlc][master] libvlc: fix libvlc_audio_set_format() doc

[Hugo Beauzée-Luyssen (@chouquette)]

Hugo Beauzée-Luyssen pushed to branch master at VideoLAN / VLC


Commits:
b9bc4b7b by Rémi Denis-Courmont at 2022-03-18T18:20:10+00:00
libvlc: fix libvlc_audio_set_format() doc

List the supported formats and describe them.

- - - - -


1 changed file:

- include/vlc/libvlc_media_player.h


Changes:

=====================================
include/vlc/libvlc_media_player.h
=====================================
@@ -1104,9 +1104,16 @@ void libvlc_audio_set_format_callbacks( libvlc_media_player_t *mp,
  * This only works in combination with libvlc_audio_set_callbacks(),
  * and is mutually exclusive with libvlc_audio_set_format_callbacks().
  *
+ * The supported formats are:
+ * - "S16N" for signed 16-bit PCM
+ * - "S32N" for signed 32-bit PCM
+ * - "FL32" for single precision IEEE 754
+ *
+ * All supported formats use the native endianess.
+ * If there are more than one channel, samples are interleaved.
+ *
  * \param mp the media player
  * \param format a four-characters string identifying the sample format
- *               (e.g. "S16N" or "f32l")
  * \param rate sample rate (expressed in Hz)
  * \param channels channels count
  * \version LibVLC 2.0.0 or later



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

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


VideoLAN code repository instance