The sync filter.
[paraslash.git] / m4 / gengetopt / sync_filter.m4
1 args "--no-version --no-help"
2
3 purpose "Synchronize playback between multiple clients."
4
5 option "buddy" b
6 #~~~~~~~~~~~~~~~
7 "host to synchronize with"
8 multiple
9 string typestr = "url"
10 optional
11 details = "
12 This option may be given multiple times, one per buddy. Each
13 value may be given as a host, port pair in either IPv4 or
14 IPv6 form, with port being optional. If no port was specified
15 the listening port (as specified with --port, see below)
16 is used to send the synchronization packet to this buddy.
17 "
18
19 option "port" p
20 #~~~~~~~~~~~~~~
21 "UDP port for incoming synchronization packets"
22 int typestr = "portnumber"
23 default = "29900"
24 optional
25 details = "
26 The sync filter receives incoming synchronization packets on
27 this UDP port.
28 "
29
30 option "timeout" t
31 #~~~~~~~~~~~~~~~~~
32 "how long to wait for other clients"
33 int typestr = "milliseconds"
34 default = "2000"
35 optional
36 details = "
37 Once the sync filter receives its first chunk of input, a
38 synchronization period of the given number of milliseconds
39 begins. Playback is deferred until a synchronization packet
40 has been received from each defined buddy, or until the end
41 of the period. Buddies which did not send a synchronization
42 packet in time are temporarily disabled and are not waited for
43 during subsequent synchronization periods. They are re-enabled
44 automatically when another synchronization packet arrives.
45 "