Documentation:Streaming HowTo New

This documentation explains how to stream, transcode and save streams using VLC media player.

NOTE: This is work in progress. For a more complete, yet outdated, documentation on Streaming with VLC please see the old Streaming HowTo.

Introduction

VLC media player is able to stream, transcode and save different media streams. For more information about the formats and codecs supported please see the VideoLAN Streaming Features list.

Transcoding

Transcoding is the process of taking a media file or stream and converting it to a different format or bitrate. There are two methods for transcoding in VLC, via the GUI (VLC's default interface) or via the commandline. The term transcode by itself normally refers to converting one media format to another and saving the output to a file (i.e. no streaming involved).

Transcoding using the GUI

One of the methods of transcoding is via the GUI. To access this:

1. In VLC, go to "Media >> Convert / Save..." (Ctrl+R).
2. Add the input file(s) or stream(s) you want to transcode. Press "Convert / Save".
3. In the "Convert" windows specify the destination file name (including file extension - e.g. on Windows "C:\out.mp3").
4. Select the desired codec from the profile list. To check/edit the settings of a given profile press the "Edit selected profile" button. Profiles can also be added/deleted.
5. Press "Start".

If the profile settings were compatible and transcoding was sucessful a playable destination file should be created.

Using the commandline

Another method of transcoding is via the commandline. This is more flexible than via the GUI as it enables full usage of the modules and options available in VLC.

To use the VLC's commandline you need to have access to the commandline interface, for example via a shell.

Windows-based systems

On Windows-based system Command Prompt can be used. This can be found in the "Accessories" folder of the Start menu. Alternatively by going to "Start >> Run..." or pressing "Windows key + R", entering "cmd" into the text field and press "OK" or Enter.

Once the Command Prompt window is opened navigating to the folder/directory where VLC is located is easiest for using the commandline as only "vlc.exe" or "vlc" (as the .exe part is assumed) needs to entered to run VLC. If VLC is installed in the default location (on a 32-bit system) running:

cd "C:\Program Files\VideoLAN\VLC"

Should change to the directory where vlc.exe is located.

Unix systems

On Unix-based system (such as Linux and Mac OS X) a terminal window can be opened. Running "vlc" should be all that is needed to open VLC.

Transcoding commandline string structure

A typical commandline string for converting a file to another format is:

vlc --sout "#transcode{[TRANSCODE_OPTIONS]}:std{[OUTPUT_OPTIONS]}" INPUT

Where INPUT is the input stream, [TRANSCODE_OPTIONS] are the options set for the desired output format, codecs, bitrate etc. and [OUTPUT_OPTIONS] are the option set for the output type. --sout is the stream output commandline option.

Example commandline: Converting an audio file to a MP3 file

An example usage might be converting an audio file to a MP3 file:

vlc --sout "#transcode{acodec=mp3,ab=128,channels=2,samplerate=44100}:std{access=file,mux=raw,dst=OUTPUT}" INPUT

Where INPUT is the input file ans OUTPUT is the destination file (for example "C:\out.mp3" on Windows or "/home/username/out.mp3" on a *nix system). The above sout string is the default "Audio - MP3" profile setting accessible via the GUI. It will convert an audio input to a 128kbps CBR MP3 file (sample rate 44100Hz, 2 channels).

Other examples commandline strings

Convert an audio input to an uncompressed WAVE (*.wav) file:

vlc --sout "#transcode{acodec=s16l,channels=2,samplerate=44100}:std{access=file,mux=wav,dst=OUTPUT}" INPUT

Convert an audio input to an AAC file (MP4 container):

vlc --sout "#transcode{acodec=mp4a,ab=128,channels=2,samplerate=44100}:std{access=file,mux=mp4,dst=OUTPUT}" INPUT

Streaming

Streaming using the GUI

Basically, to stream using the GUI, open VLC, then Media [menu] -> Streaming -> (select any media to stream, then hit Stream button). At this point it asks you *how* to stream it. The most common way is via HTTP. To stream via HTTP, click on "Destinations", choose HTTP from the drop down as a "New Destination" and click add. Now if you are streaming video, you will want to stream to something like "/go.mpg." Now hit stream, and you should be able to use a different instance of VLC as a client, and listen to that stream now (ex: on the same computer it would be "Media" [menu] -> Open Network Stream -> "http://localhost:8080/go.mpg" and it should work.

A few caveats:

• even though you click on "enable transcoding" and specify some other container type, it will give you the flv container type unless you use a suffix, like ".mpg" ref
• VLC client cannot receive a stream at less than 5 fps, though it can stream it all right for those speeds (and other players can receive it). ref.
• NB that *many* times when using the GUI to stream it will choose the wrong thing. Like if you give a path of "/" it will use FLV container type (which you probably didn't want, and which overrides your transcoding settings' container type *silently*), and if you give it "/go.mp4" it will *silently* fail (you can look at the log messages to see what the error is--it says "mp4 type is not supported except for files"). It is tricky to get it setup. It's like the GUI sets it up wrong most times. Here is a [laundry list].

First there is an input text called Source, where you'll find your media path and the its type.

If you'll click on Destination you'll see the destination of stream that could be: File, HTTP, MS-WSMP, RTSP, RTP/MPG, RTP, Audio/Video, UDP and Icecast.

File:Stream-destination.png

You can abilitate Transcoding to transcode your video to one in the list or in a one you can specify by clicking on the proper icon.

Last you have the option of stream you'll share.

By clicking stream it will return to VLC main user interface and the playbar will scroll as the video will play.

Streaming using the command line interface

If you want to stream using the command line interface instead of the GUI (more control, for example you can specify your own container), you can "sniff" the options the GUI is using by opening up the logger (Tools menu -> message) and setting verbosity level to "2" then doing a stream. It will output debug messages that basically tell you what it is using for command line parameters, then you will take those same parameters and use them on the command line (you may need to add quotation marks around words that have spaces in them, and you may need to add --'s).

An example is in a unique command line:

C:\Program Files\VideoLAN\VLC>vlc "C:\Users\Public\Videos\Sample Videos\Wildlife.wmv":
sout=#transcode{vcodec=h264,acodec=mp3,ab=128,channels=2,samplerate=44100}:http{dst=:8090/go.mpg}

More Links

The Documentation chapter 4.

See also

• Streaming HowTo - Outdated HowTo for streaming with VLC
• Transcode - Further information about transcoding with VLC
• VideoLAN documentation site, chapter 4