doc: use @command{} for commands.
[ffmpeg.git] / doc / outdevs.texi
1 @chapter Output Devices
2 @c man begin OUTPUT DEVICES
3
4 Output devices are configured elements in FFmpeg which allow to write
5 multimedia data to an output device attached to your system.
6
7 When you configure your FFmpeg build, all the supported output devices
8 are enabled by default. You can list all available ones using the
9 configure option "--list-outdevs".
10
11 You can disable all the output devices using the configure option
12 "--disable-outdevs", and selectively enable an output device using the
13 option "--enable-outdev=@var{OUTDEV}", or you can disable a particular
14 input device using the option "--disable-outdev=@var{OUTDEV}".
15
16 The option "-formats" of the ff* tools will display the list of
17 enabled output devices (amongst the muxers).
18
19 A description of the currently available output devices follows.
20
21 @section alsa
22
23 ALSA (Advanced Linux Sound Architecture) output device.
24
25 @section oss
26
27 OSS (Open Sound System) output device.
28
29 @section sdl
30
31 SDL (Simple DirectMedia Layer) output device.
32
33 This output devices allows to show a video stream in an SDL
34 window. Only one SDL window is allowed per application, so you can
35 have only one instance of this output device in an application.
36
37 To enable this output device you need libsdl installed on your system
38 when configuring your build.
39
40 For more information about SDL, check:
41 @url{http://www.libsdl.org/}
42
43 @subsection Options
44
45 @table @option
46
47 @item window_title
48 Set the SDL window title, if not specified default to the filename
49 specified for the output device.
50
51 @item icon_title
52 Set the name of the iconified SDL window, if not specified it is set
53 to the same value of @var{window_title}.
54
55 @item window_size
56 Set the SDL window size, can be a string of the form
57 @var{width}x@var{height} or a video size abbreviation.
58 If not specified it defaults to the size of the input video.
59 @end table
60
61 @subsection Examples
62
63 The following command shows the @command{ffmpeg} output is an
64 SDL window, forcing its size to the qcif format:
65 @example
66 ffmpeg -i INPUT -vcodec rawvideo -pix_fmt yuv420p -window_size qcif -f sdl "SDL output"
67 @end example
68
69 @section sndio
70
71 sndio audio output device.
72
73 @c man end OUTPUT DEVICES