doc/indevs: make pulse dev formatting consistent with other devices
authorLukasz Marek <lukasz.m.luki@gmail.com>
Fri, 4 Oct 2013 12:01:51 +0000 (14:01 +0200)
committerStefano Sabatini <stefasab@gmail.com>
Mon, 7 Oct 2013 10:01:51 +0000 (12:01 +0200)
Signed-off-by: Lukasz Marek <lukasz.m.luki@gmail.com>
Signed-off-by: Stefano Sabatini <stefasab@gmail.com>
doc/indevs.texi

index 5cc03f9..6bcb237 100644 (file)
@@ -485,87 +485,49 @@ For more information about OSS see:
 
 @section pulse
 
-pulseaudio input device.
+PulseAudio input device.
 
-To enable this input device during configuration you need libpulse-simple
-installed in your system.
+To enable this output device you need to configure FFmpeg with @code{--enable-libpulse}.
 
 The filename to provide to the input device is a source device or the
 string "default"
 
-To list the pulse source devices and their properties you can invoke
+To list the PulseAudio source devices and their properties you can invoke
 the command @command{pactl list sources}.
 
-@example
-ffmpeg -f pulse -i default /tmp/pulse.wav
-@end example
-
-@subsection @var{server} AVOption
-
-The syntax is:
-@example
--server @var{server name}
-@end example
-
-Connects to a specific server.
-
-@subsection @var{name} AVOption
-
-The syntax is:
-@example
--name @var{application name}
-@end example
-
-Specify the application name pulse will use when showing active clients,
-by default it is the LIBAVFORMAT_IDENT string
-
-@subsection @var{stream_name} AVOption
-
-The syntax is:
-@example
--stream_name @var{stream name}
-@end example
-
-Specify the stream name pulse will use when showing active streams,
-by default it is "record"
+@subsection Options
+@table @option
+@item server
+Connect to a specific server. Default server is used when not provided.
 
-@subsection @var{sample_rate} AVOption
+@item name
+Specify the application name PulseAudio will use when showing active clients,
+by default it is the @code{LIBAVFORMAT_IDENT} string.
 
-The syntax is:
-@example
--sample_rate @var{samplerate}
-@end example
+@item stream_name
+Specify the stream name PulseAudio will use when showing active streams,
+by default it is "record".
 
+@item sample_rate
 Specify the samplerate in Hz, by default 48kHz is used.
 
-@subsection @var{channels} AVOption
-
-The syntax is:
-@example
--channels @var{N}
-@end example
-
+@item channels
 Specify the channels in use, by default 2 (stereo) is set.
 
-@subsection @var{frame_size} AVOption
+@item frame_size
+Specify the number of bytes per frame, by default it is set to 1024.
 
-The syntax is:
-@example
--frame_size @var{bytes}
-@end example
-
-Specify the number of byte per frame, by default it is set to 1024.
-
-@subsection @var{fragment_size} AVOption
+@item fragment_size
+Specify the minimal buffering fragment in PulseAudio, it will affect the
+audio latency. By default it is unset.
+@end table
 
-The syntax is:
+@subsection Examples
+Record a stream from default device:
 @example
--fragment_size @var{bytes}
+ffmpeg -f pulse -i default /tmp/pulse.wav
 @end example
 
-Specify the minimal buffering fragment in pulseaudio, it will affect the
-audio latency. By default it is unset.
-
 @section sndio
 
 sndio input device.