diff options
| author | Max Kellermann <max@musicpd.org> | 2017-09-07 14:21:40 +0200 |
|---|---|---|
| committer | Max Kellermann <max@musicpd.org> | 2017-09-07 14:21:40 +0200 |
| commit | ca7b4df812b8109911deb1e694fbea039f9818f5 (patch) | |
| tree | c031232fe792efe3edb823ebc415f2c2f9b87ea1 | |
| parent | bc8dd57236bdd76549a5453a5e15c9c95c5dcab5 (diff) | |
doc/user: document the Opus encoder
| -rw-r--r-- | doc/user.xml | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/doc/user.xml b/doc/user.xml index c5c7d341b..e010d5e3e 100644 --- a/doc/user.xml +++ b/doc/user.xml @@ -2991,6 +2991,60 @@ run</programlisting> </informaltable> </section> + <section id="opus_encoder"> + <title><varname>opus</varname></title> + + <para> + Encodes into <ulink + url="http://www.opus-codec.org/">Ogg Opus</ulink>. + </para> + + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>Setting</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <varname>bitrate</varname> + </entry> + <entry> + Sets the data rate in bit per second. The special + value "auto" lets <application>libopus</application> + choose a rate (which is the default), and "max" uses + the maximum possible data rate. + </entry> + </row> + + <row> + <entry> + <varname>complexity</varname> + </entry> + <entry> + Sets the <ulink + url="https://wiki.xiph.org/OpusFAQ#What_is_the_complexity_of_Opus.3F">Opus + complexity</ulink>. + </entry> + </row> + + <row> + <entry> + <varname>signal</varname> + </entry> + <entry> + Sets the Opus signal type. Valid values are "auto" + (the default), "voice" and "music". + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </section> + <section id="vorbis_encoder"> <title><varname>vorbis</varname></title> |