git.sesse.net Git - vlc/blob - 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) (command)
  65         Changes the state of the (name) media.
  66         See Commands section for more information.
  67     save (config_file)
  68         Saves all media and schedule configurations in the (config_file)
  69         configuration file. the "save" command overwrites the file if it
  70         already exists. States (playing, paused, stop) are not saved.
  71         See Configuration File section for more information.
  72     load (config_file)
  73         Loads the (config_file) configuration file.
  74         See Configuration File section for more information.
  75
  76  2) Properties:
  77  Note: except the "append" property, all property can be followed by
  78  another one, recursively.For example:
  79  "setup pouet input file://arf.avi output udp:127.0.0.1 enabled loop"
  80  is a valid command line.
  81     Media Properties Syntax:
  82         input (input_name)
  83             Adds (input_name) at the end of the media input list.
  84         output (output_name)
  85             Defines the output of the media.
  86             The syntax is equivalent to the ":sout=..." option , but you
  87             do not have to put the ":sout=" string.
  88         option (option_name)[=value]
  89             Adds the (option_name) to the media option list.
  90             The syntax is equivalent to the ":(option)=..." option , but you
  91             do not have to put the ":" string.
  92             Options are global: they are applied to all inputs of the
  93             media.
  94         enabled|disabled
  95             Enable or Disable the media.
  96             If a media is disabled, it can not be streamed, paused,
  97             launched by a schedule, or played as a VoD.
  98         loop|unloop
  99             Used for broadcast only.
 100             If a media with "loop" option receives the "play" command
 101             and finally finishes to play the last input of the list, it
 102             will automatically restart to play the input list.
 103
 104     Schedule Properties Syntax:
 105         enabled|disabled
 106             A disabled schedule will never be launched.
 107         append (command)
 108             Adds a command to the command line list.
 109             The command line can be every command the VLM can understand.
 110             Note: the rest of the line will be considered as part of the
 111             command line. You cannot put another option after the
 112             "append" one.
 113         date (year)/(month)/(day)-(hour):(minutes):(seconds)|now
 114             Specifies the first date the schedule should be launched.
 115             the date must have the explicit form:
 116             (year)/(month)/(day)-(hour):(minutes):(seconds)
 117             For example: 2004/03/07-12:42:30
 118             If you write "now" instead of a date, the schedule will be
 119             launch as soon as possible (as soon as it is enabled), and
 120             the current date will be used as the first date of the
 121             schedule (for repeating).
 122         period (years)/(months)/(days)-(hours):(minutes):(seconds)
 123             Specifies the period of time a schedule must wait for
 124             launching itself another time.
 125             For now, the period has a very close syntax to a date:
 126             months are considered as 30 days
 127             years are considered as 12 months.
 128             If a period is specified without a "repeat", it will be
 129             launched endlessly.
 130         repeat (number_of_repetitions)
 131             Specifies the number of times the schedule has to be launch
 132             again. For example, if a schedule has "repeat 3", it will be
 133             launched 4 times.
 134
 135  3) Control Commands Syntax:
 136     play
 137         Starts a broadcast media. The media begins to launch the first
 138         item of the input list, then launches the next one, and so on
 139         (like a playlist).
 140     pause
 141         Puts the broadcast media in paused status.
 142     stop
 143         Stops the broadcast media.
 144     seek (percentage)
 145         Seeks in the current playing item of input list.
 146
 147 IV - The configuration file
 148   A VLM configuration file is very simple: it is only a list of command
 149   lines: one line corresponds to one command line.
 150   If you want to create a configuration file, just edit a text file and
 151   type a list of VLM command lines. But beware of recursive calls: you
 152   can put a "load (file)" command in a configuration file, so for
 153   example, if you put a "load pouet" in a pouet file, and you launch the
 154   "load pouet" command, then pouet will be loaded endlessly, and VLC
 155   will crash (at least).
 156   The load command converts the medias and schedules configurations into
 157   command lines, and writes them into a file.
 158   Note: commentary system has not been implement yet.