doc/loveletter.html (145f2b9) - Blinker · BlinkenArea

loveletter.html

<html>
  <head>
    <title>Blinker - Loveletter</title>
  </head>
  <body>
    <h1>Blinker - Loveletter</h1>
    <p>
      The loveletter module plays Blinken movies on demand.
      An operator connection is used to submit a movie number
      (prefixed with a star and followed by ahash, e.g. <code>*123#</code>).
      The movie with this number will then be played until another
      number is requested or the connection is closed (either by the
      remote side or using <code>*#</code>).
    </p>
    <h2>Configuration</h2>
    <p>
      The configuration of the loveletter module with name <code>NAME</code>
      is located in the <code>loveletters/NAME</code> subdirectory.
    </p>
    <h3>Sound File</h3>
    <p>
      While an operator is connected to the loveletter module (e.g. via
      a phone connection), a sound file can be requested to be played.
      (In case of the phone connection, this file is located on the
      phone server.)
      The name of the sound to request is contained in the file
      <code>sound</code>.
      If this file does not exists, no sound is requested to be played.
    </p>
    <h3>Movies</h3>
    <p>
      The movies available for on-demand play are located in the subdirectory
      <code>movies</code>.
      The movie number is derived from the filename by leaving out all
      non-digit characters.
      Please make sure that there are not two different movies with the
      same derived number (e.g. <code>123.bml</code> and <code>123.bbm</code>.
    </p>
    <h3>Output Stream</h3>
    <p>
      The file <code>outstream</code> contains the name of the stream to
      send the frames to.
    </p>
    <h3>Halt Stream</h3>
    <p>
      The playing movie can be halted whenever another stream is active.
      Therefore, the name of the other stream is written to the file
      <code>haltstream</code>.
      When the halt stream becoms active, the current frame is frozen,
      i.e. the frame is kept.
      When the halt stream ends, the movie resumes with the remaining
      time for the current frame and continues as usual afterwards.
      <br>
      If this feature is not needed, the file <code>haltstream</code>
      should not exist.
    </p>
    <h2>Operator Connection Interface</h2>
    <p>
    The name of the operator connection interface provided by this module
    is the module name, i.e., <code>loveletters/NAME</code>.
    </p>
  </body>
</html>

Blinker

rename "module" to "target"