summaryrefslogtreecommitdiff
path: root/m4/lls/recv_cmd.suite.m4
blob: 2e588e42ea7e753ac68ee2f107cfee5454f53b01 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
[suite recv_cmd]
caption = receivers
[subcommand afh]
	purpose = make an audio stream from a local file
	[description]
		The afh (audio format handler) receiver extracts selected parts of
		the given audio file without decoding the file. Only complete chunks
		with respect to the underlying audio format are extracted.
	[/description]
	[option filename]
		short_opt = f
		summary = file to open
		typestr = filename
		arg_info = required_arg
		arg_type = string
	[option begin-chunk]
		short_opt = b
		summary = skip the beginning of the file
		typestr = chunk_num
		arg_info = required_arg
		arg_type = int32
		[help]
			The argument must be an integer between -num_chunks and num_chunks -
			1, inclusively, where num_chunks is the total number of chunks. If
			chunk_num is negative, the given number of chunks are counted backwards
			from the end of the file. For example --begin-chunk -100 instructs
			the afh receiver to start at chunk num_chunks - 100. This is useful
			for cutting off the beginning of an audio file.
		[/help]
	[option end-chunk]
		short_opt = e
		summary = only write up to chunk chunk_num
		typestr = chunk_num
		arg_info = required_arg
		arg_type = int32
		[help]
			For the chunk_num argument the same rules as for --begin-chunk
			apply. The default is to write up to the last chunk.
		[/help]
	[option just-in-time]
		short_opt = j
		summary = use timed writes
		[help]
			Write the specified data chunks 'just in time', i.e., delay the write
			until data is needed by the decoder/player for an uninterrupted audio
			stream. This may be useful for third-party software.
		[/help]
	[option no-header]
		short_opt = h
		summary = do not write an audio file header
		[help]
			Some audio formats store information about the audio file in
			a format-specific header which is needed to decode any part of
			the file. For such formats the afh receiver generates a suitable
			header. This option changes the default behaviour, i.e. no header
			is written.
		[/help]
[subcommand http]
	purpose = receive an audio stream over HTTP
	m4_include(host.m4)
	m4_include(port.m4)
[subcommand udp]
	purpose = receive an audio stream over UDP
	[option host]
		short_opt = i
		summary = IP address or hostname
		typestr = host
		arg_info = required_arg
		arg_type = string
		default_val = 224.0.1.38
		[help]
			The default address resolves to DANTZ.MCAST.NET and activates
			multicast.
		[/help]
	m4_include(port.m4)
	[option iface]
		summary = receiving udp multicast interface
		typestr = iface-name
		arg_info = required_arg
		arg_type = string