forked from ElvishArtisan/GlassCoder
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathglasscoder.xml.in
1701 lines (1639 loc) · 44.8 KB
/
glasscoder.xml.in
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="ISO-8859-1"?>
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
Header
-->
<refmeta>
<refentrytitle>glasscoder</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class='source'>February 2022</refmiscinfo>
<refmiscinfo class='manual'>Linux Audio Manual</refmiscinfo>
</refmeta>
<refnamediv>
<refname>glasscoder</refname>
<refpurpose>Minimalist audio encoder for live streaming</refpurpose>
</refnamediv>
<info>
<author>
<personname>
<firstname>Fred</firstname>
<surname>Gleason</surname>
<email>fredg@paravelsystems.com</email>
</personname>
<contrib>Application Author</contrib>
</author>
</info>
<!--
Body
-->
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
<command>glasscoder</command>
<arg choice='opt'><replaceable>OPTIONS</replaceable></arg>
<sbr/>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id='description'><title>Description</title>
<para>
<command>glasscoder</command><manvolnum>1</manvolnum> is an audio encoder
that is capable of generating live streams using a variety of formats and
sending them to an Icecast or Shoutcast audio streaming server or posting
them as HTTP Live Streams [HLS]. It is also capable of acting as an
Icecast-compatible server in its own right, serving streams directly to
client players and thus eliminating the need for an intervening Icecast
server instance.
</para>
<para>
<command>glasscoder</command><manvolnum>1</manvolnum> has no GUI or
configuration file components at all; its sole 'user interface' being its
command-line invocation. As such, it is particularly well suited for
being driven by an external process or controller such as
<command>glassgui</command><manvolnum>1</manvolnum> or
<command>glasscommander</command><manvolnum>1</manvolnum>.
</para>
</refsect1>
<refsect1 id='options'><title>Options</title>
<variablelist remap='TP'>
<varlistentry>
<term>
<option>--audio-atomic-frames</option>
</term>
<listitem>
<para>
Emit a stream consisting of self-contained frames --e.g. by
disabling the MPEG-1 bit reservoir. Useful mostly for debugging.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--audio-bitrate=</option><replaceable>kbps</replaceable>
</term>
<listitem>
<para>
The constant stream data rate in kilobits per second. Default value
is <userinput>128</userinput>. Use of this option is mutually
exclusive with that of the <option>--audio-quality</option> option
(see below).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--audio-channels=</option><replaceable>chans</replaceable>
</term>
<listitem>
<para>
The number of audio channels to use. Valid values are
<userinput>1</userinput> or <userinput>2</userinput>.
Default value is <userinput>2</userinput>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--audio-device=</option><replaceable>type</replaceable>
</term>
<listitem>
<para>
The type of audio device to use. The default value is
<userinput>JACK</userinput>. See the
<emphasis remap='B'>DEVICE OPTIONS</emphasis> section (below) for
the options appropriate for each audio device type. Valid values
are:
</para>
<blockquote remap='RS'>
<variablelist remap='TP'>
<varlistentry>
<term>
<userinput>ALSA</userinput>
</term>
<listitem>
<para>
The Advanced Linux Sound Architecture.
</para>
</listitem>
</varlistentry>
</variablelist>
</blockquote> <!-- remap='RE' -->
<blockquote remap='RS'>
<variablelist remap='TP'>
<varlistentry>
<term>
<userinput>ASIHPI</userinput>
</term>
<listitem>
<para>
AudioScience HPI.
</para>
</listitem>
</varlistentry>
</variablelist>
</blockquote> <!-- remap='RE' -->
<blockquote remap='RS'>
<variablelist remap='TP'>
<varlistentry>
<term>
<userinput>FILE</userinput>
</term>
<listitem>
<para>
Stream directly from a file.
</para>
</listitem>
</varlistentry>
</variablelist>
</blockquote> <!-- remap='RE' -->
<blockquote remap='RS'>
<variablelist remap='TP'>
<varlistentry>
<term>
<userinput>JACK</userinput>
</term>
<listitem>
<para>
The Jack Audio Connection Kit.
</para>
</listitem>
</varlistentry>
</variablelist>
</blockquote> <!-- remap='RE' -->
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--audio-format=</option><replaceable>fmt</replaceable>
</term>
<listitem>
<para>
The audio encoding format to use. The default value is
<userinput>VORBIS</userinput>. Valid <replaceable>fmt</replaceable>
values are:
</para>
<blockquote remap='RS'>
<variablelist remap='TP'>
<varlistentry>
<term>
<userinput>AACP</userinput>
</term>
<listitem>
<para>
MPEG-4 Advanced Audio Coding "Plus" (High Efficiency Profile)
</para>
</listitem>
</varlistentry>
</variablelist>
</blockquote> <!-- remap='RE' -->
<blockquote remap='RS'>
<variablelist remap='TP'>
<varlistentry>
<term>
<userinput>MP2</userinput>
</term>
<listitem>
<para>
MPEG-1/1.5 Layer 2
</para>
</listitem>
</varlistentry>
</variablelist>
</blockquote> <!-- remap='RE' -->
<blockquote remap='RS'>
<variablelist remap='TP'>
<varlistentry>
<term>
<userinput>MP3</userinput>
</term>
<listitem>
<para>
MPEG-1/1.5 Layer 3
</para>
</listitem>
</varlistentry>
</variablelist>
</blockquote> <!-- remap='RE' -->
<blockquote remap='RS'>
<variablelist remap='TP'>
<varlistentry>
<term>
<userinput>OPUS</userinput>
</term>
<listitem>
<para>
Ogg Opus (RFC-6716)
</para>
</listitem>
</varlistentry>
</variablelist>
</blockquote> <!-- remap='RE' -->
<blockquote remap='RS'>
<variablelist remap='TP'>
<varlistentry>
<term>
<userinput>PCM16</userinput>
</term>
<listitem>
<para>
PCM16 Uncompressed
</para>
</listitem>
</varlistentry>
</variablelist>
</blockquote> <!-- remap='RE' -->
<blockquote remap='RS'>
<variablelist remap='TP'>
<varlistentry>
<term>
<userinput>VORBIS</userinput>
</term>
<listitem>
<para>
Ogg Vorbis
</para>
</listitem>
</varlistentry>
</variablelist>
</blockquote> <!-- remap='RE' -->
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--audio-quality=</option><replaceable>qual</replaceable>
</term>
<listitem>
<para>
Use variable bitrate streaming at the given audio quality.
<replaceable>qual</replaceable> can be in the range
<userinput>0.0</userinput> (lowest quality) to
<userinput>1.0</userinput> (highest). Use of this option is mutually
exclusive with that of the <option>--audio-bitrate</option> option
(see above).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--audio-samplerate=</option><replaceable>rate</replaceable>
</term>
<listitem>
<para>
The audio sample rate to use for streaming. If the underlying
audio layer is operating at a different sample rate, the input will
be automatically resampled to this rate.
Default value is <userinput>44100</userinput>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--credentials-file=</option><replaceable>filename</replaceable>
</term>
<listitem>
<para>
Get the credentials for connecting to the server in the
<replaceable>filename</replaceable> file. The contents of the file
should be formatted as follows:
<literallayout>
[Credentials]
Username=<username>
Password=<password>
</literallayout>
</para>
<para>
When using the <option>--ssh-identity</option> option, the
passphrase for the specified identity file should be used as the
password value.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--delete-credentials</option>
</term>
<listitem>
<para>
Delete the file specified by <option>--credentials-file</option>
after being read.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--errors-string=</option><replaceable>string</replaceable>
</term>
<listitem>
<para>
Prepend <replaceable>string</replaceable> to messages sent to the
<command>syslog</command> service (see the
<option>--errors-to</option> option, below). Useful for
disambiguating messages from multiple
<command>glasscoder</command><manvolnum>1</manvolnum> instances.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--errors-to=</option><replaceable>dest</replaceable>
</term>
<listitem>
<para>
Send error messages to <replaceable>dest</replaceable> (default
standard error). Valid destinations are:
</para>
<blockquote remap='RS'>
<variablelist remap='TP'>
<varlistentry>
<term>
<userinput>STDERR</userinput>
</term>
<listitem>
<para>
Standard error.
</para>
</listitem>
</varlistentry>
</variablelist>
</blockquote>
<blockquote remap='RS'>
<variablelist remap='TP'>
<varlistentry>
<term>
<userinput>SYSLOG</userinput>
</term>
<listitem>
<para>
The system syslog service.
</para>
</listitem>
</varlistentry>
</variablelist>
</blockquote>
<blockquote remap='RS'>
<variablelist remap='TP'>
<varlistentry>
<term>
<userinput>STDOUT</userinput>
</term>
<listitem>
<para>
Standard output,in machine readable format (useful for
communication with another 'controller' program). See also the
<option>--meter-data</option> option below.
</para>
</listitem>
</varlistentry>
</variablelist>
</blockquote>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--help</option>
</term>
<listitem>
<para>
Print a short usage message and exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--list-codecs</option>
</term>
<listitem>
<para>
Print a list of available codecs and then exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--list-devices</option>
</term>
<listitem>
<para>
Print a list of available source devices and then exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--metadata-port=</option><replaceable>port</replaceable>
</term>
<listitem>
<para>
Accept metadata updates via HTTP at port
<replaceable>port</replaceable>. Default value is
<userinput>0</userinput>, which disables metadata updates.
See the METADATA section (below) for information regarding the
supported update formats.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--meter-data</option>
</term>
<listitem>
<para>
Output meter level updates on standard output. Useful for
driving an external metering display.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--server-auth=</option>[<replaceable>username</replaceable>][<option>:</option><replaceable>password</replaceable>] (DEPRECATED)
</term>
<listitem>
<para>
The authentication parameters to use. This parameter has no default.
</para>
<para>
NEVER USE THIS OPTION! It allows credentials to
be seen by other users on the system. Use the
<option>--credentials-file</option> option to specify server
credentials instead.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--server-exit-on-last</option>
</term>
<listitem>
<para>
Exit the program upon closure of the last player connection. This
setting is used only by the IceStreamer server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--server-max-connections=</option><replaceable>conns</replaceable>
</term>
<listitem>
<para>
Allow a maximum of <replaceable>conns</replaceable> simultaneous
player connections. Players beyond this maximum attempting to
connect will receive an immediate TCP disconnect before the HTTP
handshake. This setting is used only by the IceStreamer server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--server-no-deletes</option>
</term>
<listitem>
<para>
Do not clean up or delete content previously posted to the
publishing point. This setting is used only by the HLS
server type.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--server-pipe=</option><replaceable>pathname</replaceable>
</term>
<listitem>
<para>
Location to create a UNIX socket for piping connection
socket descriptors. Useful for implementing proxy connectors for the
IceStreamer server. For further details about this feature, see the
Proxy Connections section of the
<command>glasscoder-ipc</command><manvolnum>7</manvolnum> man page.
The default is to create no UNIX socket. This setting is used only
by the IceStreamer server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--server-script-down=</option><replaceable>cmd</replaceable>
</term>
<listitem>
<para>
Run the command <replaceable>cmd</replaceable> when the connection
enters the
<computeroutput>disconnected</computeroutput> state.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--server-script-up=</option><replaceable>cmd</replaceable>
</term>
<listitem>
<para>
Run the command <replaceable>cmd</replaceable> when the connection
enters the <computeroutput>connected</computeroutput> state.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--server-start-connections=</option><replaceable>conns</replaceable>
</term>
<listitem>
<para>
Do not start the audio transport until at least
<replaceable>conns</replaceable> connections have been established.
Used only by the IceStreamer server in conjunction with the
<userinput>FILE</userinput> audio device. Default value is
<userinput>0</userinput> --i.e. start the transport immediately.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--server-type=</option><replaceable>type</replaceable>
</term>
<listitem>
<para>
The type of streaming server to use (default is
<userinput>Icecast2</userinput>). Valid values for
<replaceable>type</replaceable> are:
</para>
<blockquote remap='RS'>
<variablelist remap='TP'>
<varlistentry>
<term>
<userinput>FILE</userinput>
</term>
<listitem>
<para>
Local file
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<userinput>FILEARCHIVE</userinput>
</term>
<listitem>
<para>
Local file archive. Stream to a set of files on the local
system, starting a new file at the beginning of each hour.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<userinput>HLS</userinput>
</term>
<listitem>
<para>
HLS/HTTP Live Streaming
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<userinput>IceCast2</userinput>
</term>
<listitem>
<para>
IceCast v2
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<userinput>IceOut</userinput>
</term>
<listitem>
<para>
Output an Icecast-compatible stream on standard output.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<userinput>IceStreamer</userinput>
</term>
<listitem>
<para>
Stream directly to players using the internal
Icecast-compatible server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<userinput>Shout1</userinput>
</term>
<listitem>
<para>
Shoutcast v1
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<userinput>Shout2</userinput>
</term>
<listitem>
<para>
Shoutcast v2
</para>
</listitem>
</varlistentry>
</variablelist>
</blockquote>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--server-url=</option><replaceable>url</replaceable>
</term>
<listitem>
<para>
The URL describing the server resource to stream to. See the
SUPPORTED URL SCHEMES section (below) for a list of what URL
schemes are appropriate for which server types.
</para>
<para>
When used with a <option>--server-type</option> of
<userinput>IceStreamer</userinput>, the host part of the URL
is used to specify the address of the network interface to
use for streaming (use <userinput>0.0.0.0</userinput> to indicate
ALL interfaces). This parameter has no default.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--server-user-agent=</option><replaceable>agent-string</replaceable>
</term>
<listitem>
<para>
The <computeroutput>User-Agent</computeroutput> header value to
use when connecting to external servers. Default value is
<userinput>GlassCoder/@VERSION@</userinput>. This setting
is used only by <userinput>IceCast2</userinput> and
<userinput>HLS</userinput> servers.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--ssh-identity=</option><replaceable>filename</replaceable>
</term>
<listitem>
<para>
The path to the file containing an ssh(1) identity to use when
connecting via SFTP. When using this option, the passphrase for
the identity file should be provided as the server password. See
the <option>--credentials-file</option> option for details.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--stream-aim=</option><replaceable>aim</replaceable>
</term>
<listitem>
<para>
The AOL Instant Messenger ID to associate with the stream. There is
no default value. This setting is used only by Shoutcast servers.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--stream-description=</option><replaceable>string</replaceable>
</term>
<listitem>
<para>
The string to show as the stream description. There is no default
value. This setting is used only by Icecast servers.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--stream-genre=</option><replaceable>string</replaceable>
</term>
<listitem>
<para>
The string to show as the stream genre. There is no default value.
This setting is used only by Icecast and Shoutcast servers.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--stream-icq=</option><replaceable>icq</replaceable>
</term>
<listitem>
<para>
The ICQ ID to associate with the stream. There is no default value.
This setting is used only by Shoutcast servers.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--stream-irc=</option><replaceable>irc</replaceable>
</term>
<listitem>
<para>
The Internet Relay Chat ID to associate with the stream. There is no
default value. This setting is used only by Shoutcast servers.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--stream-name=</option><replaceable>string</replaceable>
</term>
<listitem>
<para>
The string to show as the stream name. There is no default value.
This setting is used only by Icecast and Shoutcast servers.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--stream-timestamp-offset=</option><replaceable>offset</replaceable>
</term>
<listitem>
<para>
The offset to add to the value of stream timestamps, in seconds.
Default value is <userinput>0</userinput>. This setting is used
only for HLS streams.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--stream-url=</option><replaceable>url</replaceable>
</term>
<listitem>
<para>
The URL to show for a page giving more information about the stream.
There is no default value. This setting is used only by Icecast and
Shoutcast servers, but is ignored by Shoutcast v2 servers.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--verbose</option>
</term>
<listitem>
<para>
Increase verbosity level of information printed to standard error.
WARNING: this may cause cleartext passwords to printed!
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--version</option>
</term>
<listitem>
<para>
Output version information and exit.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id='device_options'><title>Device Options</title>
<variablelist remap='TP'>
<varlistentry>
<term>
<emphasis remap='B'>Advanced Linux Sound Architecture</emphasis>
(<option>--audio-device=</option><userinput>ALSA</userinput>)
</term>
<listitem>
<variablelist>
<varlistentry>
<term>
<option>--alsa-device=</option><replaceable>dev</replaceable>
</term>
<listitem>
<para>
The name of the ALSA device to use. If no
<option>--audio-device</option> option is given,
then the <userinput>hw:0</userinput> device will be used.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis remap='B'>AudioScience HPI</emphasis>
(<option>--audio-device=</option><userinput>=ASIHPI</userinput>)
</term>
<listitem>
<variablelist>
<varlistentry>
<term>
<option>--asihpi-adapter-index=</option><replaceable>index</replaceable>
</term>
<listitem>
<para>
The index number of the audio adapter to use.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--asihpi-input-index=</option><replaceable>index</replaceable>
</term>
<listitem>
<para>
The number of the input audio stream to use on the specified adapter.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--asihpi-input-gain=</option><replaceable>gain</replaceable>
</term>
<listitem>
<para>
The gain to apply to the input audio on the specified adapter in
dB. Valid values are <userinput>-100</userinput> to
<userinput>+20</userinput> inclusive. Default value is
<userinput>0</userinput>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--asihpi-channel_mode=</option><replaceable>mode</replaceable>
</term>
<listitem>
<para>
The channel mode for the input audio on the specified adapter.
The default value is <userinput>NORMAL</userinput>. Valid values
are:
</para>
<blockquote remap='RS'>
<variablelist remap='TP'>
<varlistentry>
<term>
<userinput>NORMAL</userinput>
</term>
<listitem>
<para>
Left signal goes to left channel, right signal goes to
right channel.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<userinput>SWAP</userinput>
</term>
<listitem>
<para>
Left signal goes to right channel, right signal goes to
left channel.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<userinput>LEFT</userinput>
</term>
<listitem>
<para>
Left signal goes to both left and right channels.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<userinput>RIGHT</userinput>
</term>
<listitem>
<para>
Right signal goes to both left and right channels.
</para>
</listitem>
</varlistentry>
</variablelist>
</blockquote> <!-- remap='RE' -->
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--asihpi-input-source=</option><replaceable>src-node</replaceable>
</term>
<listitem>
<para>
The input source to use on the specified adapter. See the
<emphasis remap='B'>HPI Source Nodes</emphasis> section below
for the list of valid <replaceable>src-node</replaceable>
values. The default value is <userinput>LINEIN</userinput>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--asihpi-input-type=</option><replaceable>src-node</replaceable>
</term>
<listitem>
<para>
The input type to use on the specified adapter. See the
<emphasis remap='B'>HPI Source Nodes</emphasis> section below
for the list of valid <replaceable>src-node</replaceable>