e8375e8a8e703a7af8f811696ae2ec3c4202553c
[vlc.git] / doc / vlm.txt
1 VLM: VideoLAN (Media) Manager
2
3 VLM is a little media manager originally designed to launch multiple
4 streams with only one VLC.
5
6 I - Interfaces
7  1) Telnet interface
8     You can launch it as a common interface.
9     Default port is 4212, default password is "admin". These are common
10     options of the interface, so you can modify them as you wish.
11     Once you are connected on telnet interface, just type a command
12     line.
13
14  2) HTTP interface
15     Not finished yet. Please be a little more patient !
16
17 II - VLM Elements
18  1) Medias
19     A media is composed with a list of inputs (the videos and audios you
20     want to stream), an output (where you want to stream them), and some
21     options.
22     There are two types of medias: vod and broadcast.
23     A vod media is commonly used for Video on Demand. It can be launched
24     only if a vod client asks for it.
25     A broadcast media is very close to a TV program, or channel: it is
26     launched, stopped, paused by the administrator (or a schedule), may
27     be repeated several times etc.
28
29  2) Schedules
30     A Schedule is a script with a date. When the current date is the
31     schedule date, the script is launched. There are of course other
32     options, like a period, a number of repetitions, etc. for the
33     schedule to be launched several times (or endlessly) automatically.
34
35 III - Command line syntax:
36 Note: an element is a media or a schedule.
37  1) Command lines:
38     help
39         Displays an exhaustive commmand lines list.
40
41     new (name) vod|broadcast|schedule [properties]
42         Creates a new element. You must specify if it as a vod media, a
43         broadcast media, or a schedule (there is no default type).
44         "media" and "schedule" are reserved names, and element names
45         must be unique.
46         Properties are optional: you can use the "setup" command to set
47         it.
48     setup (name) (properties)
49         Set the property of the (name) element.
50         See Properties section for more information.
51     show [(name)|media|schedule]
52         Displays current element states and configurations.
53         "show (name)" displays all information about the (name) element.
54         "show media" displays a summary of medias states.
55         "show schedule" displays a summary of schedules states.
56         "show" is a the same as "show media show schedule".
57     del (name)|all|media|schedule
58         Destroys an element, or a group of elements. If the element is
59         at a non-stop state, it stops it (media or schedule).
60         "del (name)" destroys the (name) element.
61         "del all" destroys all elements.
62         "del media" destroys all medias.
63         "del schedule" destroys all schedules.
64     control (name) [instance_name] (command)
65         Changes the state of the (instance_name) instance of (name) media.
66         If (instance_name) is not specified, the control command affects the
67         default instance.
68         See Commands section for more information.
69     save (config_file)
70         Saves all media and schedule configurations in the (config_file)
71         configuration file. the "save" command overwrites the file if it
72         already exists. States (playing, paused, stop) are not saved.
73         See Configuration File section for more information.
74     load (config_file)
75         Loads the (config_file) configuration file.
76         See Configuration File section for more information.
77
78  2) Properties:
79  Note: except the "append" property, all property can be followed by
80  another one, recursively.For example:
81  "setup pouet input file://arf.avi output udp:127.0.0.1 enabled loop"
82  is a valid command line.
83     Media Properties Syntax:
84         input (input_name)
85             Adds (input_name) at the end of the media input list.
86         inputdel (input_name)|all
87             Deletes (input_name) or all items from the media input list.
88         inputdeln (input_number)
89             Deletes the item #(input_number) from the media input list.
90         output (output_name)
91             Defines the output of the media.
92             The syntax is equivalent to the ":sout=..." option , but you
93             do not have to put the ":sout=" string.
94         option (option_name)[=value]
95             Adds the (option_name) to the media option list.
96             The syntax is equivalent to the ":(option)=..." option , but you
97             do not have to put the ":" string.
98             Options are global: they are applied to all inputs of the
99             media.
100         enabled|disabled
101             Enable or Disable the media.
102             If a media is disabled, it can not be streamed, paused,
103             launched by a schedule, or played as a VoD.
104         loop|unloop
105             Used for broadcast only.
106             If a media with "loop" option receives the "play" command
107             and finally finishes to play the last input of the list, it
108             will automatically restart to play the input list.
109         mux (mux_name)
110             Used for vod only.
111             Only needs to be specified if you want the elementary streams
112             to be sent encapsulated instead of raw. The (mux_name) should be
113             a fourcc describing the encapsulation type (eg. mp2t for MPEG TS,
114             or mp2t for MPEG PS).
115
116     Schedule Properties Syntax:
117         enabled|disabled
118             A disabled schedule will never be launched.
119         append (command)
120             Adds a command to the command line list.
121             The command line can be every command the VLM can understand.
122             Note: the rest of the line will be considered as part of the
123             command line. You cannot put another option after the
124             "append" one.
125         date (year)/(month)/(day)-(hour):(minutes):(seconds)|now
126             Specifies the first date the schedule should be launched.
127             the date must have the explicit form:
128             (year)/(month)/(day)-(hour):(minutes):(seconds)
129             For example: 2004/03/07-12:42:30
130             If you write "now" instead of a date, the schedule will be
131             launch as soon as possible (as soon as it is enabled), and
132             the current date will be used as the first date of the
133             schedule (for repeating).
134         period (years)/(months)/(days)-(hours):(minutes):(seconds)
135             Specifies the period of time a schedule must wait for
136             launching itself another time.
137             For now, the period has a very close syntax to a date:
138             months are considered as 30 days
139             years are considered as 12 months.
140             If a period is specified without a "repeat", it will be
141             launched endlessly.
142         repeat (number_of_repetitions)
143             Specifies the number of times the schedule has to be launch
144             again. For example, if a schedule has "repeat 3", it will be
145             launched 4 times.
146
147  3) Control Commands Syntax:
148     play
149         Starts a broadcast media. The media begins to launch the first
150         item of the input list, then launches the next one, and so on
151         (like a playlist).
152     pause
153         Puts the broadcast media in paused status.
154     stop
155         Stops the broadcast media.
156     seek (percentage)
157         Seeks in the current playing item of input list.
158
159 IV - The configuration file
160   A VLM configuration file is very simple: it is only a list of command
161   lines: one line corresponds to one command line.
162   If you want to create a configuration file, just edit a text file and
163   type a list of VLM command lines. But beware of recursive calls: you
164   can put a "load (file)" command in a configuration file, so for
165   example, if you put a "load pouet" in a pouet file, and you launch the
166   "load pouet" command, then pouet will be loaded endlessly, and VLC
167   will crash (at least).
168   The load command converts the medias and schedules configurations into
169   command lines, and writes them into a file.
170   Any line where the first non white space character is a '#' is considered
171   as a comment.