Documentation:Streaming HowTo/VLM - Revision history

DoesItReallyMatter: /* Configuration Files */ Set page anchor: "vlm.conf"

2019-05-22T03:04:13Z

Configuration Files: Set page anchor: "vlm.conf"

← Older revision		Revision as of 03:04, 22 May 2019
Line 89:		Line 89:
	*'''seek (percentage)''': Seek in the current playing item of the input list.		*'''seek (percentage)''': Seek in the current playing item of the input list.

	===Configuration Files===		===<span id="vlm.conf"></span> Configuration Files===

	A VLM configuration file is a list of command lines : one line corresponds to one command line.		A VLM configuration file is a list of command lines : one line corresponds to one command line.

DoesItReallyMatter: Fix hyperlinks. This page was copied from old doc: https://web.archive.org/web/20050408074655/https://www.videolan.org/doc/streaming-howto/en/ch05.html

2019-04-24T05:22:07Z

Fix hyperlinks. This page was copied from old doc: https://web.archive.org/web/20050408074655/https://www.videolan.org/doc/streaming-howto/en/ch05.html

DoesItReallyMatter: Fix broken link, +{{Outdated}}

2019-04-24T05:02:11Z

Fix broken link, +{{Outdated}}

← Older revision		Revision as of 05:02, 24 April 2019
Line 1:		Line 1:
			{{Outdated}}
	{{RightMenu\|documentation streaming howto toc}}		{{RightMenu\|documentation streaming howto toc}}

Line 16:		Line 17:
	The telnet interface can also be launched in the wxWindows interface:		The telnet interface can also be launched in the wxWindows interface:

	~~http~~://~~www~~.videolan.org/~~doc~~/~~streaming-howto/en/images~~/streaming-howto/intf-wx-extraintf-telnet.jpg Launching the Telnet interface - wxWindows interface		https://images.videolan.org/images/documentation/streaming-howto/intf-wx-extraintf-telnet.jpg<!--Alt text: Launching the Telnet interface - wxWindows interface-->

	The default port is 4212. The default password is "admin". These can be changed using '''--telnet-port <integer>''' and '''--telnet-password <string>''' command line options. They can also be changed in the preferences panel when using the wxWindows interface in the ''Modules''->''interface''->''telnet'' section (check the ''Advanced options'' checkbox).		The default port is 4212. The default password is "admin". These can be changed using '''--telnet-port <integer>''' and '''--telnet-password <string>''' command line options. They can also be changed in the preferences panel when using the wxWindows interface in the ''Modules''->''interface''->''telnet'' section (check the ''Advanced options'' checkbox).

DoesItReallyMatter: +:Category:VLMa

2019-02-06T04:07:47Z

+Category:VLMa

← Older revision		Revision as of 04:07, 6 February 2019
Line 168:		Line 168:

	{{Documentation}}		{{Documentation}}

			[[Category:VLMa]]

DoesItReallyMatter: nn

2014-11-09T23:42:05Z

← Older revision		Revision as of 23:42, 9 November 2014
Line 79:		Line 79:
	*'''date (year)/(month)/(day)-(hour):(minutes):(seconds)\|now''': Specify the first date the schedule should be launched. You can specify a date using the '''(year)/(month)/(day)-(hour):(minutes):(seconds)''' format (example: 2004/11/16-00:43:12) or using the '''now''' keyword. If '''now''' is used, the schedule will be launched as soon as possible (i.e. as soon as it is enabled) and the current date will be used as the first date of the schedule.		*'''date (year)/(month)/(day)-(hour):(minutes):(seconds)\|now''': Specify the first date the schedule should be launched. You can specify a date using the '''(year)/(month)/(day)-(hour):(minutes):(seconds)''' format (example: 2004/11/16-00:43:12) or using the '''now''' keyword. If '''now''' is used, the schedule will be launched as soon as possible (i.e. as soon as it is enabled) and the current date will be used as the first date of the schedule.
	*'''period (years_aka_12_months)/(months_aka_30_days)/(days)-(hours):(minutes):(seconds)''': Specify the period of time a schedule must wait for launching itself another time. (Months are considered as 30 days, Years as 12 months) If a period is specified without a '''repeat''' property, the schedule will be launched endlessly.		*'''period (years_aka_12_months)/(months_aka_30_days)/(days)-(hours):(minutes):(seconds)''': Specify the period of time a schedule must wait for launching itself another time. (Months are considered as 30 days, Years as 12 months) If a period is specified without a '''repeat''' property, the schedule will be launched endlessly.
	*'''repeat (number_of_repetitions)''': Specify the number of times the schedule will be launched again. For example, if a schedule has '''repeat 11''' it will be launched 12 times.		*'''repeat (number_of_repetitions)''': Specify the number of times the schedule will be launched again. For example, if a schedule has '''repeat 11''' it will be launched 12 times.

	====Control Commands====		====Control Commands====
Line 97:		Line 97:
	% '''vlc -I telnet --vlm-conf vlm.conf'''		% '''vlc -I telnet --vlm-conf vlm.conf'''

	As of versions > 0.8.1, any line where the first non ~~white space~~ character is a # is considered as a comment.		As of versions > 0.8.1, any line where the first non whitespace character is a # is considered as a comment.

	==Examples==		==Examples==

Infogulch: split --rtsp-port from --rtsp-host. --rtsp-host no longer infers port

2012-05-25T00:03:09Z

split --rtsp-port from --rtsp-host. --rtsp-host no longer infers port

← Older revision		Revision as of 00:03, 25 May 2012
Line 135:		Line 135:

	First launch the vlc		First launch the vlc
	% '''vlc --ttl 12 -vvv --color -I telnet --telnet-password videolan --rtsp-host 0.0.0.0:554'''		% '''vlc --ttl 12 -vvv --color -I telnet --telnet-password videolan --rtsp-host 0.0.0.0 --rtsp-port 554'''
	where:		where:
	*'''12''' is the value of the TTL (Time To Live) of your IP packets (which means that the stream will be able to cross 11 routers).		*'''12''' is the value of the TTL (Time To Live) of your IP packets (which means that the stream will be able to cross 11 routers).

Jpark: /* Basic example */

2010-10-28T17:15:16Z

Basic example

← Older revision		Revision as of 17:15, 28 October 2010
Line 135:		Line 135:

	First launch the vlc		First launch the vlc
	% '''vlc --ttl 12 -vvv --color -I telnet --telnet-password videolan --rtsp-host 0.0.0.0:~~5554~~'''		% '''vlc --ttl 12 -vvv --color -I telnet --telnet-password videolan --rtsp-host 0.0.0.0:554'''
	where:		where:
	*'''12''' is the value of the TTL (Time To Live) of your IP packets (which means that the stream will be able to cross 11 routers).		*'''12''' is the value of the TTL (Time To Live) of your IP packets (which means that the stream will be able to cross 11 routers).
Line 141:		Line 141:
	*'''videolan''' is the password to connect to the telnet interface.		*'''videolan''' is the password to connect to the telnet interface.
	*'''0.0.0.0''' is the host address.		*'''0.0.0.0''' is the host address.
	*'''~~5554~~''' is the port on which you stream.		*'''554''' is the port on which you stream.

	Then you connect to the vlc telnet interface and create the vod object.		Then you connect to the vlc telnet interface and create the vod object.
Line 150:		Line 150:
	setup Test input my_video.mpg		setup Test input my_video.mpg
	You can access to the stream with:		You can access to the stream with:
	% '''vlc rtsp://server:~~5554~~/Test'''		% '''vlc rtsp://server:554/Test'''
	where:		where:
	* '''server''' is the address of the streaming server (IP or DNS)		* '''server''' is the address of the streaming server (IP or DNS)

Linkfanel: /* Video On Demand */

2010-05-10T05:04:20Z

Video On Demand

@@ Line 153: / Line 153: @@
 where:
 * '''server''' is the address of the streaming server (IP or DNS)
 {{Documentation}}

Firehair: /* Basic example */

2010-01-11T18:12:40Z

Basic example

← Older revision		Revision as of 18:12, 11 January 2010
Line 143:		Line 143:
	*'''5554''' is the port on which you stream.		*'''5554''' is the port on which you stream.

	Then you connect to the vlc telnet interface and create the vod object		Then you connect to the vlc telnet interface and create the vod object.
			You can connect to vlc telnet interface by use the terminal.
			% '''telnet localhost 4212'''
			and create the vod object.
	new Test vod enabled		new Test vod enabled
	setup Test input my_video.mpg		setup Test input my_video.mpg

Thehtoad: /* Configuration Files */ spelling

2010-01-04T23:41:44Z

Configuration Files: spelling

← Older revision		Revision as of 23:41, 4 January 2010
Line 92:		Line 92:
	A VLM configuration file is a list of command lines : one line corresponds to one command line.		A VLM configuration file is a list of command lines : one line corresponds to one command line.

	To create a configuration file, just edit a text file and type a list of VLM commands. Beware of recursive calls: you an put a '''load (file)''' in a configuration file which can lead to recursive inclusion of the same file and result in VLC's crash.		To create a configuration file, just edit a text file and type a list of VLM commands. Beware of recursive calls: you can put a '''load (file)''' in a configuration file which can lead to recursive inclusion of the same file and result in VLC's crash.

	You can automatically load a VLM configuration when launching VLC with the --vlm-conf <vlm conf filename> command line option. The minimal command to make that work is:		You can automatically load a VLM configuration when launching VLC with the --vlm-conf <vlm conf filename> command line option. The minimal command to make that work is:

← Older revision		Revision as of 05:22, 24 April 2019
Line 49:		Line 49:
	*'''help''': Displays an exhaustive command lines list		*'''help''': Displays an exhaustive command lines list
	*'''new (name) vod\|broadcast\|schedule [properties]''': Create a new vod, broadcast or schedule element. Element names must be unique and cannot be "media" or "schedule". You can specify properties in this command line or later on by using the '''setup''' command.		*'''new (name) vod\|broadcast\|schedule [properties]''': Create a new vod, broadcast or schedule element. Element names must be unique and cannot be "media" or "schedule". You can specify properties in this command line or later on by using the '''setup''' command.
	*'''setup (name) (properties)''': Set an elements property. See ~~<xref linkend="vlmprop" endterm="tvlmprop" />~~.		*'''setup (name) (properties)''': Set an elements property. See [[#Media Properties]].
	*'''show [(name)\|media\|schedule]''': Display current element states and configurations.		*'''show [(name)\|media\|schedule]''': Display current element states and configurations.
	**'''show (name)''': Specify an element's name to show all information concerning this element.		**'''show (name)''': Specify an element's name to show all information concerning this element.
Line 59:		Line 59:
	**'''del media''': Delete all media elements.		**'''del media''': Delete all media elements.
	**'''del schedule''': Delete all schedule elements.		**'''del schedule''': Delete all schedule elements.
	*'''control (name) [instance_name] (command)''': Change the state of the (instance_name) instance of the (name) media. If (instance_name) isn't specified, the control command affects the default instance. See ~~<xref linkend="vlmctrl" endterm="tvlmctrl" />~~ for available control commands.		*'''control (name) [instance_name] (command)''': Change the state of the (instance_name) instance of the (name) media. If (instance_name) isn't specified, the control command affects the default instance. See [[#Control Commands]] for available control commands.
	*'''save (config_file)''': Save all media and schedule configurations in the specified config file. The config file path is relative to the directory in which vlc was launched. If the file exists it will be overwritten. Note that states, such as playing, paused or stop, are not saved. See ~~<xref linkend="vlmconf" endterm="tvlmconf" />~~ for more info.		*'''save (config_file)''': Save all media and schedule configurations in the specified config file. The config file path is relative to the directory in which vlc was launched. If the file exists it will be overwritten. Note that states, such as playing, paused or stop, are not saved. See [[#Configuration Files]] for more info.
	*'''load (config_file)''': Load a configuration file. The config file path is relative to the directory in which vlc was launched. See ~~<xref linkend="vlmconf" endterm="tvlmconf"/>~~ for more info.		*'''load (config_file)''': Load a configuration file. The config file path is relative to the directory in which vlc was launched. See [[#Configuration Files]] for more info.

	====Media Properties====		====Media Properties====
Line 68:		Line 68:

	*'''input (input_name)''': Add an input to the end of the media's input list.		*'''input (input_name)''': Add an input to the end of the media's input list.
	*'''output (output_name)''': Define the media's output. The syntax is the same as the vlc ":sout=..." vlc option but you do not have to put the ":sout=..." string. See ~~<xref linkend="cmdline" endterm="tcmdline"~~ /> for more information concerning stream outputs (sout). Note: You do not have to specify an output for vod elements.		*'''output (output_name)''': Define the media's output. The syntax is the same as the vlc ":sout=..." vlc option but you do not have to put the ":sout=..." string. See [[Documentation:Streaming HowTo/Advanced Streaming Using the Command Line]] for more information concerning stream outputs (sout). Note: You do not have to specify an output for vod elements.
	*'''option (option_name)[=value]''' : Adds the (option_name) to the media option list. The syntax is equivalent to the ":(option)=..." option , but you do not have to put the ":" string. Options are global: they are applied to all inputs of the media.		*'''option (option_name)[=value]''' : Adds the (option_name) to the media option list. The syntax is equivalent to the ":(option)=..." option , but you do not have to put the ":" string. Options are global: they are applied to all inputs of the media.
	*'''enabled\|disabled''': Enable or Disable the media. If a media is disabled, it cannot be streamed, paused, launched by a schedule, or played as VoD.		*'''enabled\|disabled''': Enable or Disable the media. If a media is disabled, it cannot be streamed, paused, launched by a schedule, or played as VoD.
	*'''loop\|unloop (broadcast only)''': If a media with the "loop" option receives the "play" command, it will automatically restart to play the input list once the end of the input list is reached. Note: '''loop\|unloop''' is only used for broadcast media types.		*'''loop\|unloop (broadcast only)''': If a media with the "loop" option receives the "play" command, it will automatically restart to play the input list once the end of the input list is reached. Note: '''loop\|unloop''' is only used for broadcast media types.
	*'''mux (mux_name)''': This option should only be specified if you want the elementary streams to be sent encapsulated instead of raw. The (mux_name) should be specified as a four characters length identifier such as mp2t for MPEG TS or mp2p for MPEG PS. See ~~<xref linkend="smc" endterm="tsmc"~~ />. Note: The '''mux''' property is only used for vod media types.		*'''mux (mux_name)''': This option should only be specified if you want the elementary streams to be sent encapsulated instead of raw. The (mux_name) should be specified as a four characters length identifier such as mp2t for MPEG TS or mp2p for MPEG PS. See [[Documentation:Streaming HowTo/Streaming, Muxers and Codecs]]. Note: The '''mux''' property is only used for vod media types.

	====Schedule Properties====		====Schedule Properties====