Blinker

Tree: 145f2b9
145f2b998a952e2e24121330189e091d84def84b
Stefan Schuermans implemented loveletter module

Stefan Schuermans authored 12 years ago

 
1) <html>
2)   <head>
3)     <title>Blinker - Loveletter</title>
4)   </head>
5)   <body>
6)     <h1>Blinker - Loveletter</h1>
7)     <p>
8)       The loveletter module plays Blinken movies on demand.
9)       An operator connection is used to submit a movie number
10)       (prefixed with a star and followed by ahash, e.g. <code>*123#</code>).
11)       The movie with this number will then be played until another
Stefan Schuermans clarified operator connecti...

Stefan Schuermans authored 12 years ago

 
12)       number is requested or the connection is closed (either by the
13)       remote side or using <code>*#</code>).
Stefan Schuermans implemented loveletter module

Stefan Schuermans authored 12 years ago

 
14)     </p>
15)     <h2>Configuration</h2>
16)     <p>
17)       The configuration of the loveletter module with name <code>NAME</code>
18)       is located in the <code>loveletters/NAME</code> subdirectory.
19)     </p>
Stefan Schuermans clarified operator connecti...

Stefan Schuermans authored 12 years ago

 
20)     <h3>Sound File</h3>
21)     <p>
22)       While an operator is connected to the loveletter module (e.g. via
23)       a phone connection), a sound file can be requested to be played.
24)       (In case of the phone connection, this file is located on the
25)       phone server.)
26)       The name of the sound to request is contained in the file
27)       <code>sound</code>.
28)       If this file does not exists, no sound is requested to be played.
29)     </p>
Stefan Schuermans implemented loveletter module

Stefan Schuermans authored 12 years ago

 
30)     <h3>Movies</h3>
31)     <p>
32)       The movies available for on-demand play are located in the subdirectory
33)       <code>movies</code>.
34)       The movie number is derived from the filename by leaving out all
35)       non-digit characters.
36)       Please make sure that there are not two different movies with the
37)       same derived number (e.g. <code>123.bml</code> and <code>123.bbm</code>.
38)     </p>
39)     <h3>Output Stream</h3>
40)     <p>
41)       The file <code>outstream</code> contains the name of the stream to
42)       send the frames to.
43)     </p>
44)     <h3>Halt Stream</h3>
45)     <p>
46)       The playing movie can be halted whenever another stream is active.
47)       Therefore, the name of the other stream is written to the file
48)       <code>haltstream</code>.
49)       When the halt stream becoms active, the current frame is frozen,
50)       i.e. the frame is kept.
51)       When the halt stream ends, the movie resumes with the remaining
52)       time for the current frame and continues as usual afterwards.
53)       <br>
54)       If this feature is not needed, the file <code>haltstream</code>
55)       should not exist.
56)     </p>
Stefan Schuermans rename "module" to "target"

Stefan Schuermans authored 5 years ago

 
57)     <h2>Operator Connection Interface</h2>
58)     <p>
59)     The name of the operator connection interface provided by this module
60)     is the module name, i.e., <code>loveletters/NAME</code>.
61)     </p>