Documentation:Streaming HowTo/Easy Streaming

Intro

The easier way to start streaming with VLC is by using one of the graphical user interfaces: wxwindows for Windows and GNU/Linux, the skinnable Windows and GNU/Linux interface or the MacOS X native interface.

Streaming using the Wizard

The Streaming/Transcoding Wizard leads you step by step through the process of streaming your media on a network or saving it to your hard drive. This Wizard offers easy to use menus but provides a restricted set of options.

Note: The wizard is only available on the wxWindows interface.

Launching the wizard

To launch the Streaming/Transcoding Wizard open the "File" menu, and select the Wizard menu item.

Launching the Wizard

Wizard dialog

First select the type of task:

• Stream to network: Choose this option if you want to stream media on network.
• Transcode/Save to file: Choose this option if you want to change a file's audio codec and/or video codec, its bitrate, and/or encapsulation method.

The Wizard Dialog

Input selection

Select a stream (such as a file, a network stream, a disk, a capture device ...) by selecting the Choose... dialog or an existing item in your playlist, using the Existing playlist item option.

Partial Extract: To read only part of the stream, check the "Enable" checkbox and choose a start and end date (in seconds). This option should only be used with streams you can control such as files or discs but not network streams or capture devices.

Wizard input selection

Wizard input selection from playlist

Streaming methods

If you chose Stream to network option, you can now specify the streaming method. Available methods are:

• UDP Unicast: Stream to a single computer. Enter the client's IP address (in the 0.0.0.0 - 223.255.255.255 range).
• UDP Multicast: Stream to multiple computers using multicast. Enter the IP address of the multicast group (in the 224.0.0.0 to 239.255.255.255 range).
• HTTP: Stream by using the HTTP protocol. If you leave the Destination text box empty, VLC will listen on all the network interfaces of the server on port 8080. Specify an address, port and path on which to listen using the following syntax [ip][:port][/path]. For instance, 192.168.0.1:80/stream will make VLC listen on the interface carrying the 192.168.0.1 IP address, on the 80 TCP port, in the /stream virtual file.

Wizard streaming method

Transcoding options

If you chose the Transcode/Save to file option, you can now specify the new audio and video codecs and bitrates you want you input converted to.

(See <xref linkend="smc" endterm="tsmc" />)

Wizard transcode

Encapsulation method

Choose the method format. The UDP streaming methods require MPEG TS encapsulation. The HTTP streaming method can be used with the MPEG PS, MPEG TS, MPEG 1, OGG, RAW or ASF encapsulation. Saving to a file can be done using any encapsulation format compatible with the chosen codecs.

(See <xref linkend="smc" endterm="tsmc" />)

Wizard encapsulation method

Streaming options

If you chose to Stream to network you can now specify several options.

• Time To Live (TTL) This sets the numbers of routers your stream can go through, for UDP unicast and unicast access methods. If you do not know what this means, you should leave the default value. Note: With UDP multicast, the default TTL is set to 1, meaning that your stream won't get accross any router. You may want to increase it if you want to route your multicast stream.
• SAP Announce To advertise your stream over the network when using the UDP streaming method, using the SAP protocol, enter the name of the stream in the text input and check the checkbox. This is NOT available for the HTTP streaming method.

Wizard streaming options

Save to file destination

If you chose Transcode/Save to file you can now specify the file you want to save the stream to.

Wizard save file - wxWindows interface

You can now select the Finish button to start streaming/converting the source.

Streaming using the GUI

<sect2><title>Introduction</title>

<para>A second way to set up a streaming instance using VLC is using <emphasis>Stream Output</emphasis> panel in the <emphasis>Open...</emphasis> dialog of the wxWindows (Windows / GNU Linux), skinnable (Windows / GNU Linux) and MacOS X interfaces. Streaming methods and options used 99% of time should be available in this panel.</para>

<para>To stream the opened media, check the "Stream output" checkbox in the "Open File/Disc/Network Stream/Capture Device" dialog and click on the "Settings" button.</para>

<mediaobject>

 <imageobject>
   <imagedata fileref="images/streaming-howto/intf-wx-open-file.jpg" format="JPG" />
 </imageobject>
 <textobject><para>Open file dialog - wxWindows interface</para></textobject>
 <para>Open file dialog - wxWindows interface</para>

</mediaobject>

<mediaobject>

 <imageobject>
   <imagedata fileref="images/streaming-howto/intf-osx-open-file.jpg" format="JPG" />
 </imageobject>
 <textobject><para>Open file dialog - Mac OS X interface</para></textobject>
 <para>Open file dialog - Mac OS X interface</para>

</mediaobject>

</sect2>

<sect2><title>The Stream Output dialog</title>

<mediaobject>

 <imageobject>
   <imagedata fileref="images/streaming-howto/intf-wx-stream-output.jpg" format="JPG" />
 </imageobject>
 <textobject><para>Stream output dialog - wxWindows interface</para></textobject>
 <para>Stream output dialog - wxWindows interface</para>

</mediaobject>

<mediaobject>

 <imageobject>
   <imagedata fileref="images/streaming-howto/intf-osx-stream-output.jpg" format="JPG" />
 </imageobject>
 <textobject><para>Stream output dialog - wxWindows interface</para></textobject>
 <para>Stream output dialog - wxWindows interface</para>

</mediaobject>

<sect3><title>Stream Output MRL</title>

<para>On the wxWindows interface, a text box displays the <emphasis>Stream Output MRL</emphasis> (Media Ressource Locator). This is updated as you change options in the Stream output dialog. For more information on how to edit the <emphasis>Stream Output MRL</emphasis> read <xref linkend="cmdline" endterm="tcmdline" />.</para>

</sect3>

<sect3><title>Output methods</title>

<itemizedlist>

<listitem><para> <emphasis>Play localy</emphasis>: display the stream on your screen. This allows to display the stream you are actually streaming. Effects of transcoding, rescaling, etc... can be monitored locally using this function. </para></listitem>

<listitem><para><emphasis>File</emphasis>: Save the stream to a file. The <emphasis>Dump raw input</emphasis> option allows to save the input stream as it read by VLC, without any processing. </para></listitem>

<listitem><para> <emphasis>HTTP</emphasis>: Use the HTTP streaming method. Specify the IP address and TCP port number on which to listen. </para></listitem>

<listitem><para> <emphasis>MMSH</emphasis>: This access method allows to stream to Microsoft Windows Media Player. Specify the IP address and TCP port number on which to listen. </para>

<note><para>This will only work with the <emphasis>ASF</emphasis> enacpsulation method.</para></note>

</listitem>

<listitem><para> <emphasis>UDP</emphasis>: Stream in unicast by providing an address in the 0.0.0.0 - 223.255.255.255 range or in multicast by providing an address in the 224.0.0.0 - 239.255.255.255 range. It is also possible to stream to IPv6 addresses. </para>

<note><para>This will only work with the <emphasis>TS</emphasis> encapsulation method.</para></note>

</listitem>

<listitem><para> <emphasis>RTP</emphasis>: Use the Real-Time Transfer Protocol. Like UDP, it can use both unicast and multicast addresses. </para></listitem>

</itemizedlist>

<note><para>UDP, HTTP, MMSH and RTP methods require to select the <emphasis>Stream</emphasis> option on the MacOS X interface</para></note>

<para>(See <xref linkend="smc" endterm="tsmc" />)</para>

</sect3>

<sect3><title>Encapsulation method</title>

<para>Select an encapsulation method that fits the codecs and access method of your stream, among MPEG TS, MPEG PS, MPEG 1, OGG, Raw, ASF, AVI, MP4 and MOV. (See <xref linkend="smc" endterm="tsmc" />)</para>

</sect3>

<sect3><title>Transcoding options</title>

<para>Enable video transcoding by checking the "Video Codec" checkbox. Choose a codec from the list. You can also specify an average bitrate and scale the input. (See <xref linkend="smc" endterm="tsmc" />)</para>

<para>Enable audio transcoding by checking the "Audio Codec" checkbox. Choose a codec from the list. You can also specify an average bitrate and the number of audio channels to encode. (See <xref linkend="smc" endterm="tsmc" />)</para>

</sect3>

<sect3><title>Miscellaneous options</title>

<para>Select methods to announce your stream. You can use SAP (Service Announce Protocol) or SLP (Service Location Protocol). You must also specify a channel name. The Mac OS X interface also allows you to export the description (SDP) file of a RTP session using the internal HTTP or RTSP server of VLC, or as a file. This can be done using the according checkboxes. The <emphasis>SDP URL</emphasis> text box allows to give the url or destination where the SDP file will be available.</para>

</sect3></sect2></sect1>

</chapter>

This page is part of official VLC media player Documentation (User Guide • Streaming HowTo • Hacker Guide • Modules)
Please read the Documentation Editing Guidelines before you edit the documentation

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.