Point to SupportedAudioFormats wiki page where appropriate

I documented the supported PCM sample formats and compressed audio
encodings in the wiki, let's add some pointers to the new documentation.
This commit is contained in:
Tanu Kaskinen 2020-04-16 18:27:48 +03:00
parent 743fa02c5f
commit 36a4923f9b
6 changed files with 26 additions and 30 deletions

View file

@ -62,6 +62,10 @@ typedef enum pa_encoding {
PA_ENCODING_DTSHD_IEC61937,
/**< DTS-HD Master Audio encapsulated in IEC 61937 header/padding. \since 13.0 */
/* Remeber to update
* https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/SupportedAudioFormats/
* when adding new encodings! */
PA_ENCODING_MAX,
/**< Valid encoding types must be less than this value */

View file

@ -171,6 +171,10 @@ typedef enum pa_sample_format {
PA_SAMPLE_S24_32BE,
/**< Signed 24 Bit PCM in LSB of 32 Bit words, big endian. \since 0.9.15 */
/* Remeber to update
* https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/SupportedAudioFormats/
* when adding new formats! */
PA_SAMPLE_MAX,
/**< Upper limit of valid sample types */

View file

@ -686,9 +686,9 @@ static void help(const char *argv0) {
" --stream-name=NAME How to call this stream on the server\n"
" --volume=VOLUME Specify the initial (linear) volume in range 0...65536\n"
" --rate=SAMPLERATE The sample rate in Hz (defaults to 44100)\n"
" --format=SAMPLEFORMAT The sample type, one of s16le, s16be, u8, float32le,\n"
" float32be, ulaw, alaw, s32le, s32be, s24le, s24be,\n"
" s24-32le, s24-32be (defaults to s16ne)\n"
" --format=SAMPLEFORMAT The sample format, see\n"
" https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/SupportedAudioFormats/\n"
" for possible values (defaults to s16ne)\n"
" --channels=CHANNELS The number of channels, 1 for mono, 2 for stereo\n"
" (defaults to 2)\n"
" --channel-map=CHANNELMAP Channel map to use instead of the default\n"