m4/lls/recv_cmd.suite.m4

   1 [suite recv_cmd]
   2 caption = receivers
   3 [subcommand afh]
   4         purpose = make an audio stream from a local file
   5         [description]
   6                 The afh (audio format handler) receiver extracts selected parts of
   7                 the given audio file without decoding the file. Only complete chunks
   8                 with respect to the underlying audio format are extracted.
   9         [/description]
  10         [option filename]
  11                 short_opt = f
  12                 summary = file to open
  13                 typestr = filename
  14                 arg_info = required_arg
  15                 arg_type = string
  16         [option begin-chunk]
  17                 short_opt = b
  18                 summary = skip the beginning of the file
  19                 typestr = chunk_num
  20                 arg_info = required_arg
  21                 arg_type = int32
  22                 [help]
  23                         The argument must be an integer between -num_chunks and num_chunks -
  24                         1, inclusively, where num_chunks is the total number of chunks. If
  25                         chunk_num is negative, the given number of chunks are counted backwards
  26                         from the end of the file. For example --begin-chunk -100 instructs
  27                         the afh receiver to start at chunk num_chunks - 100. This is useful
  28                         for cutting off the beginning of an audio file.
  29                 [/help]
  30         [option end-chunk]
  31                 short_opt = e
  32                 summary = only write up to chunk chunk_num
  33                 typestr = chunk_num
  34                 arg_info = required_arg
  35                 arg_type = int32
  36                 [help]
  37                         For the chunk_num argument the same rules as for --begin-chunk
  38                         apply. The default is to write up to the last chunk.
  39                 [/help]
  40         [option just-in-time]
  41                 short_opt = j
  42                 summary = use timed writes
  43                 [help]
  44                         Write the specified data chunks 'just in time', i.e., delay the write
  45                         until data is needed by the decoder/player for an uninterrupted audio
  46                         stream. This may be useful for third-party software.
  47                 [/help]
  48         [option no-header]
  49                 short_opt = h
  50                 summary = do not write an audio file header
  51                 [help]
  52                         Some audio formats store information about the audio file in
  53                         a format-specific header which is needed to decode any part of
  54                         the file. For such formats the afh receiver generates a suitable
  55                         header. This option changes the default behaviour, i.e. no header
  56                         is written.
  57                 [/help]
  58 [subcommand http]
  59         purpose = receive an audio stream over HTTP
  60         m4_include(host.m4)
  61         m4_include(port.m4)
  62 [subcommand dccp]
  63         purpose = receive an audio stream over DCCP
  64         m4_include(host.m4)
  65         m4_include(port.m4)
  66         [option ccid]
  67                 short_opt = c
  68                 summary = CCID preference(s) for this connection
  69                 typestr = id
  70                 arg_info = required_arg
  71                 arg_type = uint32
  72                 flag multiple
  73                 [help]
  74                         When present exactly once, this option mandates the CCID for the
  75                         sender-receiver connection. If it is passed more than once, it sets
  76                         a preference list where the order of appearance signifies descending
  77                         priority. For example, passing 4, 2, 3 creates the preference list
  78                         (CCID-4, CCID-2, CCID-3), assigning CCID-4 highest preference.
  79
  80                         The request is reconciled with the CCIDs on the server through the
  81                         'server-priority' mechanism of RFC 4340 6.3.1/10. The server CCIDs
  82                         can be listed by calling 'para_client si'.
  83                 [/help]
  84 [subcommand udp]
  85         purpose = receive an audio stream over UDP
  86         [option host]
  87                 short_opt = i
  88                 summary = IP address or hostname
  89                 typestr = host
  90                 arg_info = required_arg
  91                 arg_type = string
  92                 default_val = 224.0.1.38
  93                 [help]
  94                         The default address resolves to DANTZ.MCAST.NET and activates
  95                         multicast.
  96                 [/help]
  97         m4_include(port.m4)
  98         [option iface]
  99                 summary = receiving udp multicast interface
 100                 typestr = iface-name
 101                 arg_info = required_arg
 102                 arg_type = string