Skip to content

Commit a5e076e

Browse files
authored
Merge pull request #777 from tguilbert-google/opus_signal_application
Add OpusEncoderConfig.[signal/application]
2 parents 0ecf0ff + a1ea7d2 commit a5e076e

File tree

1 file changed

+70
-0
lines changed

1 file changed

+70
-0
lines changed

opus_codec_registration.src.html

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,8 @@
115115
<xmp>
116116
dictionary OpusEncoderConfig {
117117
OpusBitstreamFormat format = "opus";
118+
OpusSignal signal = "auto";
119+
OpusApplication application = "audio";
118120
[EnforceRange] unsigned long long frameDuration = 20000;
119121
[EnforceRange] unsigned long complexity;
120122
[EnforceRange] unsigned long packetlossperc = 0;
@@ -139,6 +141,14 @@
139141
Configures the format of output {{EncodedAudioChunk}}s. See
140142
{{OpusBitstreamFormat}}.
141143
</dd>
144+
<dt><dfn dict-member for=OpusEncoderConfig>signal</dfn></dt>
145+
<dd>
146+
Specificies the type of audio signal being encoded. See {{OpusSignal}}.
147+
</dd>
148+
<dt><dfn dict-member for=OpusEncoderConfig>application</dfn></dt>
149+
<dd>
150+
Specificies the encoder's intended application. See {{OpusApplication}}.
151+
</dd>
142152
<dt><dfn dict-member for=OpusEncoderConfig>frameDuration</dfn></dt>
143153
<dd>
144154
Configures the frame duration, in microseconds, of output {{EncodedAudioChunk}}s.
@@ -197,6 +207,66 @@
197207
</dd>
198208
</dl>
199209

210+
OpusSignal {#opus-signal}
211+
------------------------------------------
212+
<pre class='idl'>
213+
<xmp>
214+
enum OpusSignal {
215+
"auto",
216+
"music",
217+
"voice",
218+
};
219+
</xmp>
220+
</pre>
221+
222+
The {{OpusSignal}} indicates the default value for the type of signal being encoded.
223+
224+
<dl>
225+
<dt><dfn enum-value for=OpusSignal>auto</dfn></dt>
226+
<dd>
227+
The audio signal is not specified to be of a particular type.
228+
</dd>
229+
<dt><dfn enum-value for=OpusSignal>music</dfn></dt>
230+
<dd>
231+
The audio signal is music.
232+
</dd>
233+
<dt><dfn enum-value for=OpusSignal>voice</dfn></dt>
234+
<dd>
235+
The audio signal is voice or speech.
236+
</dd>
237+
</dl>
238+
239+
OpusApplication {#opus-application}
240+
------------------------------------------
241+
<pre class='idl'>
242+
<xmp>
243+
enum OpusApplication {
244+
"voip",
245+
"audio",
246+
"lowdelay",
247+
};
248+
</xmp>
249+
</pre>
250+
251+
The {{OpusApplication}} indicates the default value for the encoder's intended
252+
application.
253+
254+
<dl>
255+
<dt><dfn enum-value for=OpusApplication>voip</dfn></dt>
256+
<dd>
257+
Process signal for improved speech intelligibility.
258+
</dd>
259+
<dt><dfn enum-value for=OpusApplication>audio</dfn></dt>
260+
<dd>
261+
Favor faithfulness to the original input.
262+
</dd>
263+
<dt><dfn enum-value for=OpusApplication>lowdelay</dfn></dt>
264+
<dd>
265+
Configure the minimum possible coding delay by disabling certain modes of
266+
operation.
267+
</dd>
268+
</dl>
269+
200270
Privacy Considerations {#privacy-considerations}
201271
==========================================================================
202272

0 commit comments

Comments
 (0)